SilverCart\Model\Pages\Page
Standard Page.
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
class Page
extends SiteTree
{
- // constants
- const IDENTIFIER_ADDRESS_HOLDER = 'SilvercartAddressHolder';
- const IDENTIFIER_CART_PAGE = 'SilvercartCartPage';
- const IDENTIFIER_CHECKOUT_PAGE = 'SilvercartCheckoutStep';
- const IDENTIFIER_CONTACT_FORM_PAGE = 'SilvercartContactFormPage';
- const IDENTIFIER_CUSTOMER_DATA_PAGE = 'SilvercartCustomerDataPage';
- const IDENTIFIER_DATA_PRIVACY_PAGE = 'DataPrivacyStatementPage';
- const IDENTIFIER_FRONT_PAGE = 'SilvercartFrontPage';
- const IDENTIFIER_IMPRINT_PAGE = 'ImprintPage';
- const IDENTIFIER_META_ABOUT_HOLDER = 'SilvercartMetaNavigationHolderAbout';
- const IDENTIFIER_META_LEGAL_HOLDER = 'SilvercartMetaNavigationHolderLegal';
- const IDENTIFIER_META_SERVICE_HOLDER = 'SilvercartMetaNavigationHolderService';
- const IDENTIFIER_META_SHOP_HOLDER = 'SilvercartMetaNavigationHolderShop';
- const IDENTIFIER_MY_ACCOUNT_HOLDER = 'SilvercartMyAccountHolder';
- const IDENTIFIER_NEWSLETTER_PAGE = 'SilvercartNewsletterPage';
- const IDENTIFIER_ORDER_HOLDER = 'SilvercartOrderHolder';
- const IDENTIFIER_PAYMENT_METHODS_PAGE = 'SilvercartPaymentMethodsPage';
- const IDENTIFIER_PRODUCT_GROUP_HOLDER = 'SilvercartProductGroupHolder';
- const IDENTIFIER_REGISTRATION_PAGE = 'SilvercartRegistrationPage';
- const IDENTIFIER_REVOCATION_FORM_PAGE = 'SilvercartRevocationFormPage';
- const IDENTIFIER_REVOCATION_INSTRUCTION_PAGE = 'SilvercartRevocationInstructionPage';
- const IDENTIFIER_SEARCH_RESULTS_PAGE = 'SilvercartSearchResultsPage';
- const IDENTIFIER_SHIPPING_FEES_PAGE = 'SilvercartShippingFeesPage';
- const IDENTIFIER_TERMS_OF_SERVICE_PAGE = 'TermsOfServicePage';
- // members
- private static string $robots_tag_noindex = 'noindex, nofollow';
- private static string $robots_tag_index = 'index, follow';
- private static array $db = ;
- private static array $indexes = ;
- private static string $table_name = 'SilvercartPage';
- protected boolean $getCMSFieldsIsCalled = false;
- // methods
- public static string getRobotsTag()
- public static SiteTree|null PageByIdentifierCode()
- public static string PageByIdentifierCodeLink()
- public string singular_name()
- public string plural_name()
- public bool canTranslate()
- public FieldList getCMSFields()
- public bool getCMSFieldsIsCalled()
- public array fieldLabels()
- protected void onBeforeWrite()
- public string getTitle()
- public string getPlainTitle()
- public Page MainNavigationRootPage()
- public string MainNavigationCacheKey()
- public string MemberGroupCacheKey()
- public boolean hasProductsOrChildren()
- public mixed SilvercartNoImage()
- public string getSection()
- public string getTreeTitle()
- public string MetaTags()
- public string MakeAbsoluteLink()
- public string AbsoluteCanonicalLink()
- public string CanonicalLink()
- public string OriginalLink()
- public string LocaleOriginalLink()
- public ArrayList getAllTranslations()
- public string getIso2()
- public string getLangCode()
- public string getContent()
- public string getMetaDescription()
- public string String2urlSegment()
- public bool isStartPage()
- public string Breadcrumbs()
- public void beforeUpdateBreadcrumbItems()
- public ArrayList getBreadcrumbItems()
- public DBHTMLText HeaderNavBeforeTranslationSelectContent()
- public DBHTMLText HeaderNavBeforeAccountSelectContent()
- public DBHTMLText HeaderNavBeforeCartSelectContent()
- public static string link_shortcode_handler()
- public string OpenGraphMetaTags()
- public string getCurrentDate()
- public string PasswordHint()
- // Inherited methods from ExtensibleDataObject
- protected void beforeRequireDefaultRecords()
- protected void beforeUpdateCMSActions()
- protected void beforeUpdateFieldLabels()
- protected void beforeUpdateProvidePermissions()
- public array defaultFieldLabels()
- public static void reset_field_labels()
- protected array scaffoldFieldLabels()
Hierarchy
Constants
Name | Value |
---|---|
IDENTIFIER_ADDRESS_HOLDER | 'SilvercartAddressHolder' |
IDENTIFIER_CART_PAGE | 'SilvercartCartPage' |
IDENTIFIER_CHECKOUT_PAGE | 'SilvercartCheckoutStep' |
IDENTIFIER_CONTACT_FORM_PAGE | 'SilvercartContactFormPage' |
IDENTIFIER_CUSTOMER_DATA_PAGE | 'SilvercartCustomerDataPage' |
IDENTIFIER_DATA_PRIVACY_PAGE | 'DataPrivacyStatementPage' |
IDENTIFIER_FRONT_PAGE | 'SilvercartFrontPage' |
IDENTIFIER_IMPRINT_PAGE | 'ImprintPage' |
IDENTIFIER_META_ABOUT_HOLDER | 'SilvercartMetaNavigationHolderAbout' |
IDENTIFIER_META_LEGAL_HOLDER | 'SilvercartMetaNavigationHolderLegal' |
IDENTIFIER_META_SERVICE_HOLDER | 'SilvercartMetaNavigationHolderService' |
IDENTIFIER_META_SHOP_HOLDER | 'SilvercartMetaNavigationHolderShop' |
IDENTIFIER_MY_ACCOUNT_HOLDER | 'SilvercartMyAccountHolder' |
IDENTIFIER_NEWSLETTER_PAGE | 'SilvercartNewsletterPage' |
IDENTIFIER_ORDER_HOLDER | 'SilvercartOrderHolder' |
IDENTIFIER_PAYMENT_METHODS_PAGE | 'SilvercartPaymentMethodsPage' |
IDENTIFIER_PRODUCT_GROUP_HOLDER | 'SilvercartProductGroupHolder' |
IDENTIFIER_REGISTRATION_PAGE | 'SilvercartRegistrationPage' |
IDENTIFIER_REVOCATION_FORM_PAGE | 'SilvercartRevocationFormPage' |
IDENTIFIER_REVOCATION_INSTRUCTION_PAGE | 'SilvercartRevocationInstructionPage' |
IDENTIFIER_SEARCH_RESULTS_PAGE | 'SilvercartSearchResultsPage' |
IDENTIFIER_SHIPPING_FEES_PAGE | 'SilvercartShippingFeesPage' |
IDENTIFIER_TERMS_OF_SERVICE_PAGE | 'TermsOfServicePage' |
Members
private
- $db
—
array
extends statics - $indexes
—
array
Define indexes. - $robots_tag_index
—
string
The robots tag content for common content in live mode. - $robots_tag_noindex
—
string
The robots tag content for dev mode or sensible content. - $table_name
—
string
DB table name
protected
- $defaultFieldLabels
—
array
Default field labels. - $getCMSFieldsIsCalled
—
boolean
Indicator to check whether getCMSFields is called
Methods
protected
- onBeforeWrite() — Handles the UseAsRootForMainNavigation property on before write.
public
- AbsoluteCanonicalLink() — Returns the absolute canonical link.
- Breadcrumbs() — Adds the overwriteBreadcrumbs extension.
- CanonicalLink() — Returns the relative canonical link.
- LocaleOriginalLink() — Same as \TractorCow\Fluent\Extension\FluentExtension::LocaleLink() but uses the method self::OriginalLink() instead.
- MakeAbsoluteLink() — Takes a relativelink and returns an absolute link.
- MemberGroupCacheKey() — Returns the related groups as a cache key string.
- MetaTags() — Return the title, description, keywords and language metatags.
- OpenGraphMetaTags() — Meta Tags for Social Sharing Pages and Products
- OriginalLink() — Alias for self::Link().
- PageByIdentifierCode() — returns a single page by IdentifierCode used to retrieve links dynamically
- PageByIdentifierCodeLink() — returns a page link by IdentifierCode
- PasswordHint() — Returns the password validation hint.
- SilvercartNoImage() — Returns the generic image for products without an own image. If none is defined, boolean false is returned.
- String2urlSegment() — Returns the given string to use as a valid URL segment.
- beforeUpdateBreadcrumbItems() — Allows user code to hook into DataObject::getBreadcrumbItems prior to updateBreadcrumbItems being called on extensions
- canTranslate() — Always enable translations for this page.
- fieldLabels() — Field labels for display in tables.
- getAllTranslations() — Returns all translated locales as a special ArrayList
- getBreadcrumbItems() — Returns a list of breadcrumbs for the current page.
- getCMSFields() — Define editing fields for the storeadmin.
- getCMSFieldsIsCalled() — Returns the getCMSFieldsIsCalled property.
- getContent() — Adds a decorator hook and returns the Content.
- getCurrentDate() — Returns the current date.
- getIso2() — Returns the ISO2 for the given locale
- getLangCode() — Returns the ISO2 for the given locale
- getMetaDescription() — Adds a decorator hook and returns the MetaDescription.
- getPlainTitle() — Returns the original title without any extension mutations.
- getRobotsTag() — Returns the robots tag depending on the current environment mode.
- getSection() — configure the class name of the DataObjects to be shown on this page this is needed to show correct breadcrumbs. This is used as fall back.
- getTitle() — getter for the Title, looks for set translation
- getTreeTitle() — getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its publication status.
- hasProductsOrChildren() — Dummy to provide enhanced product group functions.
- isStartPage() — Checks if the given link is the start page link.
- link_shortcode_handler() — Replace a "[searchresults_link,id=n,q=s,c=m]" shortcode with a link to the search results page with the corresponding ID.
- plural_name() — Returns the translated plural name of the object. If no translation exists the class name will be returned.
- singular_name() — Returns the translated singular name of the object. If no translation exists the class name will be returned.
Inherited from SilverCart\ORM\ExtensibleDataObject
protected
- beforeRequireDefaultRecords() — Allows user code to hook into DataObject::requireDefaultRecords() prior to requireDefaultRecords being called on extensions.
- beforeUpdateCMSActions() — Allows user code to hook into DataObject::getCMSActions prior to updateCMSActions being called on extensions.
- beforeUpdateFieldLabels() — Allows user code to hook into DataObject::fieldLabels() prior to updateFieldLabels being called on extensions.
- beforeUpdateProvidePermissions() — Allows user code to hook into DataObject::updateProvidePermissions() prior to providePermissions being called on extensions.
- scaffoldFieldLabels() — Returns the default field labels for this DataObject.
public
- defaultFieldLabels() — Returns the default field labels.
- reset_field_labels() — Resets the field label cache.