gibbs/phile-sub-navigation

Generates a philecms nested hierarchy

PhileCMS Sub Navigation

A PhileCMS plugin that generates a hierarchy tree that can be used to make nested navigation menus., _(*1)

1. Installation

Install via composer, _(*2)

composer require "gibbs/phile-sub-navigation:1.*"

Install via git, _(*3)

Clone this repository from the phile directory into plugins/gibbs/phileSubNavigation. E.g:, _(*4)

git clone git@github.com:Gibbs/phileSubNavigation.git plugins/gibbs/phileSubNavigation

Manual Install, _(*5)

Download and extract the contents into: plugins/gibbs/phileSubNavigation, _(*6)

2. Plugin Activation

Activate the plugin in your config.php file:, _(*7)

$config['plugins']['gibbs\\phileSubNavigation'] = array('active' => true);

3. Parameters

This plugin returns a variable named navigation. Each item in the site hierarchy has the following parameters:, _(*8)

• active - True when the item is the current page
• level - How deep the current page is nested.
• meta - The associated pages meta information
• path - The current path e.g. blog/post
• parent - The pages parent
• uri - An alias of path
• url - The full URL to the page

4. Example Usage

To be flexible NO HTML is generated by this plugin - that is the responsibility of the template engine you are using., _(*9)

More examples are available on the wiki, _(*10)

Children of a particular path, for example /blog/ can be used by referencing the children key., _(*11)

Twig - List /blog/ children, _(*12)

{% for item in navigation.blog.children %}
• {{ item.meta.title }}
{% endfor %}

Twig - List /blog/archive/ children, _(*13)

{% for item in navigation.blog.children.archive.children %} {% if item.active %}
• {% else %}
• {% endif %} {{ item.meta.title }}
{% endfor %}

Twig - Entire site hierarchy example, _(*14)

{% macro sub_navigation(navigation) %}
    {% import _self as macros %}
    {% for item in navigation %}
        <li>
            <a href="{{ item.uri }}">{{ item.meta.title }}</a>
            {% if item.children %}
                <ul>
                    {{ macros.sub_navigation(item.children) }}
                </ul>
            {% endif %}
        </li>
    {% endfor %}
{% endmacro %}

{% import _self as macros %}

{{ macros.sub_navigation(navigation) }}

To debug the plugin output set 'print' => true inside the plugins config.php file., _(*15)

4. Caching

Caching is disabled by default and depends on phile\\simpleFileDataPersistence (enabled by default)., _(*16)

To enable caching edit the plugins config.php file and set cache to true., _(*17)

NOTE: Caching will cause some parameters such as active to stop working., _(*18)