SilverWare\Social\Items\SharingItem
An extension of the bar item class for a sharing item.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2018 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class SharingItem
extends BarItem
{
- // members
- private static string $singular_name = 'Sharing Item';
- private static string $plural_name = 'Sharing Items';
- private static string $description = 'A bar item to show a series of sharing icons';
- private static string $table_name = 'SilverWare_SharingItem';
- private static string $hide_ancestor = BarItem::class;
- private static array $db = ;
- private static array $defaults = ;
- private static array|string $allowed_children = ;
- private static array $disabled_on = ;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public array getListClassNames()
- public array getListItemClassNames()
- public DataList getIcons()
- public ArrayList getEnabledIcons()
- public boolean isDisabled()
Hierarchy
Extends
- SilverWare\Navigation\Model\BarItem
Members
private
- $allowed_children
—
SilverWare\Social\Items\array|string
Defines the allowed children for this object. - $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. - $disabled_on
—
array
Defines the page classes to disable the object by default. - $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
public
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getEnabledIcons() — Answers a list of the enabled icons within the receiver.
- getIcons() — Answers a list of all icons within the receiver.
- getListClassNames() — Answers an array of list class names for the HTML template.
- getListItemClassNames() — Answers an array of list item class names for the HTML template.
- isDisabled() — Answers true if the object is disabled within the template.