Page Class Reference

Inheritance diagram for Page:

Public Member Functions
	load ($id, $field=null)
	noRoutePage ()
	getStores ()
	checkIdentifier ($identifier, $storeId)
	getAvailableStatuses ()
	getIdentities ()
	getId ()
	getIdentifier ()
	getTitle ()
	getPageLayout ()
	getMetaTitle ()
	getMetaKeywords ()
	getMetaDescription ()
	getContentHeading ()
	getContent ()
	getCreationTime ()
	getUpdateTime ()
	getSortOrder ()
	getLayoutUpdateXml ()
	getCustomTheme ()
	getCustomRootTemplate ()
	getCustomLayoutUpdateXml ()
	getCustomThemeFrom ()
	getCustomThemeTo ()
	isActive ()
	setId ($id)
	setIdentifier ($identifier)
	setTitle ($title)
	setPageLayout ($pageLayout)
	setMetaTitle ($metaTitle)
	setMetaKeywords ($metaKeywords)
	setMetaDescription ($metaDescription)
	setContentHeading ($contentHeading)
	setContent ($content)
	setCreationTime ($creationTime)
	setUpdateTime ($updateTime)
	setSortOrder ($sortOrder)
	setLayoutUpdateXml ($layoutUpdateXml)
	setCustomTheme ($customTheme)
	setCustomRootTemplate ($customRootTemplate)
	setCustomLayoutUpdateXml ($customLayoutUpdateXml)
	setCustomThemeFrom ($customThemeFrom)
	setCustomThemeTo ($customThemeTo)
	setIsActive ($isActive)
	beforeSave ()
Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	__sleep ()
	__wakeup ()
	setIdFieldName ($name)
	getIdFieldName ()
	getId ()
	setId ($value)
	isDeleted ($isDeleted=null)
	hasDataChanges ()
	setData ($key, $value=null)
	unsetData ($key=null)
	setDataChanges ($value)
	getOrigData ($key=null)
	setOrigData ($key=null, $data=null)
	dataHasChangedFor ($field)
	getResourceName ()
	getResourceCollection ()
	getCollection ()
	load ($modelId, $field=null)
	beforeLoad ($identifier, $field=null)
	afterLoad ()
	isSaveAllowed ()
	setHasDataChanges ($flag)
	save ()
	afterCommitCallback ()
	isObjectNew ($flag=null)
	beforeSave ()
	validateBeforeSave ()
	getCacheTags ()
	cleanModelCache ()
	afterSave ()
	delete ()
	beforeDelete ()
	afterDelete ()
	afterDeleteCommit ()
	getResource ()
	getEntityId ()
	setEntityId ($entityId)
	clearInstance ()
	getStoredData ()
	getEventPrefix ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Data Fields
const	NOROUTE_PAGE_ID = 'no-route'
const	STATUS_ENABLED = 1
const	STATUS_DISABLED = 0
const	CACHE_TAG = 'cms_p'
Data Fields inherited from PageInterface
const	PAGE_ID = 'page_id'
const	IDENTIFIER = 'identifier'
const	TITLE = 'title'
const	PAGE_LAYOUT = 'page_layout'
const	META_TITLE = 'meta_title'
const	META_KEYWORDS = 'meta_keywords'
const	META_DESCRIPTION = 'meta_description'
const	CONTENT_HEADING = 'content_heading'
const	CONTENT = 'content'
const	CREATION_TIME = 'creation_time'
const	UPDATE_TIME = 'update_time'
const	SORT_ORDER = 'sort_order'
const	LAYOUT_UPDATE_XML = 'layout_update_xml'
const	CUSTOM_THEME = 'custom_theme'
const	CUSTOM_ROOT_TEMPLATE = 'custom_root_template'
const	CUSTOM_LAYOUT_UPDATE_XML = 'custom_layout_update_xml'
const	CUSTOM_THEME_FROM = 'custom_theme_from'
const	CUSTOM_THEME_TO = 'custom_theme_to'
const	IS_ACTIVE = 'is_active'

Protected Member Functions
	_construct ()
Protected Member Functions inherited from AbstractModel
	_construct ()
	_init ($resourceModel)
	_setResourceModel ($resourceName, $collectionName=null)
	_getResource ()
	_getEventData ()
	_beforeLoad ($modelId, $field=null)
	_afterLoad ()
	_hasModelChanged ()
	_getValidatorBeforeSave ()
	_createValidatorBeforeSave ()
	_getValidationRulesBeforeSave ()
	_clearReferences ()
	_clearData ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_cacheTag = self::CACHE_TAG
	$_eventPrefix = 'cms_page'
Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'
	$_eventObject = 'object'
	$_idFieldName = 'id'
	$_hasDataChanges = false
	$_origData
	$_isDeleted = false
	$_resource
	$_resourceCollection
	$_resourceName
	$_collectionName
	$_cacheTag = false
	$_dataSaveAllowed = true
	$_isObjectNew = null
	$_validatorBeforeSave = null
	$_eventManager
	$_cacheManager
	$_registry
	$_logger
	$_appState
	$_actionValidator
	$storedData = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Cms Page Model

