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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Design\Theme;
/**
* Theme customizations manager
*/
class Customization implements CustomizationInterface
{
/**
* File provider
*
* @var \Magento\Framework\View\Design\Theme\FileProviderInterface
*/
protected $fileProvider;
/**
* Theme customization path
*
* @var \Magento\Framework\View\Design\Theme\Customization\Path
*/
protected $customizationPath;
/**
* Theme
*
* @var \Magento\Framework\View\Design\ThemeInterface
*/
protected $theme;
/**
* Theme files
*
* @var \Magento\Framework\View\Design\Theme\FileInterface[]
*/
protected $themeFiles;
/**
* Theme files by type
*
* @var \Magento\Framework\View\Design\Theme\FileInterface[]
*/
protected $themeFilesByType = [];
/**
* Constructor
*
* @param \Magento\Framework\View\Design\Theme\FileProviderInterface $fileProvider
* @param \Magento\Framework\View\Design\Theme\Customization\Path $customizationPath
* @param \Magento\Framework\View\Design\ThemeInterface $theme
*/
public function __construct(
\Magento\Framework\View\Design\Theme\FileProviderInterface $fileProvider,
\Magento\Framework\View\Design\Theme\Customization\Path $customizationPath,
\Magento\Framework\View\Design\ThemeInterface $theme = null
) {
$this->fileProvider = $fileProvider;
$this->customizationPath = $customizationPath;
$this->theme = $theme;
}
/**
* Retrieve list of files which belong to a theme
*
* @return \Magento\Framework\View\Design\Theme\FileInterface[]
*/
public function getFiles()
{
if (!$this->themeFiles) {
$this->themeFiles = $this->fileProvider->getItems($this->theme);
}
return $this->themeFiles;
}
/**
* Retrieve list of files which belong to a theme only by type
*
* @param string $type
* @return \Magento\Framework\View\Design\Theme\FileInterface[]
*/
public function getFilesByType($type)
{
if (!isset($this->themeFilesByType[$type])) {
$this->themeFilesByType[$type] = $this->fileProvider->getItems($this->theme, ['file_type' => $type]);
}
return $this->themeFilesByType[$type];
}
/**
* Get short file information
*
* @param \Magento\Framework\View\Design\Theme\FileInterface[] $files
* @return array
*/
public function generateFileInfo(array $files)
{
$filesInfo = [];
/** @var $file \Magento\Framework\View\Design\Theme\FileInterface */
foreach ($files as $file) {
if ($file instanceof \Magento\Framework\View\Design\Theme\FileInterface) {
$filesInfo[] = $file->getFileInfo();
}
}
return $filesInfo;
}
/**
* Returns customization absolute path
*
* @return null|string
*/
public function getCustomizationPath()
{
return $this->customizationPath->getCustomizationPath($this->theme);
}
/**
* Get directory where themes files are stored
*
* @return null|string
*/
public function getThemeFilesPath()
{
return $this->theme->isPhysical() ? $this->customizationPath->getThemeFilesPath(
$this->theme
) : $this->customizationPath->getCustomizationPath(
$this->theme
);
}
/**
* Get path to custom view configuration file
*
* @return null|string
*/
public function getCustomViewConfigPath()
{
return $this->customizationPath->getCustomViewConfigPath($this->theme);
}
/**
* Reorder
*
* @param string $type
* @param array $sequence
* @return $this|CustomizationInterface
*/
public function reorder($type, array $sequence)
{
$sortOrderSequence = array_flip(array_values($sequence));
/** @var $file \Magento\Framework\View\Design\Theme\FileInterface */
foreach ($this->getFilesByType($type) as $file) {
if (isset($sortOrderSequence[$file->getId()])) {
$prevSortOrder = $file->getData('sort_order');
$currentSortOrder = $sortOrderSequence[$file->getId()];
if ($prevSortOrder !== $currentSortOrder) {
$file->setData('sort_order', $currentSortOrder);
$file->save();
}
}
}
return $this;
}
/**
* Remove custom files by ids
*
* @param array $fileIds
* @return $this
*/
public function delete(array $fileIds)
{
/** @var $file \Magento\Framework\View\Design\Theme\FileInterface */
foreach ($this->getFiles() as $file) {
if (in_array($file->getId(), $fileIds)) {
$file->delete();
}
}
return $this;
}
}