SilverWare\Staff\Pages\StaffPage
An extension of the page class for a staff page.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class StaffPage
extends Page
implements
ListSource
{
- // members
- private static string $singular_name = 'Staff Page';
- private static string $plural_name = 'Staff Pages';
- private static string $description = 'Holds a series of staff members organised into categories';
- private static string $icon = 'silverware/staff: admin/client/dist/images/icons/StaffPage.png';
- private static string $table_name = 'SilverWare_StaffPage';
- private static string $default_child = StaffCategory::class;
- private static array $db = ;
- private static array|string $allowed_children = ;
- private static array $extensions = ;
- private static array $list_view_defaults = ;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public ArrayList getMembers()
- public DataList getChildMembers()
- public DataList getListItems()
- public DataList getAllCategories()
- public ArrayList getVisibleCategories()
- public BaseListComponent getChildMemberList()
- public BaseListComponent getMemberList()
Hierarchy
Extends
- Page
Implements
- SilverWare\Lists\ListSource
Members
private
- $allowed_children
—
SilverWare\Staff\Pages\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. - $description
—
string
Description of this object. - $extensions
—
array
Defines the extension classes to apply to this object. - $icon
—
string
Icon file for this object. - $list_view_defaults
—
array
Defines the default values for the list view component. - $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.
- getAllCategories() — Answers all categories within the receiver.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getChildMemberList() — Answers the child member list component for the template.
- getChildMembers() — Answers a list of the immediate child members of the staff page.
- getListItems() — Answers a list of members within the receiver.
- getMemberList() — Answers the member list component for the given staff category.
- getMembers() — Answers a list of members within the staff page.
- getVisibleCategories() — Answers all visible categories within the receiver.