/
TemplateFinder.php
214 lines (192 loc) · 5.88 KB
/
TemplateFinder.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
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
*/
/**
* Determine the best existing template.
*
* @since 1.7.0.0
*/
class TemplateFinderCore
{
private $directories;
private $extension;
private $productListEntities = ['category', 'manufacturer', 'supplier'];
private $productListSearchEntities = ['search', 'price-drop', 'best-sale', 'prices-drop', 'best-sales', 'new-products'];
private $productEntities = ['product'];
private $brandListEntities = ['manufacturers', 'suppliers'];
public function __construct(array $directories, $extension)
{
$this->directories = $directories;
$this->extension = $extension;
}
public function getTemplate($template, $entity, $id, $locale)
{
$locale = (Validate::isLocale($locale)) ? $locale : '';
$templates = $this->getTemplateHierarchy($template, $entity, $id);
foreach ($this->directories as $dir) {
foreach ($templates as $tpl) {
if (!empty($locale) && is_file($dir . $locale . DIRECTORY_SEPARATOR . $tpl . $this->extension)) {
return $locale . DIRECTORY_SEPARATOR . $tpl . $this->extension;
}
if (is_file($dir . $tpl . $this->extension)) {
return $tpl . $this->extension;
}
if (is_file($dir . $tpl) && false !== strpos($tpl, $this->extension)) {
return $tpl;
}
}
}
throw new PrestaShopException('No template found for ' . $template);
}
private function getTemplateHierarchy($template, $entity, $id)
{
$entity = basename($entity ?? '');
$id = (int) $id;
if (in_array($entity, $this->getProductListEntities())) {
$templates = [
'catalog/listing/' . $entity . '-' . $id,
'catalog/listing/' . $entity,
$template,
'catalog/listing/product-list',
];
} elseif (in_array($entity, $this->getProductListSearchEntities())) {
$templates = [
'catalog/listing/' . $entity,
$template,
'catalog/listing/product-list',
];
} elseif (in_array($entity, $this->getProductEntities())) {
$templates = [
'catalog/' . $entity . '-' . $id,
$template,
'catalog/product',
];
} elseif (in_array($entity, $this->getBrandListEntities())) {
$templates = [
$template,
'catalog/brands',
];
} elseif ('cms' === $entity) {
$templates = [
'cms/page-' . $id,
$template,
'cms/page',
];
} elseif ('cms_category' === $entity) {
$templates = [
'cms/category-' . $id,
$template,
'cms/category',
];
} else {
$templates = [$template];
}
return array_unique($templates);
}
/**
* Get productListEntities.
*
* @return array
*/
public function getProductListEntities()
{
return $this->productListEntities;
}
/**
* Set productListEntities.
*
* @param array $productListEntities
*
* @return TemplateFinderCore
*/
public function setProductListEntities($productListEntities)
{
$this->productListEntities = $productListEntities;
return $this;
}
/**
* Get productListSearch.
*
* @return array
*/
public function getProductListSearchEntities()
{
return $this->productListSearchEntities;
}
/**
* Set productListSearch.
*
* @param array $productListSearchEntities
*
* @return TemplateFinderCore
*/
public function setProductListSearchEntities($productListSearchEntities)
{
$this->productListSearchEntities = $productListSearchEntities;
return $this;
}
/**
* Get productEntities.
*
* @return array
*/
public function getProductEntities()
{
return $this->productEntities;
}
/**
* Set productEntities.
*
* @param array $productEntities
*
* @return TemplateFinderCore
*/
public function setProductEntities($productEntities)
{
$this->productEntities = $productEntities;
return $this;
}
/**
* Get brandListEntities.
*
* @return array
*/
public function getBrandListEntities()
{
return $this->brandListEntities;
}
/**
* Set brandListEntities.
*
* @param array $brandListEntities
*
* @return TemplateFinderCore
*/
public function setBrandListEntities($brandListEntities)
{
$this->brandListEntities = $brandListEntities;
return $this;
}
}