SilverWare\Navigation\Items\NavigationItem
An extension of the bar item class for a navigation item.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class NavigationItem
extends BarItem
{
- // members
- private static string $singular_name = 'Navigation Item';
- private static string $plural_name = 'Navigation Items';
- private static string $description = 'A bar item which shows the main navigation';
- private static string $table_name = 'SilverWare_Navigation_NavigationItem';
- private static string $hide_ancestor = BarItem::class;
- private static array $db = ;
- private static array $defaults = ;
- private static array $active_menu_modes = ;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public array getClassNames()
- public ArrayData getListItemData()
- public array getMenuLinkClass()
- public string getDividerClass()
- public ArrayList getMenu()
- protected boolean isActive()
- protected string getDropdownID()
- // Inherited methods from BarItem
- public DBHTMLText|string renderSelf()
Hierarchy
Members
private
- $db
—
array
Maps field names to field types for this object. - $defaults
—
array
Defines the default values for the fields of this object. - $description
—
string
Description of this object. - $hide_ancestor
—
string
Defines an ancestor class to hide from the admin interface. - $plural_name
—
string
Human-readable plural name. - $singular_name
—
string
Human-readable singular name. - $table_name
—
string
Defines the table name to use for this object.
Methods
protected
- getDropdownID() — Answers a dropdown ID for the given URL segment.
- isActive() — Answers true if the given mode is considered to be active.
public
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getClassNames() — Answers an array of class names for the HTML template.
- getDividerClass() — Answers the class name for a dropdown divider.
- getListItemData() — Answers the template data for the current list item.
- getMenu() — Answers the menu list with the specified level from the current controller.
- getMenuLinkClass() — Answers an array of class names for a menu link.
Inherited from SilverWare\Navigation\Model\BarItem
public
- renderSelf() — Renders the object for the HTML template.