/
Config.php
664 lines (604 loc) · 15.7 KB
/
Config.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
<?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 ??= '';
}
}