Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
PageInterface Interface Reference
Inheritance diagram for PageInterface:
Page

Public Member Functions

 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)
 

Data Fields

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'
 

Detailed Description

CMS page interface. @api

Since
100.0.2

Definition at line 13 of file PageInterface.php.

Member Function Documentation

◆ getContent()

getContent ( )

Get content

Returns
string|null

Implemented in Page.

◆ getContentHeading()

getContentHeading ( )

Get content heading

Returns
string|null

Implemented in Page.

◆ getCreationTime()

getCreationTime ( )

Get creation time

Returns
string|null

Implemented in Page.

◆ getCustomLayoutUpdateXml()

getCustomLayoutUpdateXml ( )

Get custom layout update xml

Returns
string|null

Implemented in Page.

◆ getCustomRootTemplate()

getCustomRootTemplate ( )

Get custom root template

Returns
string|null

Implemented in Page.

◆ getCustomTheme()

getCustomTheme ( )

Get custom theme

Returns
string|null

Implemented in Page.

◆ getCustomThemeFrom()

getCustomThemeFrom ( )

Get custom theme from

Returns
string|null

Implemented in Page.

◆ getCustomThemeTo()

getCustomThemeTo ( )

Get custom theme to

Returns
string|null

Implemented in Page.

◆ getId()

getId ( )

#- Get ID

Returns
int|null

Implemented in Page.

◆ getIdentifier()

getIdentifier ( )

Get identifier

Returns
string

Implemented in Page.

◆ getLayoutUpdateXml()

getLayoutUpdateXml ( )

Get layout update xml

Returns
string|null

Implemented in Page.

◆ getMetaDescription()

getMetaDescription ( )

Get meta description

Returns
string|null

Implemented in Page.

◆ getMetaKeywords()

getMetaKeywords ( )

Get meta keywords

Returns
string|null

Implemented in Page.

◆ getMetaTitle()

getMetaTitle ( )

Get meta title

Returns
string|null
Since
101.0.0

Implemented in Page.

◆ getPageLayout()

getPageLayout ( )

Get page layout

Returns
string|null

Implemented in Page.

◆ getSortOrder()

getSortOrder ( )

Get sort order

Returns
string|null

Implemented in Page.

◆ getTitle()

getTitle ( )

Get title

Returns
string|null

Implemented in Page.

◆ getUpdateTime()

getUpdateTime ( )

Get update time

Returns
string|null

Implemented in Page.

◆ isActive()

isActive ( )

Is active

Returns
bool|null

Implemented in Page.

◆ setContent()

setContent (   $content)

Set content

Parameters
string$content
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setContentHeading()

setContentHeading (   $contentHeading)

Set content heading

Parameters
string$contentHeading
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCreationTime()

setCreationTime (   $creationTime)

Set creation time

Parameters
string$creationTime
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCustomLayoutUpdateXml()

setCustomLayoutUpdateXml (   $customLayoutUpdateXml)

Set custom layout update xml

Parameters
string$customLayoutUpdateXml
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCustomRootTemplate()

setCustomRootTemplate (   $customRootTemplate)

Set custom root template

Parameters
string$customRootTemplate
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCustomTheme()

setCustomTheme (   $customTheme)

Set custom theme

Parameters
string$customTheme
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCustomThemeFrom()

setCustomThemeFrom (   $customThemeFrom)

Set custom theme from

Parameters
string$customThemeFrom
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setCustomThemeTo()

setCustomThemeTo (   $customThemeTo)

Set custom theme to

Parameters
string$customThemeTo
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setId()

setId (   $id)

Set ID

Parameters
int$id
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setIdentifier()

setIdentifier (   $identifier)

Set identifier

Parameters
string$identifier
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setIsActive()

setIsActive (   $isActive)

Set is active

Parameters
int | bool$isActive
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setLayoutUpdateXml()

setLayoutUpdateXml (   $layoutUpdateXml)

Set layout update xml

Parameters
string$layoutUpdateXml
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setMetaDescription()

setMetaDescription (   $metaDescription)

Set meta description

Parameters
string$metaDescription
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setMetaKeywords()

setMetaKeywords (   $metaKeywords)

Set meta keywords

Parameters
string$metaKeywords
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setMetaTitle()

setMetaTitle (   $metaTitle)

Set meta title

Parameters
string$metaTitle
Returns
\Magento\Cms\Api\Data\PageInterface
Since
101.0.0

Implemented in Page.

◆ setPageLayout()

setPageLayout (   $pageLayout)

Set page layout

Parameters
string$pageLayout
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setSortOrder()

setSortOrder (   $sortOrder)

Set sort order

Parameters
string$sortOrder
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setTitle()

setTitle (   $title)

Set title

Parameters
string$title
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

◆ setUpdateTime()

setUpdateTime (   $updateTime)

Set update time

Parameters
string$updateTime
Returns
\Magento\Cms\Api\Data\PageInterface

Implemented in Page.

Field Documentation

◆ CONTENT

const CONTENT = 'content'

Definition at line 26 of file PageInterface.php.

◆ CONTENT_HEADING

const CONTENT_HEADING = 'content_heading'

Definition at line 25 of file PageInterface.php.

◆ CREATION_TIME

const CREATION_TIME = 'creation_time'

Definition at line 27 of file PageInterface.php.

◆ CUSTOM_LAYOUT_UPDATE_XML

const CUSTOM_LAYOUT_UPDATE_XML = 'custom_layout_update_xml'

Definition at line 33 of file PageInterface.php.

◆ CUSTOM_ROOT_TEMPLATE

const CUSTOM_ROOT_TEMPLATE = 'custom_root_template'

Definition at line 32 of file PageInterface.php.

◆ CUSTOM_THEME

const CUSTOM_THEME = 'custom_theme'

Definition at line 31 of file PageInterface.php.

◆ CUSTOM_THEME_FROM

const CUSTOM_THEME_FROM = 'custom_theme_from'

Definition at line 34 of file PageInterface.php.

◆ CUSTOM_THEME_TO

const CUSTOM_THEME_TO = 'custom_theme_to'

Definition at line 35 of file PageInterface.php.

◆ IDENTIFIER

const IDENTIFIER = 'identifier'

Definition at line 19 of file PageInterface.php.

◆ IS_ACTIVE

const IS_ACTIVE = 'is_active'

Definition at line 36 of file PageInterface.php.

◆ LAYOUT_UPDATE_XML

const LAYOUT_UPDATE_XML = 'layout_update_xml'

Definition at line 30 of file PageInterface.php.

◆ META_DESCRIPTION

const META_DESCRIPTION = 'meta_description'

Definition at line 24 of file PageInterface.php.

◆ META_KEYWORDS

const META_KEYWORDS = 'meta_keywords'

Definition at line 23 of file PageInterface.php.

◆ META_TITLE

const META_TITLE = 'meta_title'

Definition at line 22 of file PageInterface.php.

◆ PAGE_ID

const PAGE_ID = 'page_id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case

Definition at line 18 of file PageInterface.php.

◆ PAGE_LAYOUT

const PAGE_LAYOUT = 'page_layout'

Definition at line 21 of file PageInterface.php.

◆ SORT_ORDER

const SORT_ORDER = 'sort_order'

Definition at line 29 of file PageInterface.php.

◆ TITLE

const TITLE = 'title'

Definition at line 20 of file PageInterface.php.

◆ UPDATE_TIME

const UPDATE_TIME = 'update_time'

Definition at line 28 of file PageInterface.php.


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