@api @method Page setStoreId(array $storeId) @method array getStoreId() @SuppressWarnings(PHPMD.ExcessivePublicCount)

Since

100.0.2

Definition at line 24 of file Page.php.

Member Function Documentation

_construct()

_construct ( )

protected

Initialize resource model

Returns

void

Definition at line 65 of file Page.php.

    {
        $this->_init(\Magento\Cms\Model\ResourceModel\Page::class);
    }

beforeSave()

beforeSave

(

)

{}

Since

101.0.0

Before save handler

Parameters

\Magento\Cms\Model\ResourceModel\Page	$subject
\Magento\Framework\Model\AbstractModel	$object

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 544 of file Page.php.

    {
        $originalIdentifier = $this->getOrigData('identifier');
        $currentIdentifier = $this->getIdentifier();

        if ($this->hasDataChanges()) {
            $this->setUpdateTime(null);
        }

        if (!$this->getId() || $originalIdentifier === $currentIdentifier) {
            return parent::beforeSave();
        }

        switch ($originalIdentifier) {
            case $this->getScopeConfig()->getValue(PageHelper::XML_PATH_NO_ROUTE_PAGE):
                throw new LocalizedException(
                    __('This identifier is reserved for "CMS No Route Page" in configuration.')
                );
            case $this->getScopeConfig()->getValue(PageHelper::XML_PATH_HOME_PAGE):
                throw new LocalizedException(__('This identifier is reserved for "CMS Home Page" in configuration.'));
            case $this->getScopeConfig()->getValue(PageHelper::XML_PATH_NO_COOKIES_PAGE):
                throw new LocalizedException(
                    __('This identifier is reserved for "CMS No Cookies Page" in configuration.')
                );
        }

        return parent::beforeSave();
    }

checkIdentifier()

checkIdentifier	(		$identifier,
			$storeId
	)

Check if page identifier exist for specific store return page id if page exists

Parameters

string	$identifier
int	$storeId

Returns

int

Definition at line 113 of file Page.php.

    {
        return $this->_getResource()->checkIdentifier($identifier, $storeId);
    }

getAvailableStatuses()

getAvailableStatuses

(

)

Prepare page's statuses. Available event cms_page_get_available_statuses to customize statuses.

Returns

array

Definition at line 124 of file Page.php.

    {
        return [self::STATUS_ENABLED => __('Enabled'), self::STATUS_DISABLED => __('Disabled')];
    }

getContent()

getContent

(

)

Get content

Returns

string

Implements PageInterface.

Definition at line 225 of file Page.php.

    {
        return $this->getData(self::CONTENT);
    }

getContentHeading()

getContentHeading

(

)

Get content heading

Returns

string

Implements PageInterface.

Definition at line 215 of file Page.php.

    {
        return $this->getData(self::CONTENT_HEADING);
    }

getCreationTime()

getCreationTime

(

)

Get creation time

Returns

string

Implements PageInterface.

Definition at line 235 of file Page.php.

    {
        return $this->getData(self::CREATION_TIME);
    }

getCustomLayoutUpdateXml()

getCustomLayoutUpdateXml

(

)

Get custom layout update xml

Returns

string

Implements PageInterface.

Definition at line 295 of file Page.php.

    {
        return $this->getData(self::CUSTOM_LAYOUT_UPDATE_XML);
    }

getCustomRootTemplate()

getCustomRootTemplate

(

)

Get custom root template

Returns

string

Implements PageInterface.

Definition at line 285 of file Page.php.

    {
        return $this->getData(self::CUSTOM_ROOT_TEMPLATE);
    }

getCustomTheme()

getCustomTheme

(

)

Get custom theme

Returns

string

Implements PageInterface.

Definition at line 275 of file Page.php.

    {
        return $this->getData(self::CUSTOM_THEME);
    }

getCustomThemeFrom()

getCustomThemeFrom

(

)

Get custom theme from

Returns

string

Implements PageInterface.

Definition at line 305 of file Page.php.

    {
        return $this->getData(self::CUSTOM_THEME_FROM);
    }

