SilverWare\FAQs\Pages\FAQ
An extension of the page class for an FAQ.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2018 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class FAQ
extends Page
{
- // members
- private static string $singular_name = 'FAQ';
- private static string $plural_name = 'FAQs';
- private static string $description = 'An individual FAQ within an FAQ category';
- private static string $icon = 'silverware/faqs: admin/client/dist/images/icons/FAQ.png';
- private static string $table_name = 'SilverWare_FAQ';
- private static boolean $can_be_root = false;
- private static array|string $allowed_children = 'none';
- private static array $defaults = ;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public string getHTMLID()
- public FAQCategory getCategory()
- public string getFAQLink()
- public string getAnchorLink()
- public string getCategoryLink()
- public boolean getFooterShown()
- public string getTopIcon()
- public string getTopText()
Hierarchy
Extends
- Page
Members
private
- $allowed_children
—
SilverWare\FAQs\Pages\array|string
Defines the allowed children for this object. - $can_be_root
—
boolean
Determines whether this object can exist at the root level. - $defaults
—
array
Defines the default values for the fields of this object. - $description
—
string
Description of this object. - $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.
- getAnchorLink() — Answers an anchor link for the current page.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getCategory() — Answers the parent category of the receiver.
- getCategoryLink() — Answers an anchor link for the FAQ within the category.
- getFAQLink() — Answers the appropriate link for the FAQ.
- getHTMLID() — Answers a unique ID for the HTML template.
- getTopIcon() — Answers the icon to use for top buttons.
- getTopText() — Answers the text to use for top buttons.