SilverWare\Navigation\Model\LinkHolder
An extension of the base component class for a link holder.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class LinkHolder
extends BaseComponent
{
- // constants
- const MODE_LINKS = 'links';
- const MODE_PAGES = 'pages';
- const SORT_ORDER = 'order';
- const SORT_TITLE = 'title';
- // members
- private static string $singular_name = 'Link Holder';
- private static string $plural_name = 'Link Holders';
- private static string $description = 'A component which holds a series of links';
- private static string $table_name = 'SilverWare_Navigation_LinkHolder';
- private static string $hide_ancestor = BaseComponent::class;
- private static string $default_child = Link::class;
- private static array $db = ;
- private static array $many_many = ;
- private static array $defaults = ;
- private static array|string $allowed_children = ;
- private static array $extensions = ;
- // methods
- 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
Extends
- SilverWare\Components\BaseComponent
Constants
Name | Value |
---|---|
MODE_LINKS | 'links' |
MODE_PAGES | 'pages' |
SORT_ORDER | 'order' |
SORT_TITLE | 'title' |
Members
private
- $allowed_children
—
SilverWare\Navigation\Model\array|string
Defines the allowed children for this object. - $db
—
array
Maps field names to field types for this object. - $default_child
—
string
Defines the default child class for this object. - $defaults
—
array
Defines the default values for the fields of this object. - $description
—
string
Description of this object. - $extensions
—
array
Defines the extension classes to apply to this object. - $hide_ancestor
—
string
Defines an ancestor class to hide from the admin interface. - $many_many
—
array
Defines the many-many associations 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
- 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.