SilverWare\Publications\Pages\Publication
An extension of the page class for a publication.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2018 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class Publication
extends Page
{
- // members
- private static string $singular_name = 'Publication';
- private static string $plural_name = 'Publications';
- private static string $description = 'An individual publication within a publication category';
- private static string $icon = 'silverware/publications: admin/client/dist/images/icons/Publication.png';
- private static string $table_name = 'SilverWare_Publication';
- private static boolean $can_be_root = false;
- private static array|string $allowed_children = 'none';
- private static array $db = ;
- private static array $has_many = ;
- private static array $defaults = ;
- private static array $extensions = ;
- private static string $meta_image_folder = 'Publications';
- private static array $list_item_details = ;
- private static array $detail_fields = ;
- private static boolean $detail_fields_inline = true;
- private static boolean $detail_fields_hide_header = true;
- private static boolean $detail_fields_hide_names = true;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public void populateDefaults()
- public PublicationCategory getCategory()
- public DBDate getMetaDate()
- public DataList getEnabledFiles()
- public string getNumberOfPages()
- public boolean getShowFileInfo()
- public string getFilesHeadingText()
Hierarchy
Extends
- Page
Members
private
- $allowed_children
—
SilverWare\Publications\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_hide_names
—
boolean
Defines the setting for hiding the detail field names. - $detail_fields_inline
—
boolean
Defines the setting for showing the detail fields inline. - $extensions
—
array
Defines the extension classes to apply to this object. - $has_many
—
array
Defines the has-many associations for 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
- 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.
- getEnabledFiles() — Answers a list of the enabled files within the receiver.
- getFilesHeadingText() — Answers the heading text for the files section.
- getMetaDate() — Answers the meta date for the receiver.
- getNumberOfPages() — Answers the number of pages within the publications.
- getShowFileInfo() — Answers true if the file information is to be shown in the template.
- populateDefaults() — Populates the default values for the fields of the receiver.