Public Member Functions
	__construct (View\Asset\Repository $assetRepo, View\Asset\GroupedCollection $pageAssets, App\Config\ScopeConfigInterface $scopeConfig, View\Page\FaviconInterface $favicon, Title $title, \Magento\Framework\Locale\ResolverInterface $localeResolver, $isIncludesAvailable=true)

	setBuilder (View\Layout\BuilderInterface $builder)

	publicBuild ()

	getTitle ()

	setMetadata ($name, $content)

	getMetadata ()

	setContentType ($contentType)

	getContentType ()

	setMediaType ($mediaType)

	getMediaType ()

	setCharset ($charset)

	getCharset ()

	setDescription ($description)

	getDescription ()

	setMetaTitle ($title)

	getMetaTitle ()

	setKeywords ($keywords)

	getKeywords ()

	setRobots ($robots)

	getRobots ()

	getAssetCollection ()

	addPageAsset ($file, array $properties=[], $name=null)

	addRemotePageAsset ($url, $contentType, array $properties=[], $name=null)

	addRss ($title, $href)

	addBodyClass ($className)

	setElementAttribute ($elementType, $attribute, $value)

	getElementAttribute ($elementType, $attribute)

	getElementAttributes ($elementType)

	setPageLayout ($handle)

	getPageLayout ()

	getFaviconFile ()

	getDefaultFavicon ()

	getIncludes ()

Data Fields
const	ELEMENT_TYPE_BODY = 'body'

const	ELEMENT_TYPE_HTML = 'html'

const	ELEMENT_TYPE_HEAD = 'head'

const	META_DESCRIPTION = 'description'

const	META_CONTENT_TYPE = 'content_type'

const	META_MEDIA_TYPE = 'media_type'

const	META_CHARSET = 'charset'

const	META_TITLE = 'title'

const	META_KEYWORDS = 'keywords'

const	META_ROBOTS = 'robots'

const	META_X_UI_COMPATIBLE = 'x_ua_compatible'

const	BODY_ATTRIBUTE_CLASS = 'class'

const	HTML_ATTRIBUTE_LANG = 'lang'

Protected Member Functions
	build ()

Protected Attributes
	$allowedTypes

	$title

	$assetRepo

	$pageAssets

	$elements = []

	$pageLayout

	$scopeConfig

	$favicon

	$localeResolver

	$builder

	$includes

	$metadata

Detailed Description

An API for page configuration

Has methods for managing properties specific to web pages:

title
related documents, linked static assets in particular
meta info
root element properties
etc...

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields)

@api

Since: 100.0.2

Definition at line 29 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	View\Asset\Repository	$assetRepo,
		View\Asset\GroupedCollection	$pageAssets,
		App\Config\ScopeConfigInterface	$scopeConfig,
		View\Page\FaviconInterface	$favicon,
		Title	$title,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
			$isIncludesAvailable = `true`
	)

Parameters

\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Framework\View\Asset\GroupedCollection	$pageAssets
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\View\Page\FaviconInterface	$favicon
Title	$title
\Magento\Framework\Locale\ResolverInterface	$localeResolver
bool	$isIncludesAvailable

Definition at line 169 of file Config.php.

       {
         $this->assetRepo = $assetRepo;
         $this->pageAssets = $pageAssets;
         $this->scopeConfig = $scopeConfig;
         $this->favicon = $favicon;
         $this->title = $title;
         $this->localeResolver = $localeResolver;
         $this->isIncludesAvailable = $isIncludesAvailable;
         $this->setElementAttribute(
             self::ELEMENT_TYPE_HTML,
             self::HTML_ATTRIBUTE_LANG,
             strstr($this->localeResolver->getLocale(), '_', true)
         );
     }

Member Function Documentation

◆ addBodyClass()

addBodyClass ( $className )

Add CSS class to page body tag

Parameters

string $className

Returns: $this

