SilverWare\Search\Pages\SearchResultsPage
An extension of the page class for a search results 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 SearchResultsPage
extends Page
{
- // members
- private static string $singular_name = 'Search Results Page';
- private static string $plural_name = 'Search Results Pages';
- private static string $icon = 'silverware/search: admin/client/dist/images/icons/SearchResultsPage.png';
- private static string $table_name = 'SilverWare_SearchResultsPage';
- private static string $description = 'A dedicated page for showing search results';
- private static array $db = ;
- private static array $defaults = ;
- private static string $heading_level_default = 'h4';
- // methods
- public static SearchResultsPage find()
- public FieldList getCMSFields()
- public array fieldLabels()
- public void populateDefaults()
- public void requireDefaultRecords()
- public string getHeadingTag()
Hierarchy
Extends
- 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. - $heading_level_default
—
array
Defines the default heading level to use. - $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.
- find() — Answers the search results page for the site.
- getCMSFields() — Answers a list of field objects for the CMS interface.
- getHeadingTag() — Answers the heading tag for the receiver.
- populateDefaults() — Populates the default values for the fields of the receiver.
- requireDefaultRecords() — Creates any required default records (if they do not already exist).