ProcessWire - Navigation Snippets: Unterschied zwischen den Versionen

Version vom 12. Mai 2021, 11:03 Uhr

TODO Seite aufräumen

Siehe auch

Processwire Module: MarkupSimpleNavigation automatisch Navigation aus Seitenbaum erstellen
Aligator (ProcessWire) - automatische Navigation, gut wenn manipuliert werden muss.
Menu Builder (ProcessWire) - Menüs im Backend erstellen (Wordpress like)

Navigation in Pagewire - Einführung

Navigationstypen allgemein

Es gibt verschiedene Typen von Navigationen. In Processwire hat man ein Pages Objekt, indem auch Zugriff auf Kind- und Elternseiten möglich sind. Es bildet also immer die Sitestruktur ab. Daher übergibt man an die unten aufgeführten Funktionen entweder die Homepage oder die aktuelle Seite.

Unter dem Aspekt auf welcher Seite man sich befindet kann man unterscheiden zwischen:

absolute Navigation normalerweise ausgehend von der Rootseite. diese ist dann auf allen Seiten gleich.
- z.B. alle Seiten des ersten Levels stehen in der Hauptnavigation egal auf welcher Seite ich im Moment bin
- z.B. verschachtelte Liste mit 2 oder mehr Leveln für Dropdown Navigationen wie Superfish, Megamenüs (mit zusätzlichen Infos...) oder Bootstrap Navigationen.
- Sitemap
Navigation relativ zur Seite Diese kann sich von Seite zu Seite unterscheiden.
- Alle Seiten der aktuellen Ebene (oft kombiniert mit Breadcrumb / Hier-bin-ich) )
- Hauptebene und aktueller Level
- Alle Ebenen bis zur aktuellen Seite + deren Unterseiten falls vorhanden.

In letzten Fall könnte man auch Varianten bauen in denen eine Verschachtelte Liste erzeugt wird aber nur bestimmte Teile absolut Positioniert angezeigt werden und andere versteckt werden. Manchmal möchte man bestimmte Level aber auch an anderer Position zeigen (z.B. Sidebar) In der Praxis hat man in der Regel

Mindestens eine Hauptnavigation mit allen Seiten der 1. Ebene oder eine Hauptnavigation mit mehreren Ebenen für Dropdown Navigationen, mobile Navigation oder auch Sitemapartige Navigationen für den Footer (oft mit kleinen Beschreibungen).
Eine Metanavigation mit Service Seiten wie Kontakt, Impressum etc. oft ist diese im Footer.

Unterschiede zwischen Verstecken, Veröffentlichen, Sperren

In Processwire sind diese Begriffe mit Userrechten verknüpft. Eine unveröffentlichte Seite kann also durchaus im Frontend aufgerufen werden (es sei denn man regelt das anders.) Vielmehr geht es darum das man User Rollen so gestalten kann, dass man z.B. einem User nur erlaubt unveröffentlichte Seiten zu editieren.

Denoch gibt es auch ein paar weitere Unterschiede.

Gesperrt -> Man kann die Seite nicht zum Editieren aufrufen. Über die Url kann Sie aufgerufen werden.

Unpublished -> Die Seite kann sobald sie gespeichert ist auch aufgerufen werden, WENN der User berechtigt ist. Nicht für Guest User (der normale Viewer)

TODO checken ob die Tabelle so für nicht angemeldete User stimmt.

	Im Menü ($pages->find)	Über URL erreichbar($pages->get)	Ausgabe im Frontend
Unpublished / Unveröffentlicht	Nein	Nur User mit passenden Rechten. Gäste -> leere Seite
Hidden / Versteckt	Nein	Ja	Ja - leere Seite (keine Feldausgabe)
Locked / Gesperrt	Ja	Ja	Ja
Trash	Nein	Nein

Seiten auf unveröffentlicht stellen

https://processwire.com/talk/topic/29-how-to-unpublish-a-page-without-deleting-it/

Was soll man tun wenn man eine Seite tatsächlich nicht mehr anzeigen will, sie aber noch nicht wegwerfen will? Ryan schlägt folgendes vor:

