SilverWare\Contact\Model\ContactItem
An extension of the component class for a contact 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 ContactItem
extends Component
{
- // members
- private static string $singular_name = 'Item';
- private static string $plural_name = 'Items';
- private static string $description = 'A component which represents a contact item';
- private static string $table_name = 'SilverWare_ContactItem';
- private static string $icon = 'silverware/contact: admin/client/dist/images/icons/ContactItem.png';
- private static string $hide_ancestor = Component::class;
- private static array|string $allowed_children = 'none';
- private static array $db = ;
- private static array $defaults = ;
- private static array $extensions = ;
- // methods
- public FieldList getCMSFields()
- public RequiredFields getCMSValidator()
- public array fieldLabels()
- public string getHeadingTag()
- public string getItemTag()
- public boolean getIsListItem()
- public boolean getShowIcon()
- public boolean getShowText()
- public boolean getShowTitle()
- public boolean getFontIconFixedWidth()
- public boolean getFontIconListItem()
- public null getContent()
- public DBHTMLText|string renderSelf()
- public DBHTMLText|string renderContent()
Hierarchy
Extends
- SilverWare\Model\Component
Members
private
- $allowed_children
—
SilverWare\Contact\Model\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. - $extensions
—
array
Defines the extension classes to apply to 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
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getCMSValidator() — Answers a validator for the CMS interface.
- getContent() — Answers null to avoid problems with '$Content' double-ups in the template.
- getFontIconFixedWidth() — Answers true to enable fixed width mode.
- getFontIconListItem() — Answers true to enable list item mode.
- getHeadingTag() — Answers the heading tag for the receiver.
- getIsListItem() — Answers true if the receiver is a list item.
- getItemTag() — Answers the item tag for the receiver.
- getShowIcon() — Answers true if the font icon is to be shown.
- getShowText() — Answers true if the title text is to be shown.
- getShowTitle() — Answers true if the title is to be shown in the template.
- renderContent() — Renders the content for the HTML template.
- renderSelf() — Renders the object for the HTML template.