Inheritance diagram for Page:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Context $context, \Magento\Cms\Model\Page $page, \Magento\Cms\Model\Template\FilterProvider $filterProvider, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Cms\Model\PageFactory $pageFactory, \Magento\Framework\View\Page\Config $pageConfig, array $data=[])

	getIdentities ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

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)

Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_prepareLayout ()

	_addBreadcrumbs (\Magento\Cms\Model\Page $page)

	_toHtml ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_filterProvider

	$_page

	$_storeManager

	$_pageFactory

	$pageConfig

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

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

Detailed Description

Cms page content block

@api

Since: 100.0.2

Definition at line 16 of file Page.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Context	$context,
		\Magento\Cms\Model\Page	$page,
		\Magento\Cms\Model\Template\FilterProvider	$filterProvider,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Cms\Model\PageFactory	$pageFactory,
		\Magento\Framework\View\Page\Config	$pageConfig,
		array	$data = `[]`
	)

Construct

Parameters

\Magento\Framework\View\Element\Context	$context
\Magento\Cms\Model\Page	$page
\Magento\Cms\Model\Template\FilterProvider	$filterProvider
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Cms\Model\PageFactory	$pageFactory
\Magento\Framework\View\Page\Config	$pageConfig
array	$data

Definition at line 59 of file Page.php.

       {
         parent::__construct($context, $data);
         // used singleton (instead factory) because there exist dependencies on \Magento\Cms\Helper\Page
         $this->_page = $page;
         $this->_filterProvider = $filterProvider;
         $this->_storeManager = $storeManager;
         $this->_pageFactory = $pageFactory;
         $this->pageConfig = $pageConfig;
     }

Member Function Documentation

◆ _addBreadcrumbs()

_addBreadcrumbs ( \Magento\Cms\Model\Page $page )

protected

Prepare breadcrumbs

Parameters

\Magento\Cms\Model\Page $page

Exceptions

Definition at line 128 of file Page.php.

     {
         $homePageIdentifier = $this->_scopeConfig->getValue(
             'web/default/cms_home_page',
             ScopeInterface::SCOPE_STORE
         );
         $homePageDelimiterPosition = strrpos($homePageIdentifier, '|');
         if ($homePageDelimiterPosition) {
             $homePageIdentifier = substr($homePageIdentifier, 0, $homePageDelimiterPosition);
         }
         $noRouteIdentifier = $this->_scopeConfig->getValue(
             'web/default/cms_no_route',
             ScopeInterface::SCOPE_STORE
         );
         $noRouteDelimiterPosition = strrpos($noRouteIdentifier, '|');
         if ($noRouteDelimiterPosition) {
             $noRouteIdentifier = substr($noRouteIdentifier, 0, $noRouteDelimiterPosition);
         }
         if ($this->_scopeConfig->getValue('web/default/show_cms_breadcrumbs', ScopeInterface::SCOPE_STORE)
             && ($breadcrumbsBlock = $this->getLayout()->getBlock('breadcrumbs'))
             && $page->getIdentifier() !== $homePageIdentifier
             && $page->getIdentifier() !== $noRouteIdentifier
         ) {
             $breadcrumbsBlock->addCrumb(
                 'home',
                 [
                     'label' => __('Home'),
                     'title' => __('Go to Home Page'),
                     'link' => $this->_storeManager->getStore()->getBaseUrl()
                 ]
             );
             $breadcrumbsBlock->addCrumb('cms_page', ['label' => $page->getTitle(), 'title' => $page->getTitle()]);
         }
     }

◆ _prepareLayout()

_prepareLayout ( )

protected

Prepare global layout

Returns: $this

Definition at line 102 of file Page.php.

     {
         $page = $this->getPage();
         $this->_addBreadcrumbs($page);
         $this->pageConfig->addBodyClass('cms-' . $page->getIdentifier());
         $metaTitle = $page->getMetaTitle();
         $this->pageConfig->getTitle()->set($metaTitle ? $metaTitle : $page->getTitle());
         $this->pageConfig->setKeywords($page->getMetaKeywords());
         $this->pageConfig->setDescription($page->getMetaDescription());
 
         $pageMainTitle = $this->getLayout()->getBlock('page.main.title');
         if ($pageMainTitle) {
             // Setting empty page title if content heading is absent
             $cmsTitle = $page->getContentHeading() ?: ' ';
             $pageMainTitle->setPageTitle($this->escapeHtml($cmsTitle));
         }
         return parent::_prepareLayout();
     }

◆ _toHtml()

_toHtml ( )

protected

Prepare HTML content

Returns: string

Definition at line 168 of file Page.php.

     {
         $html = $this->_filterProvider->getPageFilter()->filter($this->getPage()->getContent());
         return $html;
     }

◆ getIdentities()

getIdentities ( )

Return identifiers for produced content

Returns: array

Implements IdentityInterface.

Definition at line 179 of file Page.php.

     {
         return [\Magento\Cms\Model\Page::CACHE_TAG . '_' . $this->getPage()->getId()];
     }

Field Documentation

◆ $_filterProvider

$_filterProvider

protected

Definition at line 22 of file Page.php.

◆ $_page

$_page

protected

Definition at line 27 of file Page.php.

◆ $_pageFactory

$_pageFactory

protected

Definition at line 41 of file Page.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 34 of file Page.php.

◆ $pageConfig

$pageConfig

protected

Definition at line 46 of file Page.php.

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

vendor/magento/module-cms/Block/Page.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addBreadcrumbs()

◆ _prepareLayout()

◆ _toHtml()

◆ getIdentities()

Field Documentation

◆ $_filterProvider

◆ $_page

◆ $_pageFactory

◆ $_storeManager

◆ $pageConfig