P4Cms_Navigation_Page_Heading Class Reference

Provides a 'heading' page for menus, for entries that need to exist without a link. More...

Inheritance diagram for P4Cms_Navigation_Page_Heading:

List of all members.

Public Member Functions
	getHref ()
	Implement getHref as it is abstract in parent.
	getLabel ()
	Returns page label with support for macros.
	getTitle ()
	Returns page title with support for macros.
	toArray ()
	Returns an array representation of the page.

---

Detailed Description

Provides a 'heading' page for menus, for entries that need to exist without a link.

Adds support for macros in page labels and titles.

Copyright:

2011-2012 Perforce Software. All rights reserved

License:

Please see LICENSE.txt in top-level folder of this distribution.

Version:

2012.2/486814

---

Member Function Documentation

P4Cms_Navigation_Page_Heading::getHref

(

)

Implement getHref as it is abstract in parent.

We don't actually use it so returns ""

Returns:

string the page's href

    {
        return '';
    }

P4Cms_Navigation_Page_Heading::getLabel

(

)

Returns page label with support for macros.

Returns:

string page label or null

Reimplemented in P4Cms_Navigation_Page_Separator.

    {
        return P4Cms_Navigation::expandMacros(parent::getLabel(), $this);
    }

P4Cms_Navigation_Page_Heading::getTitle

(

)

Returns page title with support for macros.

Returns:

string|null page title or null

    {
        return P4Cms_Navigation::expandMacros(parent::getTitle(), $this);
    }

P4Cms_Navigation_Page_Heading::toArray

(

)

Returns an array representation of the page.

Returns:

array associative array containing all page properties

    {
        return array_merge(
            parent::toArray(),
            array(
                'label' => $this->_label,
                'title' => $this->_title
            )
        );
    }

---

The documentation for this class was generated from the following file:

• Heading.php