getCustomThemeTo()

getCustomThemeTo

(

)

Get custom theme to

Returns

string

Implements PageInterface.

Definition at line 315 of file Page.php.

    {
        return $this->getData(self::CUSTOM_THEME_TO);
    }

getId()

getId

(

)

Get ID

Returns

int

Implements PageInterface.

Definition at line 144 of file Page.php.

    {
        return parent::getData(self::PAGE_ID);
    }

getIdentifier()

getIdentifier

(

)

Get identifier

Returns

string

Implements PageInterface.

Definition at line 154 of file Page.php.

    {
        return $this->getData(self::IDENTIFIER);
    }

getIdentities()

getIdentities

(

)

Get identities

Returns

array

Implements IdentityInterface.

Definition at line 134 of file Page.php.

    {
        return [self::CACHE_TAG . '_' . $this->getId()];
    }

getLayoutUpdateXml()

getLayoutUpdateXml

(

)

Get layout update xml

Returns

string

Implements PageInterface.

Definition at line 265 of file Page.php.

    {
        return $this->getData(self::LAYOUT_UPDATE_XML);
    }

getMetaDescription()

getMetaDescription

(

)

Get meta description

Returns

string

Implements PageInterface.

Definition at line 205 of file Page.php.

    {
        return $this->getData(self::META_DESCRIPTION);
    }

getMetaKeywords()

getMetaKeywords

(

)

Get meta keywords

Returns

string

Implements PageInterface.

Definition at line 195 of file Page.php.

    {
        return $this->getData(self::META_KEYWORDS);
    }

getMetaTitle()

getMetaTitle

(

)

Get meta title

Returns

string|null

Since

101.0.0

Implements PageInterface.

Definition at line 185 of file Page.php.

    {
        return $this->getData(self::META_TITLE);
    }

getPageLayout()

getPageLayout

(

)

Get page layout

Returns

string

Implements PageInterface.

Definition at line 174 of file Page.php.

    {
        return $this->getData(self::PAGE_LAYOUT);
    }

getSortOrder()

getSortOrder

(

)

Get sort order

Returns

string

Implements PageInterface.

Definition at line 255 of file Page.php.

    {
        return $this->getData(self::SORT_ORDER);
    }

getStores()

getStores

(

)

Receive page store ids

Returns

int[]

Definition at line 100 of file Page.php.

    {
        return $this->hasData('stores') ? $this->getData('stores') : (array)$this->getData('store_id');
    }

getTitle()

getTitle

(

)

Get title

Returns

string

Implements PageInterface.

Definition at line 164 of file Page.php.

    {
        return $this->getData(self::TITLE);
    }

getUpdateTime()

getUpdateTime

(

)

Get update time

Returns

string

Implements PageInterface.

Definition at line 245 of file Page.php.

    {
        return $this->getData(self::UPDATE_TIME);
    }

isActive()

isActive

(

)

Is active

Returns

bool

Implements PageInterface.

Definition at line 325 of file Page.php.

    {
        return (bool)$this->getData(self::IS_ACTIVE);
    }

load()

load	(		$id,
			$field = null
	)

Load object data

Parameters

int | null	$id
string	$field

Returns

$this

Definition at line 77 of file Page.php.

    {
        if ($id === null) {
            return $this->noRoutePage();
        }
        return parent::load($id, $field);
    }

noRoutePage()

noRoutePage

(

)

Load No-Route Page

Returns

\Magento\Cms\Model\Page

Definition at line 90 of file Page.php.

    {
        return $this->load(self::NOROUTE_PAGE_ID, $this->getIdFieldName());
    }

setContent()

setContent

(

$content

)

Set content

Parameters

string

$content

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 425 of file Page.php.

    {
        return $this->setData(self::CONTENT, $content);
    }

setContentHeading()

setContentHeading

(

$contentHeading

)

Set content heading

Parameters

string

$contentHeading

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 414 of file Page.php.

    {
        return $this->setData(self::CONTENT_HEADING, $contentHeading);
    }

setCreationTime()

setCreationTime

(

$creationTime

)

Set creation time

Parameters

string

$creationTime

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 436 of file Page.php.

    {
        return $this->setData(self::CREATION_TIME, $creationTime);
    }

setCustomLayoutUpdateXml()

setCustomLayoutUpdateXml

(

$customLayoutUpdateXml

)

Set custom layout update xml

Parameters

string

$customLayoutUpdateXml

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 502 of file Page.php.

    {
        return $this->setData(self::CUSTOM_LAYOUT_UPDATE_XML, $customLayoutUpdateXml);
    }