Mülleimer
Remove Guest Role in Template

Basics

Basic Navigation

<?php
  // get the homepage object
  $homePage = $pages->get("/");
  // get PageArray of homepage object and child page objects
  $navItems = $homePage->and($homePage->children);
?>
Now you have a PageArray with the required items, you can iterate over them one at a time, and print the title of the page and the link to the page itself and wrap the whole thing in your list tag.

<ul class="nav">

<?php
  // get the homepage object
  $homePage = $pages->get("/");
  // get PageArray of homepage object and child page objects
  $navItems = $homePage->and($homePage->children);
  // or if you don't want the home link
  // $navItems = $homePage->children;
  // iterate over the $navItems PageArray
  foreach ($navItems as $navItem):
?>

  <li class="nav-item">
    <a class="nav-link" href="<?php echo $navItem->url; ?>"><?php echo $navItem->title; ?></a>
  </li>

  <?php endforeach; ?>

</ul>

Basic mit active Class

<ul class="nav">

<?php
  // get the homepage object
  $homePage = $pages->get("/");
  // get PageArray of homepage object and child page objects
  $navItems = $homePage->and($homePage->children);
  // or if you don't want the home link
  // $navItems = $homePage->children;
  // iterate over the $navItems PageArray
  foreach ($navItems as $navItem):

// if the id of the page currently being
// iterated equals the id of the current page
$activeClass = ($navItem->id == $page->id) ? " active" : "";
?>

  <li class="nav-item">
    <a class="nav-link<?php echo $activeClass; ?>" href="<?php echo $navItem->url; ?>"><?php echo $navItem->title; ?></a>
  </li>

  <?php endforeach; ?>

</ul>

Child Menu

<ul class="sub-menu">

<?php
  // get children of the parent of the current page
  $childPages = $page->parent->children;

  // iterate over the $navItems PageArray
  foreach ($childPages as $childPage):

  // if the id of the page currently being
  // iterated equals the id of the current page
  $activeClass = ($navItem->id == $page->id) ? " active" : "";
?>

  <li class="nav-item">
    <a class="nav-link<?php echo $activeClass; ?>" href="<?php echo $childPage->url; ?>"><?php echo $childPage->title; ?></a>
  </li>

  <?php endforeach; ?>

</ul>

Page Level

In which level in page tree we are?

$level = count($page->parents);

Link to Subpage und Platzhalter (Spacer)

Kann man gut für Superfish Menüs etc. benutzen. Bildet das Verhalten von Shortcuts und Spacern aus TYPO3 nach.

Anpassung der renderNavTree() Funktion von Ryan Cramer. Options Field Installieren und als globales Feld "navigation_type" mit den Optionen

1=normal|Normal
2=doNotLink|Do not link
3=linkToFirstChild|Link to first childpage

konfigurieren. Dann Funktion etwa so anpassen:

