Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/framework/View/Page/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Page;
use Magento\Framework\App;
use Magento\Framework\App\Area;
use Magento\Framework\View;
use Magento\Framework\Escaper;
use Magento\Framework\App\ObjectManager;
use Magento\Store\Model\ScopeInterface;
/**
* 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
*/
class Config
{
/**#@+
* Constants of available types
*/
public const ELEMENT_TYPE_BODY = 'body';
public const ELEMENT_TYPE_HTML = 'html';
public const ELEMENT_TYPE_HEAD = 'head';
/**#@-*/
public const META_DESCRIPTION = 'description';
public const META_CONTENT_TYPE = 'content_type';
public const META_MEDIA_TYPE = 'media_type';
public const META_CHARSET = 'charset';
public const META_TITLE = 'title';
public const META_KEYWORDS = 'keywords';
public const META_ROBOTS = 'robots';
public const META_X_UI_COMPATIBLE = 'x_ua_compatible';
/**
* Constant body attribute class
*/
public const BODY_ATTRIBUTE_CLASS = 'class';
/**
* Constant html language attribute
*/
public const HTML_ATTRIBUTE_LANG = 'lang';
/**
* @var Escaper
*/
private $escaper;
/**
* Allowed group of types
*
* @var array
*/
protected $allowedTypes = [
self::ELEMENT_TYPE_BODY,
self::ELEMENT_TYPE_HTML,
self::ELEMENT_TYPE_HEAD,
];
/**
* @var Title
*/
protected $title;
/**
* Asset service
*
* @var \Magento\Framework\View\Asset\Repository
*/
protected $assetRepo;
/**
* @var \Magento\Framework\View\Asset\GroupedCollection
*/
protected $pageAssets;
/**
* @var string[][]
*/
protected $elements = [];
/**
* @var string
*/
protected $pageLayout;
/**
* @var \Magento\Framework\App\Config\ScopeConfigInterface
*/
protected $scopeConfig;
/**
* @var \Magento\Framework\View\Page\FaviconInterface
*/
protected $favicon;
/**
* @var \Magento\Framework\Locale\ResolverInterface
*/
protected $localeResolver;
/**
* @var \Magento\Framework\View\Layout\BuilderInterface
*/
protected $builder;
/**
* @var array
*/
protected $includes;
/**
* @var array
*/
protected $metadata = [
'charset' => null,
'media_type' => null,
'content_type' => null,
'title' => null,
'description' => null,
'keywords' => null,
'robots' => null,
];
/**
* @var \Magento\Framework\App\State
*/
private $areaResolver;
/**
* @var bool
*/
private $isIncludesAvailable;
/**
* This getter serves as a workaround to add this dependency to this class without breaking constructor structure.
*
* @return \Magento\Framework\App\State
*
* @deprecated 100.0.7
*/
private function getAreaResolver()
{
if ($this->areaResolver === null) {
// phpcs:ignore Magento2.PHP.AutogeneratedClassNotInConstructor
$this->areaResolver = ObjectManager::getInstance()
->get(\Magento\Framework\App\State::class);
}
return $this->areaResolver;
}
/**
* @param \Magento\Framework\View\Asset\Repository $assetRepo
* @param \Magento\Framework\View\Asset\GroupedCollection $pageAssets
* @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
* @param \Magento\Framework\View\Page\FaviconInterface $favicon
* @param Title $title
* @param \Magento\Framework\Locale\ResolverInterface $localeResolver
* @param bool $isIncludesAvailable
* @param Escaper|null $escaper
*/
public function __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,
Escaper $escaper = null
) {
$this->assetRepo = $assetRepo;
$this->pageAssets = $pageAssets;
$this->scopeConfig = $scopeConfig;
$this->favicon = $favicon;
$this->title = $title;
$this->localeResolver = $localeResolver;
$this->isIncludesAvailable = $isIncludesAvailable;
$locale = $this->localeResolver->getLocale();
$this->setElementAttribute(
self::ELEMENT_TYPE_HTML,
self::HTML_ATTRIBUTE_LANG,
$locale !== null ? strstr($locale, '_', true) : false
);
$this->escaper = $escaper ?? ObjectManager::getInstance()->get(
Escaper::class
);
}
/**
* Set builder.
*
* @param View\Layout\BuilderInterface $builder
* @return $this
*/
public function setBuilder(View\Layout\BuilderInterface $builder)
{
$this->builder = $builder;
return $this;
}
/**
* Build page config from page configurations
*
* @return void
*/
protected function build()
{
if (!empty($this->builder)) {
$this->builder->build();
}
}
/**
* Public build action
*
* TODO Will be eliminated in MAGETWO-28359
*
* @return void
*/
public function publicBuild()
{
$this->build();
}
/**
* Retrieve title element text (encoded)
*
* @return Title
*/
public function getTitle()
{
$this->build();
return $this->title;
}
/**
* Set metadata.
*
* @param string $name
* @param string $content
* @return void
*/
public function setMetadata($name, $content)
{
$this->build();
$this->metadata[$name] = $this->escaper->escapeHtml($content);
}
/**
* Returns metadata
*
* @return array
*/
public function getMetadata()
{
$this->build();
return $this->metadata;
}
/**
* Set content type
*
* @param string $contentType
* @return void
*/
public function setContentType($contentType)
{
$this->setMetadata(self::META_CONTENT_TYPE, $contentType);
}
/**
* Retrieve Content Type
*
* @return string
*/
public function getContentType()
{
$this->build();
if (!empty($this->metadata[self::META_CONTENT_TYPE])
&& 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];
}
/**
* Set media type
*
* @param string $mediaType
* @return void
*/
public function setMediaType($mediaType)
{
$this->setMetadata(self::META_MEDIA_TYPE, $mediaType);
}
/**
* Retrieve Media Type
*
* @return string
*/
public function getMediaType()
{
$this->build();
if (empty($this->metadata[self::META_MEDIA_TYPE])) {
$this->metadata[self::META_MEDIA_TYPE] = $this->scopeConfig->getValue(
'design/head/default_media_type',
ScopeInterface::SCOPE_STORE
);
}
return $this->metadata[self::META_MEDIA_TYPE];
}
/**
* Set charset
*
* @param string $charset
* @return void
*/
public function setCharset($charset)
{
$this->setMetadata(self::META_CHARSET, $charset);
}
/**
* Retrieve Charset
*
* @return string
*/
public function getCharset()
{
$this->build();
if (empty($this->metadata[self::META_CHARSET])) {
$this->metadata[self::META_CHARSET] = $this->scopeConfig->getValue(
'design/head/default_charset',
ScopeInterface::SCOPE_STORE
);
}
return $this->metadata[self::META_CHARSET];
}
/**
* Set description
*
* @param string $description
* @return void
*/
public function setDescription($description)
{
$this->setMetadata(self::META_DESCRIPTION, $description);
}
/**
* Retrieve content for description tag
*
* @return string
*/
public function getDescription()
{
$this->build();
if (empty($this->metadata[self::META_DESCRIPTION])) {
$this->metadata[self::META_DESCRIPTION] = $this->scopeConfig->getValue(
'design/head/default_description',
ScopeInterface::SCOPE_STORE
);
}
return $this->metadata[self::META_DESCRIPTION];
}
/**
* Set meta title
*
* @param string $title
* @since 101.0.6
*/
public function setMetaTitle($title)
{
$this->setMetadata(self::META_TITLE, $title);
}
/**
* Retrieve meta title
*
* @return string
* @since 101.0.6
*/
public function getMetaTitle()
{
$this->build();
if (empty($this->metadata[self::META_TITLE])) {
return '';
}
return $this->metadata[self::META_TITLE];
}
/**
* Set keywords
*
* @param string $keywords
* @return void
*/
public function setKeywords($keywords)
{
$this->setMetadata(self::META_KEYWORDS, $keywords);
}
/**
* Retrieve content for keywords tag
*
* @return string
*/
public function getKeywords()
{
$this->build();
if (empty($this->metadata[self::META_KEYWORDS])) {
$this->metadata[self::META_KEYWORDS] = $this->scopeConfig->getValue(
'design/head/default_keywords',
ScopeInterface::SCOPE_STORE
);
}
return $this->metadata[self::META_KEYWORDS];
}
/**
* Set robots content
*
* @param string $robots
* @return void
*/
public function setRobots($robots)
{
$this->setMetadata(self::META_ROBOTS, $robots);
}
/**
* Retrieve URL to robots file
*
* @return string
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getRobots()
{
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',
ScopeInterface::SCOPE_STORE
);
}
return $this->metadata[self::META_ROBOTS];
}
/**
* Returns collection of the assets
*
* @return \Magento\Framework\View\Asset\GroupedCollection
*/
public function getAssetCollection()
{
$this->build();
return $this->pageAssets;
}
/**
* Add asset to page content
*
* @param string $file
* @param array $properties
* @param string|null $name
* @return $this
*/
public function addPageAsset($file, array $properties = [], $name = null)
{
$asset = $this->assetRepo->createAsset($file);
$name = $name ?: $file;
$this->pageAssets->add($name, $asset, $properties);
return $this;
}
/**
* Add remote page asset
*
* @param string $url
* @param string $contentType
* @param array $properties
* @param string|null $name
* @return $this
*/
public function addRemotePageAsset($url, $contentType, array $properties = [], $name = null)
{
$remoteAsset = $this->assetRepo->createRemoteAsset($url, $contentType);
$name = $name ?: $url;
$this->pageAssets->add($name, $remoteAsset, $properties);
return $this;
}
/**
* Add RSS element
*
* @param string $title
* @param string $href
* @return $this
*/
public function addRss($title, $href)
{
$remoteAsset = $this->assetRepo->createRemoteAsset((string)$href, 'unknown');
$this->pageAssets->add(
"link/{$href}",
$remoteAsset,
['attributes' => 'rel="alternate" type="application/rss+xml" title="' . $title . '"']
);
return $this;
}
/**
* Add CSS class to page body tag
*
* @param string $className
* @return $this
*/
public function addBodyClass($className)
{
$className = preg_replace('#[^a-z0-9-_]+#', '-', strtolower((string)$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;
}
/**
* Set additional element attribute
*
* @param string $elementType
* @param string $attribute
* @param mixed $value
* @return $this
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function setElementAttribute($elementType, $attribute, $value)
{
$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;
}
/**
* Retrieve additional element attribute
*
* @param string $elementType
* @param string $attribute
* @return null
*/
public function getElementAttribute($elementType, $attribute)
{
$this->build();
return $this->elements[$elementType][$attribute] ?? null;
}
/**
* Returns element attributes
*
* @param string $elementType
* @return string[]
*/
public function getElementAttributes($elementType)
{
$this->build();
return $this->elements[$elementType] ?? [];
}
/**
* Set page layout
*
* @param string $handle
* @return $this
*/
public function setPageLayout($handle)
{
$this->pageLayout = $handle;
return $this;
}
/**
* Return current page layout
*
* @return string
*/
public function getPageLayout()
{
return $this->pageLayout;
}
/**
* Returns favicon file
*
* @return string
*/
public function getFaviconFile()
{
return $this->favicon->getFaviconFile();
}
/**
* Returns default favicon
*
* @return string
*/
public function getDefaultFavicon()
{
return $this->favicon->getDefaultFavicon();
}
/**
* Get miscellaneous scripts/styles to be included in head before head closing tag
*
* @return string
*/
public function getIncludes()
{
if ($this->includes === null && $this->isIncludesAvailable) {
$this->includes = $this->scopeConfig->getValue(
'design/head/includes',
\Magento\Store\Model\ScopeInterface::SCOPE_STORE
);
}
return $this->includes ??= '';
}
}