Jump to content
wumbo

Module: FieldtypeAssistedURL

Recommended Posts

Hi folks!

I'm about to add my new module FieldtypeAssistedURL to the repository.

You find the source code on github and hopefully in the modules repository soon.

Here an extract from the README.md:

This module offers you a new field type AssistedURL Field, providing and input field for storing absolute and relative URLs.
The field type adds a button to open the URL chooser dialog known from the CKEditor link feature without the tab
navigation bar for specifying link attributes.

Using the URL chooser dialog the editor may select URLs from internal pages or uploaded files via a search field with
auto-completion, a page tree control, and a file selector control.

Please feel free to post suggestions and any form of feedback here in the forums or on github.

Wumbo

  • Like 20

Share this post


Link to post
Share on other sites

Hi @wumbo - thanks for this - looks pretty handy, but a few thoughts for you.

  1. If you manually enter a URL it automatically adds the http://, forcing it to be an absolute URL, but if you choose a page, it populates a relative URL - this will be problematic when outputting this field's contents in something like an emailable template.
  2. When selecting a page from the site, I would rather the field stores the ID of the page, just in case the path (and therefore the URL) is changed down the road. The module could handle outputting the URL of that page automatically, so if an absolute URL is stored, then echo that, otherwise echo the URL of the page, maybe with an option to force an absolute URL just in case you are using this field in something like an email template. I think this would be a very useful addition.
  3. Just visual stuff, but I'd like to see the "Open Link Assistant" a little LOT smaller - perhaps a small icon or something. Also, the width of the text input is not quite right.

Thanks again!

Share this post


Link to post
Share on other sites

Hi Adrian,

1. This seems to be the default behavior of the FieldtypeURL, which this module extends, or the InputfieldURL, which is used be the module. I'm not sure it's necessary/wise to change that.

2. The whole purpose for developing this module was to mimic the exact behavior of the link chooser dialog of the CKEditor module. This dialog wraps the marked rte content with completely rendered <a> tags. All I do is getting the href attribute from this <a> tag and copy it to the InputfieldURL. 

I'll try to introduce a config setting to choose whether to return a page's url or it's id.

3. I replaced the buttons text with the link icon.

Share this post


Link to post
Share on other sites

Hi Adrian,

1. This seems to be the default behavior of the FieldtypeURL, which this module extends, or the InputfieldURL, which is used be the module. I'm not sure it's necessary/wise to change that.

2. The whole purpose for developing this module was to mimic the exact behavior of the link chooser dialog of the CKEditor module. This dialog wraps the marked rte content with completely rendered <a> tags. All I do is getting the href attribute from this <a> tag and copy it to the InputfieldURL. 

I'll try to introduce a config setting to choose whether to return a page's url or it's id.

3. I replaced the buttons text with the link icon.

  1. Good point - I hadn't noticed this before as I guess I have never entered a relative URL in a FieldtypeURL field before.
  2. I guess the difference for me is that in an RTE field you always need to insert a URL, but in the case of a field that is just storing a link to a page, it might be better to store the page ID - I think if you do go this route, you want to store the ID, but always return the page object so in the template you could choose ->url, ->id, ->title, etc
  3. I think that looks much cleaner!

Share this post


Link to post
Share on other sites

Thanks for this Wumbo, I've been keen for a combined internal/external URL chooser for a while now, will check this one out.

Share this post


Link to post
Share on other sites

OMG this one is what I have been looking for.

But I have one challange. I do use repeaters quite a lot in my templates. And images in those repeaters are not listed? Are you aware of this? Maybe even working on a fix?

I will dig into it in the following days, but if you are already on it let me know ;-)

Felix

Share this post


Link to post
Share on other sites

Okay... I got a first fix (but it does not help yet)

in ProcessPageEditLink.module you need to replace the existing getFiles() method with the following code. It iterates thru all RepeaterFields as well. This results in all images being shown:

protected function getFiles() {
	$files = array();
	if($this->page->id) {
		$files = $this->getFilesFromPage($this->page);
	}
	asort($files); 
	return $files;
}
	
