Jump to content

Module: FieldtypeAssistedURL


wumbo

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
Link to comment
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!

Link to comment
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.

Link to comment
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!
Link to comment
Share on other sites

  • 7 months later...
  • 1 month later...

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

Link to comment
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?)

Link to comment
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

Link to comment
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...

Link to comment
Share on other sites

  • 5 months later...
  • 3 weeks later...
  • 4 weeks later...

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.

Link to comment
Share on other sites

  • 3 months later...
  • 2 weeks later...

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.

Link to comment
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.

Link to comment
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.

Link to comment
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>

 

Link to comment
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      FieldtypeQRCode
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      A simple fieldtype generating a QR Code from the public URL of the page, and more.
      Using the PHP library QR Code Generator by Kazuhiko Arase.

      Options
      In the field’s Details tab you can change between .gif or .svg formats. If you select .svg you will have the option to directly output the markup instead of a base64 image. SVG is the default.
      You can also change what is used to generate the QR code and even have several sources. The accepted sources (separated by a comma) are: httpUrl, editUrl, or the name of any text/URL/file/image field.
      If LanguageSupport is installed the compatible sources (httpUrl, text field, ...) will return as many QR codes as there are languages. Note however that when outputting on the front-end, only the languages visible to the user will be generated.
      Formatting
      Unformatted value
      When using $page->getUnformatted("qrcode_field") it returns an array with the following structure:
      [ [ "label" => string, // label used in the admin "qr" => string, // the qrcode image "source" => string, // the source, as defined in the configuration "text" => string // and the text used to generate the qrcode ], ... ] Formatted value
      The formatted value is an <img>/<svg> (or several right next to each other). There is no other markup.
      Should you need the same markup as in the admin you could use:
      $field = $fields->get("qrcode_field"); $field->type->markupValue($page, $field, $page->getUnformatted("qrcode_field")); But it’s a bit cumbersome, plus you need to import the FieldtypeQRCode's css/js. Best is to make your own markup using the unformatted value.
      Static QR code generator
      You can call FieldtypeQRCode::generateQRCode to generate any QR code you want. Its arguments are:
      string $text bool $svg Generate the QR code as svg instead of gif ? (default=true) bool $markup If svg, output its markup instead of a base64 ? (default=false) Hooks
      Please have a look at the source code for more details about the hookable functions.
      Examples
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $page = $event->arguments("page"); $event->return = $page->title; // or could be: $event->return = "Your custom text"; }) $wire->addHookAfter("FieldtypeQRCode::generateQRCodes", function($event) { $qrcodes = $event->return; // keep everything except the QR codes generated from editUrl foreach($qrcodes as $key => &$qrcode) { if($qrcode["source"] === "editUrl") { unset($qrcodes[$key]); } } unset($qrcode); $event->return = $qrcodes; })
    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
×
×
  • Create New...