View/Helper/Navigation/Links.php

Examples of finder calls:

// METHOD                  // SAME AS
$h->findRelNext($page);    // $h->findRelation($page, 'rel', 'next')
$h->findRevSection($page); // $h->findRelation($page, 'rev', 'section');
$h->findRelFoo($page);     // $h->findRelation($page, 'rel', 'foo');

The form of the returned array:

// $page denotes an instance of Zend_Navigation_Page
$returned = array(
    'rel' => array(
        'alternate' => array($page, $page, $page),
        'start'     => array($page),
        'next'      => array($page),
        'prev'      => array($page),
        'canonical' => array($page)
    ),
    'rev' => array(
        'section'   => array($page)
    )
);

This method will first look for relations in the page instance, then by searching the root container if nothing was found in the page.

Implements Zend_View_Helper_Navigation_Helper::render().

From http://www.w3.org/TR/html4/types.html#type-links: Refers to a document serving as a chapter in a collection of documents.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to the next document in a linear sequence of documents. User agents may choose to preload the "next" document, to reduce the perceived load time.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to the previous document in an ordered series of documents. Some user agents also support the synonym "Previous".

From http://www.w3.org/TR/html4/types.html#type-links: Refers to a document serving as a section in a collection of documents.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to the first document in a collection of documents. This link type tells search engines which document is considered by the author to be the starting point of the collection.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to a document serving as a subsection in a collection of documents.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to a document serving as a section in a collection of documents.

From http://www.w3.org/TR/html4/types.html#type-links: Refers to a document serving as a subsection in a collection of documents.

The helper uses the bitwise '&' operator against the hex values of the render constants. This means that the flag can is "bitwised" value of the render constants. Examples:

// render all links except glossary
$flag = Zend_View_Helper_Navigation_Links:RENDER_ALL ^
        Zend_View_Helper_Navigation_Links:RENDER_GLOSSARY;
$helper->setRenderFlag($flag);

// render only chapters and sections
$flag = Zend_View_Helper_Navigation_Links:RENDER_CHAPTER |
        Zend_View_Helper_Navigation_Links:RENDER_SECTION;
$helper->setRenderFlag($flag);

// render only relations that are not native W3C relations
$helper->setRenderFlag(Zend_View_Helper_Navigation_Links:RENDER_CUSTOM);

// render all relations (default)
$helper->setRenderFlag(Zend_View_Helper_Navigation_Links:RENDER_ALL);

Note that custom relations can also be rendered directly using the renderLink() method.