Ariadne

• Programmers Ref…»
• Ariadne General…»
• HTML»
• Menu»

ar\html\menu

This module provides a simple way to generate accessible menu's. You can create a menu object with the ar('html')->menu() or ar('html/menu')->el() method and then use the methods described below.

Example 1 - a simple menu bar:

<pinp>
  echo ar('html')->menu()->bar();
</pinp>

Will ouput:

<ul>
  <li>
    <a href="http://.../">foo</a>
  </li>
  <li>
    <a href="http://.../">bar</a>
  </li>
  <li>
    <a href="http://.../">xyzzy</a>
  </li>
</ul>

The menu class extends the ar_htmlElement class, so you can use any of the dom methods as well.

methods

bar

Ariadne > 2.7.5

(object) ar('html/menu')->bar( $options = array() )

This method returns a query object (ar_storeFind) which will find all the direct children of the top object. The top can be specified by setting $options['top'] to the correct path.

crumbs

Ariadne > 2.7.5

(object) ar('html/menu')->crumbs( $options = array() )

This method returns a query object (ar_storeParents) which will find all theparents of the current object up to and including the top object. The top can be specified by setting $options['top'] to the correct path. The current object can be specified by setting $options['current'] to the correct path.

el

Ariadne > 2.7.5

(object) ar('html/menu')->el( $tagName = 'ul', ... )
(object) ar('html/menu')->element( $tagName = 'ul', ... )

This method returns a new ar_html_menuElement object. This class extends the ar_htmlElement class, so you can access its content using the html/xml dom methods. This method works exactly like the ar\html::el() method. To fill the menu with menu items, use the ar\html\menuElement::fill() method.

sitemap

Ariadne > 2.7.5

(object) ar('html/menu')->sitemap( $options = array() )

This method returns a query object (ar_storeFind) whichwill find all the children of the top object.  You can set the following options:

tree

Ariadne > 2.7.5

(object) ar('html/menu')->tree( $options = array() )

This method returns a query object (ar_storeFind) which will find all parents, siblings and children of the current menu item. The top can be specified by setting $options['top'] to the correct path. The current object can be specified by setting $options['current'] to the correct path. 

In addition you can set the following options:

ar\html\menuElement methods 

(In Ariadne upto 2.7.5 this is the ar/html/menu class, but works exactly the same.)

autoID

(object) $htmlMenu->autoID( $root = 'menu', $element = null )

This method adds automatically generated id's to each list item in the menu, starting with the given parent element. It returns the menu object.

Example 2 - a tree menu with automatic id's

<pinp>
  echo ar('html')->menu()->tree()->autoID();
</pinp>

Will ouput:

<ul id="menu-ul">
  <li id="menu-0">
    <a href="http://.../">Foo</a>
    <ul id="menu-0-ul">
      <li id="menu-0-0">
        <a href="http://.../">Bar</a>
      </li>
      <li id="menu-0-1">
        <a href="http://.../">xyzzy</a>
      </li>
      ...
    </ul>
  </li>
  ...
</ul>

bar

(object) $htmlMenu->bar( $options = array() )

This method fills the menu object with all the direct children of the top object. The top can be specified through either the root() method or by setting $options['top'] to the correct path. It returns the menu object.

childIndicators

(object) $htmlMenu->childIndicators()

This method adds the class 'menuHasChildren' to all list items that contain a submenu. It returns the menu object.

crumbs

(object) $htmlMenu->crumbs( $options = array() )

This method fills the menu object with all theparents of the current object up to and including the top object. The top can be specified through either the root() method or by setting $options['top'] to the correct path. The current object can be specified through either the current() method or by setting $options['current'] to the correct path. It returns the menu object.

current

(object) $htmlMenu->current( $path )

This method sets the current menu item. It returns the menu object.

fill

(object) $htmlMenu->fill( $list, $options = array() )

Ariadne > 2.7.5

(object) $htmlMenu->fill( $list, ... )

This method fills the menu object with the items in $list if it is an array, or the result from the query if it is an ariadne query. If $list is an array, it must have one of the following formats:

Simple format with ariadne objects:

$list = array(
  '/'     => 'Root',
  '/a/'   => 'Item A',
  '/a/b/' => 'Item B',
  '/c/'   => 'Item C'
);

The parent - child relations are automatically deduced from the keys (path) of the array.

Extended format with ariadne objects:

$list = array(
  '/'     => array(
    'name'  => 'Root',
    'url'   => 'http://www.ariadne-cms.org/',
    'title' => 'Ariadne CMS',
    'id'    => 'arRoot',
    'class' => 'rootClass',
    'attributes' => array(
      'style' => 'width: 200px;'
    )
  ),
  ...
);

title, id and class are set on the menu items hyperlink (<a>), the contents of the attributes array are set on the menu items list item (<li>).

Predefined parent child relations:

$list = array(
  array(
    'name' => 'Root',
    'url'  => 'http://www.ariadne-cms.org/',
    'children' => array(
       array(
         'name' => 'Item A',
         'path' => 'a/',
         'children' => array(
            array(
              'name' => 'Item B',
              'path' => 'b/'
            )
         )
       ),
       ...
     )
  )
);