Definition at line 530 of file Config.php.

     {
         $className = preg_replace('#[^a-z0-9-_]+#', '-', strtolower($className));
         $bodyClasses = $this->getElementAttribute(self::ELEMENT_TYPE_BODY, self::BODY_ATTRIBUTE_CLASS);
         $bodyClasses = $bodyClasses ? explode(' ', $bodyClasses) : [];
         $bodyClasses[] = $className;
         $bodyClasses = array_unique($bodyClasses);
         $this->setElementAttribute(
             self::ELEMENT_TYPE_BODY,
             self::BODY_ATTRIBUTE_CLASS,
             implode(' ', $bodyClasses)
         );
         return $this;
     }

◆ addPageAsset()

addPageAsset	(		$file,
		array	$properties = `[]`,
			$name = `null`
	)

Add asset to page content

Parameters

string	$file
array	$properties
string \| null	$name

Returns: $this

Definition at line 478 of file Config.php.

     {
         $asset = $this->assetRepo->createAsset($file);
         $name = $name ?: $file;
         $this->pageAssets->add($name, $asset, $properties);
 
         return $this;
     }

◆ addRemotePageAsset()

addRemotePageAsset	(		$url,
			$contentType,
		array	$properties = `[]`,
			$name = `null`
	)

Add remote page asset

Parameters

string	$url
string	$contentType
array	$properties
string \| null	$name

Returns: $this

Definition at line 496 of file Config.php.

     {
         $remoteAsset = $this->assetRepo->createRemoteAsset($url, $contentType);
         $name = $name ?: $url;
         $this->pageAssets->add($name, $remoteAsset, $properties);
 
         return $this;
     }

◆ addRss()

addRss	(	$title,
		$href
	)

Add RSS element

Parameters

string	$title
string	$href

Returns: $this

Definition at line 512 of file Config.php.

     {
         $remoteAsset = $this->assetRepo->createRemoteAsset((string)$href, 'unknown');
         $this->pageAssets->add(
             "link/{$href}",
             $remoteAsset,
             ['attributes' => 'rel="alternate" type="application/rss+xml" title="' . $title . '"']
         );
 
         return $this;
     }

◆ build()

build ( )

protected

Build page config from page configurations

Returns: void

Definition at line 209 of file Config.php.

     {
         if (!empty($this->builder)) {
             $this->builder->build();
         }
     }

◆ getAssetCollection()

getAssetCollection ( )

Returns collection of the assets

Returns: \Magento\Framework\View\Asset\GroupedCollection

Definition at line 464 of file Config.php.

     {
         $this->build();
         return $this->pageAssets;
     }

◆ getCharset()

getCharset ( )

Retrieve Charset

Returns: string

