Jump to content
Soma

MarkupSimpleNavigation

Recommended Posts

Pete, i think you want to use the markup cache in PW to do simple caching to your needs.

Share this post


Link to post
Share on other sites

Soma - thanks for building this module, it's the first time I have come across this in the forums and should save a fair bit of time when rapid prototyping. Good documentation too.

Share this post


Link to post
Share on other sites

Pete, i think you want to use the markup cache in PW to do simple caching to your needs.

Yeah, my original thought was to somehow make this a checkbox config option in your module to keep things really simple, but it would only be a few minutes' work to cache it in the template anyway :) Of course, if you wanted to cache it properly, say for a day or more you'd want it to rebuild the menu and re-cache it whenever a page is saved to be on the safe side, so whilst my original idea seemed simple it's actually a bit more complicated than that ;)

Share this post


Link to post
Share on other sites

Hi, thanks for this module, everything work as i wanted except that

$treeMenu = $modules->get("MarkupSimpleNavigation"); // load the module

echo $treeMenu->render();

dosnt get all the pages. It shows all pages except the root page. Am im missing something or did i misunderstand something?

Simon

Share this post


Link to post
Share on other sites

Hi gottberg!

To include the root page you would pass the option "show_root" like:

echo $treeMenu->render(array( "show_root"  => true ));

Share this post


Link to post
Share on other sites

Hi gottberg!

To include the root page you would pass the option "show_root" like:

echo $treeMenu->render(array( "show_root"  => true ));

Thank you! Worked like a charm! :)

Share this post


Link to post
Share on other sites

I just commited an update, with improvements to simplify module code.

Originally fixing an issue with "has_children" behaviour. Which now works also with custom selector (that would ommit pages by template) and max_levels as expected. It will now only append if there really is children to be shown.

Also fixed and updated some documentation.

Thanks

  • Like 1

Share this post


Link to post
Share on other sites

Hi Soma,

Thanks for this plugin. I'm just putting it through the paces, and I noticed something related to the "has_children" behavior your mentioned above.

If you specify something like:

'selector' => 'parent!=1011'

The "has_parent" class isn't appended on the first level, but deeper than that it shows back up.

For example, there's no "has_parent" appended for 1011 for:

/
/about-us/
etc...

But it does get appended for something like:

/about-us/meet-the-staff/
etc...

Maybe I'm doing something wrong and need to set something differently in the options array, but from what I can tell this doesn't seem like the behavior you intended.

:)

Share this post


Link to post
Share on other sites

renobird, can you give me more to chew? Code you use for the navigation, and the output? Feel free to send me pm if you don't want to post here.

I think you mean "has_children" because there's no "has_parent" :)

Share this post


Link to post
Share on other sites

Hi Soma,

Sorry, meant "has_children". :)

<?php $treeMenu = $modules->get("MarkupSimpleNavigation");
$options = array(
  'parent_class' => 'parent', // string (default 'parent') overwrite class name for current parent levels
  'current_class' => 'current', // string (default 'current') overwrite current class
  'has_children_class' => 'parent', // string (default 'has_children') overwrite class name for entries with children
  'levels' => false, // bool (default false) wether to output "level-1, level-2, ..." as css class in links
  'levels_prefix' => 'level-', // bool (default 'level-') prefix string that will be used for level class
  'max_levels' => 3, // int (default null) set the max level rendered
  'firstlast' => true, // bool (default false) puts last,first class to link items
  'collapsed' => false, // bool (default false) if you want to auto-collapse the tree you set this to true
  'show_root' => true, // bool (default false) set this to true if you want to rootPage to get prepended to the menu
  'selector' => 'parent!=1011', // string (default '') define custom PW selector, you may sanitize values from user input
  'outer_tpl' => '<ul id="nav" class="clearfix">||</ul>', // template string for the outer most wrapper. || will contain entries
  'inner_tpl' => '<ul>||</ul>', // template string for inner wrappers. || will contain entries
  'list_tpl' => '<li%s>||</li>', // template string for the items. || will contain entries, %s will replaced with class="..." string
  'item_tpl' => '<a href="{url}">{title}</a>', // template string for the inner items. Use {anyfield} and {url}, i.e. {headline|title}, if field is of type image it will return url to image (first image if multiple)
  'item_current_tpl' => '<a href="{url}">{title}</a>' // template string for the current active inner items.
)
?>

Called like so:

<?=$treeMenu->render($options);?>

Let's say I have this nav structure (simplified):

home

portfolio
--project 1
--project 2
--project 3
--project 4
--project 5
etc...

about-us
--meet the staff
--history

services
--stuff we do
--more stuff we do

contact us

The "portfolio" page is the one I want to omit children from because it could have a lot of children, and the drop down menu gets too long.

'selector' => 'parent!=1011' corresponds to that page.

What happens now is that if I visit:

/portfolio/

There is no "has_children" appended.

But if I visit:

/portfolio/project-1

the "has_children" class shows up again.

Share this post


