SilverWare\Sitemap\Pages\SitemapPage
An extension of the page class for a sitemap page.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2018 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class SitemapPage
extends Page
{
- // constants
- const MODE_ALL = 'all';
- const MODE_CHILDREN = 'children';
- const MODE_SELECTED = 'selected';
- const TITLE_MENU = 'menu';
- const TITLE_PAGE = 'page';
- // members
- private static string $singular_name = 'Sitemap Page';
- private static string $plural_name = 'Sitemap Pages';
- private static string $description = 'Generates a sitemap of the pages within the site';
- private static string $icon = 'silverware/sitemap: admin/client/dist/images/icons/SitemapPage.png';
- private static string $table_name = 'SilverWare_SitemapPage';
- private static array $db = ;
- private static array $has_one = ;
- private static array $many_many = ;
- private static array $defaults = ;
- // methods
- public FieldList getCMSFields()
- public array fieldLabels()
- public DataList getSitemap()
- public DataList getChildPages()
- public DataList getTopLevelPages()
- public array getTitleOptions()
- public string getNoDataMessage()
Hierarchy
Extends
- Page
Constants
Name | Value |
---|---|
MODE_ALL | 'all' |
MODE_CHILDREN | 'children' |
MODE_SELECTED | 'selected' |
TITLE_MENU | 'menu' |
TITLE_PAGE | 'page' |
Members
private
- $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. - $has_one
—
array
Defines the has-one associations for this object. - $icon
—
string
Icon file for this object. - $many_many
—
array
Defines the many-many associations 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.
- getChildPages() — Answers a data list containing the children of the defined parent page.
- getNoDataMessage() — Answers a message string to be shown when no data is available.
- getSitemap() — Answers the sitemap data list for the template.
- getTitleOptions() — Answers an array of options for title fields.
- getTopLevelPages() — Answers a data list containing the top-level pages of the site.