SilverWare\Navigation\Components\InlineNavigation
An extension of the link holder class for inline navigation.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class InlineNavigation
extends LinkHolder
{
- // Inherited constants from LinkHolder
- const MODE_LINKS = 'links';
- const MODE_PAGES = 'pages';
- const SORT_ORDER = 'order';
- const SORT_TITLE = 'title';
- // members
- private static string $singular_name = 'Inline Navigation';
- private static string $plural_name = 'Inline Navigation';
- private static string $description = 'A component which shows a series of inline links';
- private static string $icon = 'silverware/navigation: admin/client/dist/images/icons/InlineNavigation.png';
- private static string $table_name = 'SilverWare_InlineNavigation';
- private static string $hide_ancestor = LinkHolder::class;
- // methods
- public array getWrapperClassNames()
- // Inherited methods from LinkHolder
- public FieldList getCMSFields()
- public array fieldLabels()
- public array getWrapperClassNames()
- public array getListClassNames()
- public DataList getLinks()
- public ArrayList getEnabledLinks()
- public array getLinkModeOptions()
- public string getSortOrder()
- public array getSortByOptions()
Hierarchy
Constants
Name | Value |
---|---|
MODE_LINKS | 'links' |
MODE_PAGES | 'pages' |
SORT_ORDER | 'order' |
SORT_TITLE | 'title' |
Members
private
- $description
—
string
Description of this object. - $hide_ancestor
—
string
Defines an ancestor class to hide from the admin interface. - $icon
—
string
Icon file for this object. - $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
public
- getWrapperClassNames() — Answers an array of wrapper class names for the HTML template.
Inherited from SilverWare\Navigation\Model\LinkHolder
public
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getEnabledLinks() — Answers a list of the enabled links within the receiver.
- getLinkModeOptions() — Answers an array of options for the link mode field.
- getLinks() — Answers a list of all links within the receiver.
- getListClassNames() — Answers an array of list class names for the HTML template.
- getSortByOptions() — Answers an array of options for the sort by field.
- getSortOrder() — Answers the sort order for the navigation.
- getWrapperClassNames() — Answers an array of wrapper class names for the HTML template.