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

Here are some screenshots.

The field:

m46af8ex.png

The dialog:

jenywpjs.png

  • Like 4

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

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      Checkbox Reversed
      Modifies InputfieldCheckbox so that it shows the reverse of its true value. The checkbox will be unchecked when the field value is 1 and checked when the field value is not 1.
      Background
      The core FieldtypeCheckbox does not have a setting that allows a checkbox to be checked by default. One reason for this is that only a checked field saves a value to the database. An unchecked field does not save "0" to the database, but rather does not save any value for the field at all. Therefore there is no way to distinguish between a new field that has not yet been saved (and therefore could potentially get a default checked state) and a field that has deliberately been saved as unchecked.
      Because of this you sometimes have to use a checkbox in the opposite way than you would like. Suppose your client has requested a checkbox labelled "Bootylicious" that will be checked by default. This isn't possible with FieldtypeCheckbox so instead you have to convince them that a checkbox labelled "Not bootylicious" that is unchecked by default is just as good. This alternative will achieve the same thing, but it's not ideal.
      A solution
      This module doesn't change the limitations of the core checkbox field, but it provides a workaround that allows you to show the checkbox with the desired default state and label. So in the example above you would still name the field "not_bootylicious" (otherwise it could get confusing in your template files) but you can label the field "Bootylicious" and the checkbox will appear checked when its true value is actually unchecked, and vice versa. This allows new pages to show the checkbox checked by default. Clear as mud?
      Usage
      Install the Checkbox Reversed module.
      For any Checkbox field where you want the inputfield to show the reverse of its true value, activate the "Reverse the checked state of this inputfield?" option in the field settings.

       
      https://github.com/Toutouwai/CheckboxReversed
      http://modules.processwire.com/modules/checkbox-reversed/
    • By louisstephens
      I have been following @bernhard's great tutorial on creating a Dashboard and everything has very easy to understand so far. However, I need to add a select field that a template is using (so users can create a new page from the dashboard), but I am really at a complete lost on how to achieve this. I have been googling, but can't really find anything on the matter.
      $field = $this->modules->get('InputfieldSelect'); $field->name = "Select Manufacturer"; $field->findPagesSelector = "template=basic-page"; //not needed for select field $field->labelFieldName = "title"; $field->name = "Manufacturer Select"; $field->columnWidth = 34; $fieldset->add($field); I have the above code, which was originally an InputfieldPage, but since this is an options field, I have changed it. Has anyone actually gotten a select from a template (and its' values) in a module?
    • By Lex Sanchez
      Video or Social Post Embed
      Based on the TextformatterVideoEmbed module developed by Ryan Cramer, we have added the possibility to embed publications of the main social networks Facebook, Twitter and Instagram.
      ProcessWire Textformatter module that enables translation of YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu URLs to full embed codes, resulting in a viewable video or social post in textarea fields you apply it to.
      How to install
      Download or Clone from Github: https://github.com/lexsanchez/VideoOrSocialPostEmbed
      Copy the VideoOrSocialPostEmbed.module file to your /site/modules/ directory (or place it in /site/modules/VideoOrSocialPostEmbed/).
      Click check for new modules in ProcessWire Admin Modules screen. Click install for the module labeled: "Video or Social Post Embed".
      Now you will be on the module config screen. Please make note of the config options and set as you see fit.
      How to use
      Edit your body field in Setup > Fields (or whatever field(s) you will be placing videos in). On the details tab, find the Text Formatters field and select "Video or Social Post Embed". Save.
      Edit a page using the field you edited and paste in YouTube, Vimeo, Facebook, Twitter, Instagram and/or Issuu URLs each on their own paragraph.
      Example
      How it might look in your editor (like TinyMCE):
      How it works
      This module uses YouTube, Vimeo, Instagram, Facebook, Twitter and Issuu oEmbed services to generate the embed codes populated in your content. After these services are queried the first time, the embed code is cached so that it doesn't need to be pulled again.
      Configuration
      You may want to update the max width and max height settings on the module's configuration screen. You should make these consistent with what is supported by your site design.
      If you change these max width / max height settings you may also want to check the box to clear cache, so that YouTube/Vimeo/Facebook/Twitter/Instagram/Issuu oembed services will generate new embed codes for you.
      Using with Markdown, Textile or other LML
      This text formatter is looking for a YouTube, Vimeo, Instagram, Facebook, Twitter or Issuu video URL surrounded by paragraph tags. As a result, if you are using Markdown or Textile (or something else like it) you want that text formatter to run before this one. That ensures that the expected paragraph tags will be present when VideoOrSocialPostEmbed runs. You can control the order that text formatters are run in by drag/drop sorting in the field editor.
      Copyright 2018 by Ryan Cramer / Updated by Lex Sanchez
    • By kixe
      Email Verification
      This module provides functions to validate email adresses and hosts. The module generates a textfile for blacklisted mailhosts (trashmail), which will be always up to date.
      Download
      https://modules.processwire.com/modules/email-verification/
      API
      // get module $mailcheck = $modules->get('EmailVerification'); // return bool/ string - automatted update of blacklist file $mailcheck->blacklisted(email|domain) // return bool - validate a top level domain, checks against IANA list $mailcheck->validTLD(tld) // return array of punycoded TLDs - cyclic updated, data pulled from IANA $mailcheck->getTLDs(cycle=2592000) // return bool - checks syntax converts to punycode $mailcheck->validDomainName(domain); // return bool - checks punycode encoded syntax $mailcheck->validHostName(host); // return bool - checks syntax and accessibility $mailcheck->validHost(email|domain) // add a single value to blacklist $mailcheck->addToBlacklist(email|domain) USAGE
      $mailcheck = $modules->get('EmailCheck'); $email = 'susi@trashmail.com'; if($mailcheck->blacklisted($email)) echo 'Email Provider not allowed'; if(!$mailcheck->validHost($email)) echo 'Mailhost not available'; Example blacklist file:  blacklist.txt