Link to post
Share on other sites

Bah! I spotted it as soon as I posted this code.

My "parent_class" and "has_children_class" are set to the same thing. That's what is causing it to act like it's showing up again.

My apologies for the wild goose chase.

*Bad Renobird, Bad...*

Share this post


Link to post
Share on other sites

Hah! That happens regularely including myself. :D

The behavior (if set right) I think is correct. ( After all it's surely possible I missed something while testing )

So if you ommit pages by saying "parent!=1002", the page 1002 will have no "has_children" as there's no children to be rendered in the menu.

It will only append the "has_children" class to items that really have children show up in the navigation at some point, cutting of at the max_levels or if excluded by a selector. Only side effect of it I noticed recently is if you have two navigation (top, sidebar) and set the top to max_levels 1, and render the rest of the navigation on a separate call in the sidebar. The top level won't have "has_children" class appended. But I don't know if that would make sense, needed or even possible with this apporoach. :)

Share this post


Link to post
Share on other sites

Thanks Soma,

Again, apologies for the false alarm.

I do have another (hopefully legitimate) question. Is there a way to optionally suppress the href attribute on top level parent items?

Meaning, if the "has_children" class is set then the href for that top level item would be set to href="#"

A lot of times I find that the parent items are just containers for the children. So if you link to them, there really isn't a need to have anything there.

There's a great Textpattern plugin (adi_menu) that has this functionality, and I've just realized how much I use it.

Share this post


Link to post
Share on other sites

I would take this route...

Make the "container" pages you're saying having a template "redirect", with only a single page field "redirect_page" with pagelistSelectMultiple input

Then have the template file code:

$session->redirect($page->redirect_page->url);

or how about "redirect-to-firstchild".

$session->redirect($page->children->first()->url);

Edit:

Another option would be to use javascript to set urls of first level to "#".

  • Like 1

Share this post


Link to post
Share on other sites

I've used JS to suppress those links in the past.

I've just always wondered how it effects search engine results, since the url still actually gets displayed, so the page will get crawled.

If it's set to '#", then it's basically invisible. :)

I'll explore the redirect route, I think that would solve any issue with "dead" URL's floating around.

Thanks.

Share this post


Link to post
Share on other sites

Would there be an easy way to use MarkupSimpleNavigation and maybe something like in_array()(?) to check if an ID (that will come from a GET so we must test it) was the same as one of the pages that the navigation would normally display?

I assume one initial step would be working out if I can configure the options for MarkupSimpleNavigation so it only returns the IDs of pages (no markup) and it returns all pages one would want the public to see, the same list one would have in a sitemap.xml.

I'll take a longer look at the options the very good documentation has to see how I might do this.

Update:

Progress, this


$options = array(
//      'parent_class' => '',
//      'current_class' => '',
//      'has_children_class' => '',
       'outer_tpl' => '',
       'inner_tpl' => '',
       'list_tpl' => '',
       'item_tpl' => '{id}',
       'item_current_tpl' => '',
//        'item_current' => '{title}'
);
echo $nav->render($options);