...
// cycle through all the items
	foreach($items as $item) {

		// markup for the list item...
		// if current item is the same as the page being viewed, add a "current" class to it
		$out .= $item->id == wire('page')->id ? "<li class='current'>" : "<li>";

		// markup for the link
		$navigation_type = $item->navigation_type->id;
		switch ( $navigation_type ) {
			case 2: // do not link
				$out .= "<span class='spacer'>$item->title</span>";
				break;
			case 3: // link to subpage
				if( $item->hasChildren() ){
					$out .= '<a href="'.$item->child->url.'">'.$item->title.'</a>';
				}else{
					$out .= "<span class='spacer'>$item->title</span>";
				}
				break;
			default:
				$out .= "<a href='$item->url'>$item->title</a>";
				break;
		}
...

Redirect (301)

Redirect zu erster Unterseite

https://processwire.com/talk/topic/15-how-do-i-create-a-page-that-redirects-to-its-first-child/

Field redirects_to_first_child erstellen und im Template einfügen.

<?php 
  if($page->numChildren && $page->redirects_to_first_child) 
  $session->redirect($page->child()->url); 
?>

Erzeugt 301 Weiterleitung

Anderer Ansatz wäre evtl. den Link bei der Menügenerierung direkt zu generieren. finde ich persönlich besser siehe Link to subpage und Platzhalter Beispiel. Allerdings sollte man dann vielleicht die Seite trotzdem per 301 Weiterleiten, falls die URL mal direkt aufgerufen wird oder bei Google gelistet ist.

Redirect zu anderer Seite in der Navigation

https://processwire.com/talk/topic/762-howto-menu-item-that-links-to-another-page/

1. Create a new field and call it 'redirect_url' or something like that, and use the 'URL' fieldtype.

2. Add that field to your template where you'd want to use it, or create a new template just for the purpose, like a template named 'redirect'.

3. Edit the page that you want to be a symlink and populate the 'redirect_url' field with the URL you want it to redirect to.

4. In your nav-generation code that links to the pages, do something like this:

<?php
$url = $subpage->get("redirect_url|url"); // use redirect_url if there, otherwise use url
echo "<a href='$url'>{$subpage->title}</a>";

5. You might also want to add this to your template that has the 'redirect_url' field: just in case there's anything linking to it directly. That way it'll send people to the right place either way:

<?php
if($page->redirect_url) $session->redirect($page->redirect_url);

Breadcrumb

	<!-- breadcrumbs -->
	<div class='breadcrumbs'><?php 
		// breadcrumbs are the current page's parents
		foreach($page->parents() as $item) {
			echo "<span><a href='$item->url'>$item->title</a></span> "; 
		}
		// optionally output the current page as the last item
		echo "<span>$page->title</span> "; 
	?></div>

One Level Navigation Bar

ProcessWire - One Level Navigation

Nächste Seite / Next Page Navigation

Beispiel 1

if($page->next->id){
  $next = '
    <div class="next">
      <i>Next:</i>&nbsp;
      <a class="ajax-link" name="'.$page->next->title.'" href="'. $page->next->url .'">
        '. $page->next->title .'<span class="fa fa-arrow-right"><span>
      </a>
    </div>';
}

Beispiel 2 (mit zurück zur Elternseite)

$next = '';
if($page->next->id){
  $next = '
  <a href="'.$page->next->url.'">
    <i class="fa fa-angle-right"></i>
  </a>
';
}

$prev = '';
if($page->prev->id){
  $prev = '
  <a href="'.$page->prev->url.'" class="w-inline-block paginaton-but">
    <i class="fa fa-angle-left"></i>
  </a>';
}

$pagination = '
<div class="container pagination">
  <div class="row">
    
    <div class="col col-md-4">
      <div class="align-center">
        '.$prev.'
      </div>
    </div>

    <div class="col col-md-4">
      <div class="align-center">
        <a href="'.$page->parent->url.'">
          <i class="fa fa-th"></i>
        </a>
      </div>
    </div>

    <div class="col col-md-4">
      <div class="align-right center">
        '.$next.'
      </div>
    </div>
  </div>

</div>
';

echo $pagination;

Zurück zur Elternseite

<div class="back"><a href="'.$page->parent()->url.'">zurück</a></div>

Kindseiten mit $page->children

<?=$page->children?>

Output

5723,4958,5937

Beispiel

<ul>
<?php
foreach($page->children as $child)
  echo "<li><a href='{$child->url}'>{$child->title}</a></li>";
?> 
</ul>

Ergebnis:

<ul> 
<li><a href='/about/contact/'>Contact Us</a></li>
<li><a href='/about/press/'>Press Releases</a></li>
<li><a href='/about/staff/'>Our Staff</a></li> 
</ul>

Children Tree

function listChildrenTree($children, $current, $w) {

echo "<ul>";

foreach($children as $page) {

	$class = '';
	if($page === $current || $current->parents->slice(1)->has($page) ) {
		$class = "class='on' style='font-weight:bold'";
	}

	$rootid = $w->pages->get("/")->id;

	echo "<li><a href='{$page->url}' $class>";
	if($page->id == $rootid) echo "<img src='" . $w->config->urls->templates . "styles/images/home.png' width='24' height='28' alt='' />";
	echo "{$page->title}</a> ";

	if($page->numChildren && $page->id != $rootid) listChildrenTree($page->children, $current, $w);

	echo "</li>";
}
echo "</ul>";
}

$children = $pages->get("/")->children();
$children->prepend($pages->get("/"));

listChildrenTree($children, $page, $wire);

Bootstrap Navigation

<?php namespace ProcessWire;
// Markup to use wicht navigation_type field (normal=1, no-link=2,subpage=3)
?>

<?php

// bundle up the first level pages and prepend the root home page
$homepage = $pages->get(1);
$pa = $homepage->children;
$pa = $pa->prepend($homepage);

// Set the ball rolling...
$myMenu = renderChildrenOf($pa);
$wrapper = '
<nav class="navbar navbar-default">
  <div class="container-fluid">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse-1" aria-expanded="false">
        <span class="sr-only">Menü</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
    </div>
    <div class="collapse navbar-collapse" id="navbar-collapse-1">
      |
    </div>
  </div>
</div>';
$myMenu = wrap($myMenu,$wrapper);
echo $myMenu;

/*
Navigation for ProcessWire using the Bootstrap 2.2.2 markup
This menu was written by Soma based on work by NetCarver and a bit thrown in by Joss
Bootstrap 3 update by Damienov, with multi level dropdown support fix
*/
function renderChildrenOf($pa, $output = '', $level = 0)
{
    $output = '';
    $level++;

    foreach ($pa as $child) {
        $atoggle = '';
        $class = '';

        if ($child->numChildren && count($child->parents) == 1) {
            $class .= 'dropdown';
            $atoggle .= ' class="dropdown-toggle" data-toggle="dropdown"';
        } else if ($child->numChildren && count($child->parents) > 1 ) {
            $class .= 'dropdown-submenu';
            $atoggle .= ' class="dropdown-toggle"';
        } else if ($child->numChildren && $child->id != 1) {
            $class .= 'dropdown-menu';
        }

        // Makes the current page and it's top level parent add an active class
        $class .= ($child === wire("page") || $child === wire("page")->rootParent) ? " active" : '';
        $class = strlen($class) ? " class='" . trim($class) . "'" : '';

        if ($child->numChildren && count($child->parents) == 1) {
            // Add Caret if have children
            $output .= "<li$class><a href='$child->url'$atoggle>$child->title <b class='caret'></b></a>";
        } else if ($child->numChildren && count($child->parents) > 1) {
            $output .= "<li$class><a tabindex='-1' href='$child->url'$atoggle>$child->title</a>";
        } else {
            $output .= "<li$class><a href='$child->url'$atoggle>$child->title</a>";
        }

        // If this child is itself a parent and not the root page, then render it's children in their own menu too...
        if ($child->numChildren && $child->id != 1) {
            $output .= renderChildrenOf($child->children, $output, $level);
        }
        $output .= '</li>';
    }
    $outerclass = ($level == 1) ? "nav navbar-nav" : 'dropdown-menu';
    return "<ul class='$outerclass'>$output</ul>";
}

?>

Modul: MarkupSimpleNavigation

Processwire Modul - MarkupSimpleNavigation

Weitere Menübeispiele

Flexible Funktion zum erzeugen von Tree oder Listen Navigationen

ul-Liste oder nur li
Rendertiefe einstellbar
Page Objekt von dem Kinder gerendert werden oder PageArray
Filter (Selector) für Kindobjekte.
Root voranstellen oder auch nicht (z.B. für Homepage)

/**
 * Rendert eine Navi. Kindseiten wenn eine Page übergeben wird. 
 * Alle Seiten inkl. Kinder wenn ein PageArray übergeben wird.
 * 
 */
function nav($items,$options = array()){
	static $depth = 0;
	$defaults = array(
		'ul' => true, // wrap in <ul> or not
		'class' => '', // class for ul
		'depth' => 1, // render depth
		'selector' => '', // filters child elements
		'prependRoot' => false // if you provide a Page (i.e. home), prepend as menu item
	);
	$options = array_merge($defaults, $options);
	$page = $items->wire('page'); // current page
	$class = $depth ? "nav-sub" : rtrim("nav $options[class]");
	$attr = rtrim("class='$class'");
	$out = $options['ul'] ? "<ul $attr>" : "";
	// if given a Page use children as the items and use Page as the header
	// if given a page array use each Page as the items
	if($items instanceof Page) {
		//$header = $items;
		if($options['prependRoot']) $out .= "<li class='root'> <a href='$items->url'>$items->title</a></li>";
		$items = $items->children($options['selector']);
	}
	if(!$items->count) return '';

	foreach($items as $n => $item) {
		$isParent = $options['depth'] && $item->hasChildren && $depth < $options['depth'];
		$classes = array();

		// determine additional classes
		if($item->id == $page->id) $classes[] = 'active';
		if($isParent) $classes[] = 'parent';

		// open the list item
		$out .= count($classes) ? "<li class='" . implode(' ', $classes) . "'>" : "<li>";
		$out .= "<a href='$item->url'>$item->title</a>";
		// see if we are working with a nested list and go recursive if so
		if($isParent) {
			$depth++;
			$children = $item->children($options['selector']);
			$out .= nav($children, array(
				'depth' => $options['depth'],
				'selector' => $options['selector']
			));
			$depth--;
		}

		// close the list item
		$out .= "</li>";
	}
	if($options['ul']) $out .= "</ul>";
	return $out;
}

Standard Tree Navigation

Für viele Zwecke ausreichend und leicht anpassbar, die klassische verschachtelte Liste.

Menüauswahl Hauptmenü / Metamenü / Footer-Navigation

Beispiel 1 Backend Feld menus anlegen Options:

1=Main Menu
2=Meta Menu

topnav.inc

$pa = $homepage->and($homepage->children("menus.id=1"));//only if main menu is checked
$options = array('level' => '1', 'ulClass' => 'sf-menu', 'liClass' => '');
echo "<div>".renderNavTreeType($pa, $maxDepth = 1, $fieldNames = '', $options)."</div>";

Beispiel 2 (älter)

Checkbox anlegen (footer_nav), und dann das Seitenarray etwa so modifizieren.

$footer_nav = $pages->find("parent=1, footer_checkbox=1");
$main_nav = $pages->find("parent=1, footer_checkbox!=1");

Zweispaltige Navigation aus Kindseiten

Verbesserungsvorschlag: Anstatt if lieber zwei for Schleifen -> bessere Performance

// Childrens
$n = count($page->children);
$m = ceil($n/2);
$c = 0;

// NAVIGATION & SLIDER Items
$listItem = '';
$navList = '';
$col1 = '<ul class="nav-list col1">';
$col2 = '<ul class="nav-list col2">';
foreach ($page->children as $item) {
	if($item->id == $page->rootParent->id) {
		$listItem = '<li class="current">';
	} else {
		$listItem = '<li>';
	}
	$listItem .= '<a class="ajax-link" href="'.$item->url.'">'.$item->title.'</a></li>';
	($c < $m) ? $col1 .= $listItem : $col2 .= $listItem;
	$c++;
}
$col1 .= '</ul>';
$col1 .= '</ul>';
$navList = $col1.$col2;

Mehrspaltige Navigationen lassen sich auch mit der slice Funktion erstellen:

$categories = $pages->get('/about/sites/categories/')->children();
foreach($categories->slices(3) as $items) {
  echo "<div class='uk-width-1-3'><ul>";
  echo $items->each("<li><a href='{url}'>{title}</a>");
  echo "</ul></div>";
}

Pushy Menu

/**
 * Given a group of pages, render a <ul> navigation tree
 *
 * This is here to demonstrate an example of a more intermediate level
 * shared function and usage is completely optional. This is very similar to
 * the renderNav() function above except that it can output more than one
 * level of navigation (recursively) and can include other fields in the output.
 * Assumes there is a field navigation_type to decide how a list item is
 * rendered
 *
 * @param array|PageArray $items
 * @param int $maxDepth How many levels of navigation below current should it go?
 * @param string $fieldNames Any extra field names to display (separate multiple fields with a space)
 * @param array $options extra options for classes configuration etc.
 * @return string
 *
 */
function renderPushyMenu($items, $maxDepth = 0, $fieldNames = '', $options = array('level' => 0, 'ulClass' => '', 'liClass' => '', 'aClass' => '') ) {

	// if we were given a single Page rather than a group of them, we'll pretend they
	// gave us a group of them (a group/array of 1)
	if($items instanceof Page) $items = array($items);
	$out = '';
  $c = 0;
  $liClasses = array();
  $ulClasses = array();
	$level = 0;
	$liClass = '';
	$ulClass = '';

	if(!empty($options['level'])) $level = $options['level'];
	if(!empty($options['ulClass'])) {
		$ulClasses[] = $options['ulClass'];
		$ulClass = $options['ulClass'];
	}

	if(!empty($options['liClass'])) {
		$liClasses[] = $options['liClass'];
		$liClass = $options['liClass'];
	}

	// cycle through all the items
	foreach($items as $item) {
    //$level = count($page->parents);
		// LI ITEM
		$classes = $liClasses;
    //if($item->id == wire('page')->id) $classes[] = 'cur';
		if($item->hasChildren) {
      // BUTTON instead of Link
      $out .= '<li class="pushy-submenu"><button>'.$item->title.'</button>';
		}else{
      $classes[] = 'level-'.$level;
  		$out .= '<li class="'.implode($classes,' ').'">';
      unset($classes);

  		// A ITEM
  		$navigation_type = $item->navigation_type->id;
  		$classes = $liClasses;
  		switch ( $navigation_type ) {
  			case 2: // do not link
  				$out .= '<span class="spacer">'.$item->title.'</span>';
  				break;
  			case 3: // link to subpage
  				if( $item->hasChildren() ){
  					$out .= '<a href="'.$item->child->url.'" class="ajax-link">'.$item->title.'</a>';
  				}else{
  					$out .= "<span class='spacer'>$item->title</span>";
  				}
  				break;
  			default:
  				$out .= '<a href="'.$item->url.'" class="ajax-link">'.$item->title.'</a>';
  				break;
  		}
  		unset($classes);
		}
		// if there are extra field names specified, render markup for each one in a <div>
		// having a class name the same as the field name
		if($fieldNames) foreach(explode(' ', $fieldNames) as $fieldName) {
			$value = $item->get($fieldName);
			if($value) $out .= " <div class='$fieldName'>$value</div>";
		}

		// if the item has children and we're allowed to output tree navigation (maxDepth)
		// then call this same function again for the item's children
		if($item->hasChildren() && $maxDepth) {
			//if($class == 'nav') $class = 'nav nav-tree';
			$nextLevelOptions = array('level' => $level+1, 'ulClass' => '', 'liClass' => $liClass);
			$out .= renderNavTreeType($item->children, $maxDepth-1, $fieldNames, $nextLevelOptions);
		}

		// close the list item
		$out .= "</li>\n";
	}

	// if output was generated above, wrap it in a <ul>

	if($out) $out = "\n".'<ul class="'.implode($ulClasses,' ').'">'."\n".$out.'</ul>'."\n";

	// return the markup we generated above
	return $out;
}

Do not link / link to subpage

MarkupSimpleNavigation XTemplate + Redirect Beispiel

https://github.com/s...default-options

Menü Platzhalter

"xtemplate" => "folder|placeholder", // specify one or more templates
"xitem_tpl" => "<span>{title}</span>", // default markup for page with this template
"xitem_current_tpl" => "<span>{title}</span>"
echo $nav->render(array(
   'max_levels'=>2,
   'selector'=>"limit=10",
   'xtemplates' => 'placeholder|folder'
));

Redirect Template

You could also have a template "redirect" with only a title and a page field (single page) to select any page you want to go.

Then in the code you should be able to write

array('item_tpl' => '<a href="{redirect_page|url}">{title}</a>')

So it would take the url of the referenced page in the page field if found, or if not it takes the url of the page itself. Assuming the page field is named "redirect_page".

In der Navi

Zusätzliches Feld (Options) im Backend mit Namen navigation_type