protected function getFilesFromPage($pageToCheck){
	$files = array();
	foreach($pageToCheck->fields as $field) {
		if($field->type instanceof FieldtypeFile){
			foreach($pageToCheck->get($field->name) as $file) {
				$files[$file->url] = $field->getLabel() . ': ' . $file->basename; 
			}
		}
		else if($field->type instanceof FieldtypeRepeater){
			foreach($pageToCheck->$field as $repeaterPage){
				$files = array_merge($this->getFilesFromPage($repeaterPage),$files);
			}
		}
		else {
			
		}
	}
	return $files;
}

Just to make sure we have it all in here. This was the original code of getFiles()

protected function getFilesOrig() {
	$files = array();
	if($this->page->id) foreach($this->page->fields as $f) {
		if(!$f->type instanceof FieldtypeFile) continue;
		foreach($this->page->get($f->name) as $file) {
			$files[$file->url] = $f->getLabel() . ': ' . $file->basename; 
		}
	}
	asort($files); 
	return $files;
}

So this works now. Only problem is, that InputfieldAssistedURL.module uses not the main page ID as the link.

So when the InputField is placed inside a repeater, it sends the ID of the repeater and not the one of the page (repeaters behave like pages). So we need to break out to main page from this repeater as well to see all images of the page...

I will follow up on this.

(Side question: Any hint were I should post my getFiles() patch so it might end up in the main core?)

Share this post


Link to post
Share on other sites
So when the InputField is placed inside a repeater, it sends the ID of the repeater and not the one of the page (repeaters behave like pages). So we need to break out to main page from this repeater as well to see all images of the page...

I think you are looking for getForPage(): https://github.com/ryancramerdesign/ProcessWire/blob/7e8c7c6836282b6b64de81263f5aaa8112fd51ae/wire/modules/Fieldtype/FieldtypeRepeater/RepeaterPage.php#L46

Share this post


Link to post
Share on other sites

Okay, off to learn git ,-)

But thank you for the quick answer.

 Wow, that one was quick. Yes this was what I was looking for...

Share this post


Link to post
Share on other sites

If I could make any request, it would be to make it optional to hide the file select option altogether, as personally find processwire's own method of linking to files to be really strange - useless if you don't have a separate field for uploading to that page.

What I have done instead is have an Options field, where the user chooses file or link, and make this field or a file upload field visible, depending on that selection.

Anyway regardless of that, this module is really great, thanks for providing it. So much better than a single text field when you want to avoid your users putting in broken links.

Share this post


Link to post
Share on other sites

Hey,

thanks for that module. 

Maybe I missed something, but how to get the propoerties, like target, title, or rel in a page template?
Are these values stored anywhere?

Thanks for help.

Share this post


Link to post
Share on other sites

Hello everybody,

I am new to PW and while I am playing around to learn PW I downloaded this module and it works great but I have no clue how to get the name of the page I will link to:

<a href="<?php echo $page->AssistedURL; ?>">?</a>

Thank you very much for your help.

Share this post


Link to post
Share on other sites

Hello gmclelland,

thank you for your reply and the TracyDebugger tip.

I think my approach is probably going in the wrong direction... I just wanted to have an input field to insert a link to another page or an anchor or select a page via the menu tree. That's why I decided to use this module.

This

<a href="<?php echo $page->AssistedURL; ?>"></a>

outputs this:

<a href="/processwire-test/page1/"></a>

which is fine so far but I'd like to have the page name (or a custom text) within the <a></a> tags. Is there a better way to achieve that? Most probably :-)

Thank you again.

Share this post


Link to post
Share on other sites

@sms - if it's a local page, then you can get the title of the linked page with:

$pages->get($page->AssistedURL)->title;

But you might be better using a Page Reference field because then you could do:

$page->linkedpage->url;
$page->linkedpage->title;

If there will be some external links, then maybe a Repeater field with URL and Title fields might be the best option.

Share this post


Link to post
Share on other sites

Hello adrian,

thank you again for your quick reply.

I have tested your code but the field outputs nothing now. However, I will test the Page Reference field tomorrow. Might be a better option :-)

<a href="<?php echo $page->AssistedURL; ?>"><?php echo $pages->get($page->AssistedURL)->title; ?></a>

 

Share this post


Link to post
Share on other sites

@sms - I don't know why that code isn't working for you - it's fine here. Is this live somewhere we can look at?