returns only the IDs (with whitespace, dunno if that matters as regards interpreting the o/p with something like in_array(). I'll see...

Edited by alan

Share this post


Link to post
Share on other sites

Glad you figured it out somehow. Yes I also thought something like this it could work getting only the ids. But this module is usually used for markup generation.

I still don't understand completely what you're trying to do though, you could try this:

$options = array(
	'outer_tpl' => '',
	'inner_tpl' => '',
	'list_tpl' => '{id} ',
	'item_tpl' => '',
	'item_current_tpl' => ''
);
$array_ids = explode(" ",trim($nav->render($options));

Share this post


Link to post
Share on other sites
I still don't understand completely what you're trying to do though

:D Soma, you are in good company if you don't understand what I am doing — I am sure a lot of people feel the same; I don't understand me sometimes ;)

Joking aside, I am trying to check if an ID is for a page that is normally publicly visible or not. I plan to show a short-version permanent link to each page so if someone wants to tweet about (or email easily) a page, they can refer to:

example.com/p/1987

rather than having to refer to

example.com/animals/houses/the-squirrel-house/cheeky-the-red-squirrel-eating-some-cheese

My code uses a GET to check if a visitor has typed

example.com/p/1987

and I want the code to then check that 1987 is a valid page I want to allow sending them too, if not I will 404 or just show a message etc.

Edit: I tried your code like this:

$options = array(
			'outer_tpl' => '',
			'inner_tpl' => '',
			'list_tpl' => '{id} ',
			'item_tpl' => '',
			'item_current_tpl' => ''
);
$array_ids = explode(" ",trim($nav->render($options)));
echo $nav->render($options);

but it looks like list_tpl' => '{id} ' results in {id} {id} {id} {id} {id} {id} {id} etc being output rather than the actual ID numbers — but thank you for the clues I will keep working on it and if I solve this, repost here.

Edit 2: I typo'd, your code works (of course ;)) — thanks again for the help!

If I finish this functionality off I'd like to see if I can make it into a Module(!), but I don't want to get too excited yet, it's not even working ;)

Edited by alan

Share this post


Link to post
Share on other sites

Ah so you're trying to have an id permalink to pages (shortcut). I'm not sure if this woud help but this is how I would solve it.

Normally you would setup your tree to have pages that will be in the navigation, and set pages not in navigation to hidden. From there it would just be a simple check to see if the page (id) requested is not hidden.

if(!$pages->get($id)->isHidden()) $session->redirect($pages->get($id)->url);
else $session->redirect($pages->get($config->http404PageID)->url);

Or you could add a field (checkbox) "not_permalink", and give that to templates you need. You could use it for single pages, or just the parent of a branch. So all children pages will either be shown or not.

if(!$pages->get($id)->parents->has("not_permalink=1") || $pages->get($id)->not_permalink == 0)  $session->redirect($pages->get($id)->url);
else $session->redirect($pages->get($config->http404PageID)->url);

It depend a lot how you setup you page tree and how you make them appear in your navigation, but I'm sure you'll find a very simple solution. I think it can be as simple as a 2 line code and no module would be required.

Share this post


Link to post
Share on other sites

WoW! Thanks Soma, I thought it should be easy with the power of PWs API but my limited and the fun of trying other ways meant I was OK to try other routes such as re-purposing your cool module. Thanks again, I will try out your code here and see what I get!

Share this post


Link to post
Share on other sites

OK, thanks to that code [soma, thank you] without (yet) resorting to using the "not-permalink" option (which may be the way I have to go) the only pages I seem to have problems with are ones where when I try some IDs at random (to see if I can 'break' the system) result in a URL like this and a login prompt:

http://example.com.site/pw/repeaters/for-field-107/for-page-1188/

I'm now looking to see if there is an API way to detect if an ID is 'as a result of a repeater' or 'normal' (if that even makes sense).

Share this post


Link to post
Share on other sites

Since repeaters (pages) are in the admin section hidden. You could exlude them by id of the admin page.

$p = $pages->get($id);

if($p->isHidden() || $p->rootParent->id == 2)  $session->redirect($pages->get($config->http404PageID)->url) 
   else $session->redirect($p->url);;

I think if you want to exlude other branches you could try something like this.

$p = $pages->get($id);
if($p->isHidden() || $p->is("has_parent=2|10|1033")) $session->redirect($pages->get($config->http404PageID)->url);
   else $session->redirect($p->url);

NOt really tested but let me know if it doesn't work out.

Share this post


Link to post
Share on other sites

:D Soma, you are in good company if you don't understand what I am doing — I am sure a lot of people feel the same; I don't understand me sometimes ;)

Joking aside, I am trying to check if an ID is for a page that is normally publicly visible or not. I plan to show a short-version permanent link to each page so if someone wants to tweet about (or email easily) a page, they can refer to:

example.com/p/1987

rather than having to refer to

example.com/animals/houses/the-squirrel-house/cheeky-the-red-squirrel-eating-some-cheese

Allen; judging from a couple of recent threads i scanned your quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

Allen; judging from a couple of recent threads i scanned you're quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

Share this post


Link to post
Share on other sites
Allen; judging from a couple of recent threads i scanned your quite hung up on providing some short/perm link functions. Ofcourse, everyone has their own requirements for certain projects but i don't see the real benefit. Twitter auto-shortens links or use bit.ly or such services. In mail, where there's no 140 lmit i would rather have descriptive url than some id based url.

@SiNNuT you're right, I certainly am trying to solve this, but I'm not hung up on it ;) just interested in finding the answer. And I agree with you about Twitter and that perhaps this is less important now:

Now Twitter self-shortens links <- insert debate if that's good here -> what I am trying to do is perhaps less important, but I like the idea of being able to refer to a page with an alternate, ultra-short, permanent URL.

But often I will still stick to using plain-text (not HTML) email and sometimes I want a short way to refer to a URL in an email. Although this may be an edge case it's enough to make me want to explore if I can do this easily with PW.

Added to that, solving a challenge like this is not only valuable for the resulting functionality, but also it makes me learn, and as I need all the learning I can get (being a bit weak at PHP and API/jQuery style constructions) I kept trying to solve this one.

I just hope one or more of the posts in the thread end up helping someone else, either directly or in some way I had not envisaged.

And thanks for your comments about bit.ly etc, I ended up choosing the Google shortener extension in Chrome a while back after that outage from one of the shortening services. And yes, wherever appropriate I think using full URLs is the best way to go. Cheers!

Share this post


Link to post
Share on other sites

@Soma

...NOt really tested but let me know if it doesn't work out.

Thanks Soma! I will certainly post back to let you know and thanks again for the pointers :D

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 d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      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 If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      Please have a look at the screenshots to get an idea what I'm talking about (open spoiler):
      (Please note: these screenshots are from an early development state of SnipWire. To see actual screens please have a look at later posts below!)
       
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...