setCustomRootTemplate()

setCustomRootTemplate

(

$customRootTemplate

)

Set custom root template

Parameters

string

$customRootTemplate

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 491 of file Page.php.

    {
        return $this->setData(self::CUSTOM_ROOT_TEMPLATE, $customRootTemplate);
    }

setCustomTheme()

setCustomTheme

(

$customTheme

)

Set custom theme

Parameters

string

$customTheme

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 480 of file Page.php.

    {
        return $this->setData(self::CUSTOM_THEME, $customTheme);
    }

setCustomThemeFrom()

setCustomThemeFrom

(

$customThemeFrom

)

Set custom theme from

Parameters

string

$customThemeFrom

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 513 of file Page.php.

    {
        return $this->setData(self::CUSTOM_THEME_FROM, $customThemeFrom);
    }

setCustomThemeTo()

setCustomThemeTo

(

$customThemeTo

)

Set custom theme to

Parameters

string

$customThemeTo

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 524 of file Page.php.

    {
        return $this->setData(self::CUSTOM_THEME_TO, $customThemeTo);
    }

setId()

setId

(

$id

)

Set ID

Parameters

int

$id

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 336 of file Page.php.

    {
        return $this->setData(self::PAGE_ID, $id);
    }

setIdentifier()

setIdentifier

(

$identifier

)

Set identifier

Parameters

string

$identifier

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 347 of file Page.php.

    {
        return $this->setData(self::IDENTIFIER, $identifier);
    }

setIsActive()

setIsActive

(

$isActive

)

Set is active

Parameters

int | bool

$isActive

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 535 of file Page.php.

    {
        return $this->setData(self::IS_ACTIVE, $isActive);
    }

setLayoutUpdateXml()

setLayoutUpdateXml

(

$layoutUpdateXml

)

Set layout update xml

Parameters

string

$layoutUpdateXml

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 469 of file Page.php.

    {
        return $this->setData(self::LAYOUT_UPDATE_XML, $layoutUpdateXml);
    }

setMetaDescription()

setMetaDescription

(

$metaDescription

)

Set meta description

Parameters

string

$metaDescription

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 403 of file Page.php.

    {
        return $this->setData(self::META_DESCRIPTION, $metaDescription);
    }

setMetaKeywords()

setMetaKeywords

(

$metaKeywords

)

Set meta keywords

Parameters

string

$metaKeywords

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 392 of file Page.php.

    {
        return $this->setData(self::META_KEYWORDS, $metaKeywords);
    }

setMetaTitle()

setMetaTitle

(

$metaTitle

)

Set meta title

Parameters

string

$metaTitle

Returns

\Magento\Cms\Api\Data\PageInterface

Since

101.0.0

Implements PageInterface.

Definition at line 381 of file Page.php.

    {
        return $this->setData(self::META_TITLE, $metaTitle);
    }

setPageLayout()

setPageLayout

(

$pageLayout

)

Set page layout

Parameters

string

$pageLayout

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 369 of file Page.php.

    {
        return $this->setData(self::PAGE_LAYOUT, $pageLayout);
    }

setSortOrder()

setSortOrder

(

$sortOrder

)

Set sort order

Parameters

string

$sortOrder

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 458 of file Page.php.

    {
        return $this->setData(self::SORT_ORDER, $sortOrder);
    }

setTitle()

setTitle

(

$title

)

Set title

Parameters

string

$title

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 358 of file Page.php.

    {
        return $this->setData(self::TITLE, $title);
    }

setUpdateTime()

setUpdateTime

(

$updateTime

)

Set update time

Parameters

string

$updateTime

Returns

\Magento\Cms\Api\Data\PageInterface

Implements PageInterface.

Definition at line 447 of file Page.php.

    {
        return $this->setData(self::UPDATE_TIME, $updateTime);
    }

Field Documentation

$_cacheTag

$_cacheTag = self::CACHE_TAG

protected

Definition at line 46 of file Page.php.

$_eventPrefix

$_eventPrefix = 'cms_page'

protected

Definition at line 53 of file Page.php.

CACHE_TAG

const CACHE_TAG = 'cms_p'

#- CMS page cache tag

Definition at line 41 of file Page.php.

NOROUTE_PAGE_ID

const NOROUTE_PAGE_ID = 'no-route'

No route page id

Definition at line 29 of file Page.php.

STATUS_DISABLED

const STATUS_DISABLED = 0

Definition at line 35 of file Page.php.

STATUS_ENABLED

const STATUS_ENABLED = 1

#+ Page's Statuses

Definition at line 34 of file Page.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-cms/Model/Page.php