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

may i ask for a screencast or at least screenshots? i think it's the best way to show what a module does :)

http://www.screencast-o-matic.com/ is free for up to 15min videos and you do not even have to install anything

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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...