Definition at line 332 of file Config.php.

     {
         $this->build();
         if (empty($this->metadata[self::META_CHARSET])) {
             $this->metadata[self::META_CHARSET] = $this->scopeConfig->getValue(
                 'design/head/default_charset',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->metadata[self::META_CHARSET];
     }

◆ getContentType()

getContentType ( )

Retrieve Content Type

Returns: string

Definition at line 279 of file Config.php.

     {
         $this->build();
         if (strtolower($this->metadata[self::META_CONTENT_TYPE]) === 'auto') {
             $this->metadata[self::META_CONTENT_TYPE] = $this->getMediaType() . '; charset=' . $this->getCharset();
         }
         return $this->metadata[self::META_CONTENT_TYPE];
     }

◆ getDefaultFavicon()

getDefaultFavicon ( )

Returns default favicon

Returns: string

Definition at line 628 of file Config.php.

     {
         return $this->favicon->getDefaultFavicon();
     }

◆ getDescription()

getDescription ( )

Retrieve content for description tag

Returns: string

Definition at line 360 of file Config.php.

     {
         $this->build();
         if (empty($this->metadata[self::META_DESCRIPTION])) {
             $this->metadata[self::META_DESCRIPTION] = $this->scopeConfig->getValue(
                 'design/head/default_description',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->metadata[self::META_DESCRIPTION];
     }

◆ getElementAttribute()

getElementAttribute	(	$elementType,
		$attribute
	)

Retrieve additional element attribute

Parameters

string	$elementType
string	$attribute

Returns: null

Definition at line 573 of file Config.php.

     {
         $this->build();
         return $this->elements[$elementType][$attribute] ?? null;
     }

◆ getElementAttributes()

getElementAttributes ( $elementType )

Returns element attributes

Parameters

string $elementType

Returns: string[]

Definition at line 585 of file Config.php.

     {
         $this->build();
         return $this->elements[$elementType] ?? [];
     }

◆ getFaviconFile()

getFaviconFile ( )

Returns favicon file

Returns: string

Definition at line 618 of file Config.php.

     {
         return $this->favicon->getFaviconFile();
     }

◆ getIncludes()

getIncludes ( )

Get miscellaneous scripts/styles to be included in head before head closing tag

Returns: string

Definition at line 638 of file Config.php.

     {
         if (empty($this->includes) && $this->isIncludesAvailable) {
             $this->includes = $this->scopeConfig->getValue(
                 'design/head/includes',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->includes;
     }

◆ getKeywords()

getKeywords ( )

Retrieve content for keywords tag

Returns: string

Definition at line 415 of file Config.php.

     {
         $this->build();
         if (empty($this->metadata[self::META_KEYWORDS])) {
             $this->metadata[self::META_KEYWORDS] = $this->scopeConfig->getValue(
                 'design/head/default_keywords',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->metadata[self::META_KEYWORDS];
     }

◆ getMediaType()

getMediaType ( )

Retrieve Media Type

Returns: string

Definition at line 304 of file Config.php.

     {
         $this->build();
         if (empty($this->metadata[self::META_MEDIA_TYPE])) {
             $this->metadata[self::META_MEDIA_TYPE] = $this->scopeConfig->getValue(
                 'design/head/default_media_type',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->metadata[self::META_MEDIA_TYPE];
     }

◆ getMetadata()

getMetadata ( )

Returns metadata

Returns: array

Definition at line 257 of file Config.php.

     {
         $this->build();
         return $this->metadata;
     }

◆ getMetaTitle()

getMetaTitle ( )

Retrieve meta title

Returns: string

Since: 101.0.6

Definition at line 389 of file Config.php.

     {
         $this->build();
         if (empty($this->metadata[self::META_TITLE])) {
             return '';
         }
 
         return $this->metadata[self::META_TITLE];
     }

◆ getPageLayout()

getPageLayout ( )

Return current page layout

Returns: string

Definition at line 608 of file Config.php.

     {
         return $this->pageLayout;
     }

◆ getRobots()

getRobots ( )

Retrieve URL to robots file

Returns: string

Exceptions

Definition at line 444 of file Config.php.

     {
         if ($this->getAreaResolver()->getAreaCode() !== Area::AREA_FRONTEND) {
             return 'NOINDEX,NOFOLLOW';
         }
         $this->build();
         if (empty($this->metadata[self::META_ROBOTS])) {
             $this->metadata[self::META_ROBOTS] = $this->scopeConfig->getValue(
                 'design/search_engine_robots/default_robots',
                 \Magento\Store\Model\ScopeInterface::SCOPE_STORE
             );
         }
         return $this->metadata[self::META_ROBOTS];
     }

◆ getTitle()

getTitle ( )

Retrieve title element text (encoded)

Returns: Title

Definition at line 233 of file Config.php.

     {
         $this->build();
         return $this->title;
     }

◆ publicBuild()

publicBuild ( )

Public build action

TODO Will be eliminated in MAGETWO-28359

Returns: void

Definition at line 223 of file Config.php.

     {
         $this->build();
     }

◆ setBuilder()

setBuilder ( View\Layout\BuilderInterface $builder )

Set builder.

Parameters

View\Layout\BuilderInterface $builder

Returns: $this

Definition at line 198 of file Config.php.

     {
         $this->builder = $builder;
         return $this;
     }

◆ setCharset()

setCharset ( $charset )

Set charset

Parameters

string $charset

Returns: void

Definition at line 322 of file Config.php.

     {
         $this->setMetadata(self::META_CHARSET, $charset);
     }

◆ setContentType()

setContentType ( $contentType )

Set content type

Parameters

string $contentType

Returns: void

Definition at line 269 of file Config.php.

     {
         $this->setMetadata(self::META_CONTENT_TYPE, $contentType);
     }

◆ setDescription()

setDescription ( $description )

Set description

Parameters

string $description

Returns: void

Definition at line 350 of file Config.php.

     {
         $this->setMetadata(self::META_DESCRIPTION, $description);
     }

◆ setElementAttribute()

setElementAttribute	(	$elementType,
		$attribute,
		$value
	)

Set additional element attribute

Parameters

string	$elementType
string	$attribute
mixed	$value

Returns: $this

Exceptions

Definition at line 554 of file Config.php.

     {
         $this->build();
         if (array_search($elementType, $this->allowedTypes) === false) {
             throw new \Magento\Framework\Exception\LocalizedException(
                 new \Magento\Framework\Phrase('%1 isn\'t allowed', [$elementType])
             );
         }
         $this->elements[$elementType][$attribute] = $value;
         return $this;
     }

◆ setKeywords()

setKeywords ( $keywords )

Set keywords

Parameters

string $keywords

Returns: void

Definition at line 405 of file Config.php.

     {
         $this->setMetadata(self::META_KEYWORDS, $keywords);
     }

◆ setMediaType()

setMediaType ( $mediaType )

Set media type

Parameters

string $mediaType

Returns: void

Definition at line 294 of file Config.php.

     {
         $this->setMetadata(self::META_MEDIA_TYPE, $mediaType);
     }

◆ setMetadata()

setMetadata	(	$name,
		$content
	)

Set metadata.

Parameters

string	$name
string	$content

Returns: void

Definition at line 246 of file Config.php.

     {
         $this->build();
         $this->metadata[$name] = htmlspecialchars($content);
     }

◆ setMetaTitle()

setMetaTitle ( $title )

Set meta title

Parameters

string $title

Since: 101.0.6

Definition at line 378 of file Config.php.

     {
         $this->setMetadata(self::META_TITLE, $title);
     }

◆ setPageLayout()

setPageLayout ( $handle )

Set page layout

Parameters

string $handle

Returns: $this

Definition at line 597 of file Config.php.

     {
         $this->pageLayout = $handle;
         return $this;
     }

◆ setRobots()

setRobots ( $robots )

Set robots content

Parameters

string $robots

Returns: void

Definition at line 433 of file Config.php.

     {
         $this->setMetadata(self::META_ROBOTS, $robots);
     }

Field Documentation

◆ $allowedTypes

$allowedTypes

protected

Initial value:

= [
        self::ELEMENT_TYPE_BODY,
        self::ELEMENT_TYPE_HTML,
        self::ELEMENT_TYPE_HEAD,
    ]

Definition at line 63 of file Config.php.

◆ $assetRepo

$assetRepo

protected

Definition at line 79 of file Config.php.

◆ $builder

$builder

protected

Definition at line 114 of file Config.php.

◆ $elements

$elements = []

protected

Definition at line 89 of file Config.php.

◆ $favicon

$favicon

protected

Definition at line 104 of file Config.php.

◆ $includes

$includes

protected

Definition at line 119 of file Config.php.

◆ $localeResolver

$localeResolver

protected

Definition at line 109 of file Config.php.

◆ $metadata

$metadata

protected

Initial value:

= [
        'charset' => null,
        'media_type' => null,
        'content_type' => null,
        'description' => null,
        'keywords' => null,
        'robots' => null,
        'title' => null,
    ]

Definition at line 124 of file Config.php.

◆ $pageAssets

$pageAssets

protected

Definition at line 84 of file Config.php.

◆ $pageLayout

$pageLayout

protected

Definition at line 94 of file Config.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 99 of file Config.php.

◆ $title

$title

protected

Definition at line 72 of file Config.php.

◆ BODY_ATTRIBUTE_CLASS

const BODY_ATTRIBUTE_CLASS = 'class'

Constant body attribute class

Definition at line 51 of file Config.php.

◆ ELEMENT_TYPE_BODY

const ELEMENT_TYPE_BODY = 'body'

#+ Constants of available types

Definition at line 34 of file Config.php.

◆ ELEMENT_TYPE_HEAD

const ELEMENT_TYPE_HEAD = 'head'

Definition at line 36 of file Config.php.

◆ ELEMENT_TYPE_HTML

const ELEMENT_TYPE_HTML = 'html'

Definition at line 35 of file Config.php.

◆ HTML_ATTRIBUTE_LANG

const HTML_ATTRIBUTE_LANG = 'lang'

Constant html language attribute

Definition at line 56 of file Config.php.

◆ META_CHARSET

const META_CHARSET = 'charset'

Definition at line 42 of file Config.php.

◆ META_CONTENT_TYPE

const META_CONTENT_TYPE = 'content_type'

Definition at line 40 of file Config.php.

◆ META_DESCRIPTION

const META_DESCRIPTION = 'description'

#-

Definition at line 39 of file Config.php.

◆ META_KEYWORDS

const META_KEYWORDS = 'keywords'

Definition at line 44 of file Config.php.

◆ META_MEDIA_TYPE

const META_MEDIA_TYPE = 'media_type'

Definition at line 41 of file Config.php.

◆ META_ROBOTS

const META_ROBOTS = 'robots'

Definition at line 45 of file Config.php.

◆ META_TITLE

const META_TITLE = 'title'

Definition at line 43 of file Config.php.

◆ META_X_UI_COMPATIBLE

const META_X_UI_COMPATIBLE = 'x_ua_compatible'

Definition at line 46 of file Config.php.

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

vendor/magento/framework/View/Page/Config.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBodyClass()

◆ addPageAsset()

◆ addRemotePageAsset()

◆ addRss()

◆ build()

◆ getAssetCollection()

◆ getCharset()

◆ getContentType()

◆ getDefaultFavicon()

◆ getDescription()

◆ getElementAttribute()

◆ getElementAttributes()

◆ getFaviconFile()

◆ getIncludes()

◆ getKeywords()

◆ getMediaType()

◆ getMetadata()

◆ getMetaTitle()

◆ getPageLayout()

◆ getRobots()

◆ getTitle()

◆ publicBuild()

◆ setBuilder()

◆ setCharset()

◆ setContentType()

◆ setDescription()

◆ setElementAttribute()

◆ setKeywords()

◆ setMediaType()

◆ setMetadata()

◆ setMetaTitle()

◆ setPageLayout()

◆ setRobots()

Field Documentation

◆ $allowedTypes

◆ $assetRepo

◆ $builder

◆ $elements

◆ $favicon

◆ $includes

◆ $localeResolver

◆ $metadata

◆ $pageAssets

◆ $pageLayout

◆ $scopeConfig

◆ $title

◆ BODY_ATTRIBUTE_CLASS

◆ ELEMENT_TYPE_BODY

◆ ELEMENT_TYPE_HEAD

◆ ELEMENT_TYPE_HTML

◆ HTML_ATTRIBUTE_LANG

◆ META_CHARSET

◆ META_CONTENT_TYPE

◆ META_DESCRIPTION

◆ META_KEYWORDS

◆ META_MEDIA_TYPE

◆ META_ROBOTS

◆ META_TITLE

◆ META_X_UI_COMPATIBLE