SilverWare\Staff\Pages\StaffMember
An extension of the page class for a staff member.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class StaffMember
extends Page
{
- // constants
- const GENDER_MALE = 'male';
- const GENDER_FEMALE = 'female';
- const GENDER_UNSPECIFIED = 'unspecified';
- // members
- private static string $singular_name = 'Staff Member';
- private static string $plural_name = 'Staff Members';
- private static string $description = 'An individual member within a staff category';
- private static string $icon = 'silverware/staff: admin/client/dist/images/icons/StaffMember.png';
- private static string $table_name = 'SilverWare_StaffMember';
- private static boolean $can_be_root = false;
- private static array|string $allowed_children = 'none';
- private static array $db = ;
- private static array $defaults = ;
- private static array $extensions = ;
- private static string $meta_image_folder = 'Staff';
- private static array $list_item_details = ;
- private static array $detail_fields = ;
- private static boolean $detail_fields_hide_header = true;
- private static boolean $detail_fields_use_heading = true;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public string CMSTreeClasses()
- public StaffCategory getCategory()
- public DBHTMLText getMetaSummary()
- public array getGenderOptions()
Hierarchy
Extends
- Page
Constants
Name | Value |
---|---|
GENDER_MALE | 'male' |
GENDER_FEMALE | 'female' |
GENDER_UNSPECIFIED | 'unspecified' |
Members
private
- $allowed_children
—
SilverWare\Staff\Pages\array|string
Defines the allowed children for this object. - $can_be_root
—
boolean
Determines whether this object can exist at the root level. - $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. - $detail_fields
—
array
Defines the detail fields to show for the object. - $detail_fields_hide_header
—
boolean
Defines the setting for hiding the detail fields header. - $detail_fields_use_heading
—
boolean
Defines the setting for using a heading tag for each detail field. - $extensions
—
array
Defines the extension classes to apply to this object. - $icon
—
string
Icon file for this object. - $list_item_details
—
array
Defines the list item details to show for this object. - $meta_image_folder
—
string
Defines the asset folder for uploaded meta images. - $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
- CMSTreeClasses() — Answers a string of CSS classes to apply to the receiver in the CMS tree.
- fieldLabels() — Answers the labels for the fields of the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getCategory() — Answers the parent category of the receiver.
- getGenderOptions() — Answers an array of options for the gender field.
- getMetaSummary() — Answers the meta summary for the receiver.