That said, I do think a Page Reference field is more appropriate for your use case.

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By gebeer
      I am happy to present my new fieldtype FieldtypeImageFromPage. It is made up of 2 modules:
      Fieldtype Image Reference From Another Page is a Fieldtype that stores a reference to a single image from another page. The image can be selected with the associated Inputfield.
      Inputfield Select Image From Page is an Inputfield to select a single image from images on a predefined page and it's children.
      And there also is a helper module that takes care of cleanup tasks.
      This module evolved out of a discussion about my other Module FieldtypeImagePicker.  It caters for use cases where a set of images is being reused multiple times across a site. With this fieldtype these images can be administered through a chosen page. All images uploaded to that page will be available in the inputfield.
      When to use ?
      Let editors choose an image from a set of images that is being used site-wide. Ideal for images that are being re-used across the site.
      Suited for images that are used on multiple pages throughout the site (e.g. icons).
      Other than the native ProcessWire images field, the images here are not stored per page. Only references to images on another page are stored. This has several advantages:
      one central place to organize images when images change, you only have to update them in one place. All references will be updated, too. (Provided the name of the image that has changed stays the same) Features
      Images can be manipulated like native ProcessWire images (resizing, cropping etc.) Image names are fully searchable through the API Accidental image deletion is prevented. When you want to delete an image from one of the pages that hold your site-wide images, the module searches all pages that use that image. If any page contains a reference to the image you are trying to delete, deletion will be prevented. You will get an error message to help you edit those pages and remove references there before you can finally delete the image. How to install and setup
      Download and install this module like any other modules in ProcessWire Create a page in the page tree that will hold your images. This page's template must have an images field Upload some images to the page you created in step 2 Create a new field. As type choose 'Image Reference From Another Page'. Save the field. In 'Details' Tab of the field choose the page you created in step 2 Click Save button Choose the images field name for the field that holds your images (on page template from step 2) Click Save button again Choose whether you want to include child pages of page from step 2 to supply images Add the field to any template You are now ready to use the field View of the inputfield on the page edit screen:

      View of the field settings

      The module can be installed from this github repo. Some more info in the README there, too.
      In my tests it was fairly stable. After receiving your valued feedback, I will eventually add it to the modules directory.
      My ideas for further improvement:
      - add ajax loading of thumbnails
      Happy to hear your feedback!
       
    • By gebeer
      Although the PW backend is really intuitive, ever so often my clients need some assistance. Be it they are not so tech savvy or they are not working in the backend often.
      For those cases it is nice to make some help videos available to editors. This is what this module does.
      ProcessHelpVideos Module
      A Process module to display help videos for the ProcessWire CMS. It can be used to make help videos (screencasts) available to content editors.
      This module adds a 'Help Videos" section to the ProcessWire backend. The help videos are accessible through an automatically created page in the Admin page tree. You can add your help videos as pages in the page tree. The module adds a hidden page to the page tree that acts as parent page for the help video pages. All necessary fields and templates will be installed automatically. If there are already a CKEditor field and/or a file field for mp4 files installed in the system, the module will use those. Otherwise it will create the necessary fields. Also the necessary templates for the parent help videos page and it's children are created on module install. The module installs a permission process-helpvideos. Every user role that should have access to the help video section, needs this permission. I use the help video approach on quite a few production sites. It is stable so far and well received by site owners/editors. Up until now I installed required fields, templates and pages manually and then added the module. Now I added all this logic to the install method of the module and it should be ready to share.
      The module and further description on how to use it is available on github: https://github.com/gebeer/ProcessHelpVideos
      If you like to give it a try, I am happy to receive your comments/suggestions here.
    • By Robin S
      A module created in response to the topic here:
      Page List Select Multiple Quickly
      Modifies PageListSelectMultiple to allow you to select multiple pages without the tree closing every time you select a page.
      The screencast says it all:

       
      https://github.com/Toutouwai/PageListSelectMultipleQuickly
      https://modules.processwire.com/modules/page-list-select-multiple-quickly/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImagePicker. It provides a configurable input field for choosing any type of image from a predefined folder.
      The need for it came up because a client had a custom SVG icon set and I wanted the editors to be able to choose an icon in the page editor.
      It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.
      There are no image manipulation methods like with the native PW image field.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImagePicker
      Kudos to @Martijn Geerts. I used his module FieldTypeSelectFile as a base to build upon.
      Here's how the input field looks like in the page editor:

      Hope it can be of use to someone.
      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Eventually this will go in the module directory soon, too.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://github.com/BernhardBaumrock/RockPDF
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
×
×
  • Create New...