In the last example the urls for each item will be build based on the parents url. So Item B will have the url 'http://www.ariadne-cms.org/a/b/'. You can do more interesting stuff with the path option:

Finally, you can also pass an ariadne query object to fill the menu:

<pinp>
  echo ar('html')->menu()->fill( ar::find( "object.implements='pdir'" ) );
</pinp>

In Ariadne versions > 2.7.5 you can add as many arguments to fill as you want, combining the different possibilities. If you need to set an option, you can no longer pass these as an array to fill(). Instead add a call to configure() with the same options array, e.g.:

<pinp>
  echo ar('html')->menu()
  ->configure( array( 'skipOrphans' => true ) )
  ->fill( ar::find( "object.implements='pdir'" ) );
</pinp>

levels

(object) $htmlMenu->levels( $depth, $start = 0, $root = null )

This method adds classes to each list item and menu with the current level. It returns the menu object. e.g:

<pinp>
  ar('html')->menu()->tree()->levels(2);
</pinp>

Will generate:

<ul class="menuLevel-0">
  <li class="menuLevel-0">
    <a href="http://../">Foo</a>
    <ul class="menuLevel-1">
      <li class="menuLevel-1">
        <a href="http://.../">Bar</a>
      </li>
      <li class="menuLevel-1">
        <a href="http://.../">xyzzy</a>
      </li>
    </ul>
  </li>
</ul>

root

(object) $htmlMenu->root( $url, $path = '/' )

Sets the root url and optionally the root path for the menu. All items with relative paths will get urls based on these.

script

(string) ar_html_menu::script( $type, $matches = array() )

Returns a string with some javascript methods and optionally initialization code. Currently there is only a script for the dropdown menu type. This is only used for backwards compatibility with Internet Explorer < 8 or IE8 in quirksmode.

If $matches is not specified, the script will only contain the function that initializes a menu, but without an immediate call to it. You must initialize the menu yourself, e.g. in a window.onload method. The dropdown menu can be initialized by calling the arMenuHover() method with either '#id' or '.class' as argument.

sitemap

(object) $htmlMenu->sitemap( $options = array() )

This method fills the menu object with all the children of the top object.  You can set the following options:

stripe

(object) $htmlMenu->stripe( $options = array() )

This method adds classes to each list item corresponding with even and odd items as well as first and last items. e.g:

<pinp>
  ar('html')->menu()->tree()->stripe();
</pinp>

Will generate:

<ul>
  <li class="menuFirst menuOdd menuLast">
    <a href="http://../">Foo</a>
    <ul>
      <li class="menuFirst menuOdd">
        <a href="http://.../">Bar</a>
      </li>
      <li class="menuLast menuEven">
        <a href="http://.../">xyzzy</a>
      </li>
    </ul>
  </li>
</ul>

Optionally you can also let the striping continue through child menu's by setting the stripingContinue option to true:

<pinp>
  ar('html')->menu()->tree()
    ->stripe( array( 'stripingContinue' => true ) );
</pinp>

Will generate:

<ul>
  <li class="menuFirst menuOdd">
    <a href="http://../">Foo</a>
    <ul>
      <li class="menuEven">
        <a href="http://.../">Bar</a>
      </li>
      <li class="menuLast menuOdd">
        <a href="http://.../">xyzzy</a>
      </li>
    </ul>
  </li>
</ul>

You can change the stripe pattern by setting the striping option to a suitable list pattern expression:

<pinp>
  ar('html')->menu()->tree()
    ->stripe( array(
      'stripingContinue' => true, 
      'striping' => ar::listPattern( '( .{2} menuThird )*' )
  ) );
</pinp>

Will generate:

<ul>
  <li>
    <a href="http://../">Foo</a>
    <ul>
      <li>
        <a href="http://.../">Bar</a>
      </li>
      <li class="menuThird">
        <a href="http://.../">xyzzy</a>
      </li>
    </ul>
  </li>
</ul>

style

(object) $htmlMenu->style( $type = '' )

Changes the $css property of the menu and returns it. The $css property is a stylesheet object which you can alter through the ar_css api.

The 'tabs' style provides the following variables which can be changed with the bind() method:

The 'dropdown' style provides the following variables:

template

(object) $htmlMenu->template( $template )

Sets the template to call when filling the menu through an ariadne query or predefined fill method ( bar(), crumbs(), tree() and sitemap() ). Defaults to system.get.name.phtml.

tree

(object) $htmlMenu->tree( $options = array() )

This method fills the menu object with the parents, siblings and children of the current menu item. The top can be specified through either the root() method or by setting $options['top'] to the correct path. The current object can be specified through either the current() method or by setting $options['current'] to the correct path. It returns the menu object.

In addition you can set the following options:

• FAQ
• Installation
• User Manual
• Tutorials
• Programmers Reference
  • architecture
  • classes
  • Ariadne General API
    • Cache
    • Content
    • connect
    • CSS
    • error
    • events
    • HTML
      • form
      • table
      • Menu
    • HTTP
    • loader
    • PINP
    • store
    • URL
    • XML
  • modules
  • Templates
• Installation Requirements
• Examples