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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Model\View\Asset;
use Magento\Catalog\Model\Product\Media\ConfigInterface;
use Magento\Framework\Encryption\Encryptor;
use Magento\Framework\Encryption\EncryptorInterface;
use Magento\Framework\View\Asset\ContextInterface;
use Magento\Framework\View\Asset\LocalInterface;
/**
* A locally available image file asset that can be referred with a file path
*
* This class is a value object with lazy loading of some of its data (content, physical file path)
*/
class Image implements LocalInterface
{
/**
* Image type of image (thumbnail,small_image,image,swatch_image,swatch_thumb)
*
* @var string
*/
private $sourceContentType;
/**
* @var string
*/
private $filePath;
/**
* @var string
*/
private $contentType = 'image';
/**
* @var ContextInterface
*/
private $context;
/**
* Misc image params depend on size, transparency, quality, watermark etc.
*
* @var array
*/
private $miscParams;
/**
* @var ConfigInterface
*/
private $mediaConfig;
/**
* @var EncryptorInterface
*/
private $encryptor;
/**
* Image constructor.
*
* @param ConfigInterface $mediaConfig
* @param ContextInterface $context
* @param EncryptorInterface $encryptor
* @param string $filePath
* @param array $miscParams
*/
public function __construct(
ConfigInterface $mediaConfig,
ContextInterface $context,
EncryptorInterface $encryptor,
$filePath,
array $miscParams
) {
if (isset($miscParams['image_type'])) {
$this->sourceContentType = $miscParams['image_type'];
unset($miscParams['image_type']);
} else {
$this->sourceContentType = $this->contentType;
}
$this->mediaConfig = $mediaConfig;
$this->context = $context;
$this->filePath = $filePath;
$this->miscParams = $miscParams;
$this->encryptor = $encryptor;
}
/**
* {@inheritdoc}
*/
public function getUrl()
{
return $this->context->getBaseUrl() . DIRECTORY_SEPARATOR . $this->getImageInfo();
}
/**
* {@inheritdoc}
*/
public function getContentType()
{
return $this->contentType;
}
/**
* {@inheritdoc}
*/
public function getPath()
{
return $this->context->getPath() . DIRECTORY_SEPARATOR . $this->getImageInfo();
}
/**
* {@inheritdoc}
*/
public function getSourceFile()
{
return $this->mediaConfig->getBaseMediaPath()
. DIRECTORY_SEPARATOR . ltrim($this->getFilePath(), DIRECTORY_SEPARATOR);
}
/**
* Get source content type
*
* @return string
*/
public function getSourceContentType()
{
return $this->sourceContentType;
}
/**
* {@inheritdoc}
*/
public function getContent()
{
return null;
}
/**
* {@inheritdoc}
*/
public function getFilePath()
{
return $this->filePath;
}
/**
* {@inheritdoc}
* @return ContextInterface
*/
public function getContext()
{
return $this->context;
}
/**
* {@inheritdoc}
*/
public function getModule()
{
return 'cache';
}
/**
* Retrieve part of path based on misc params
*
* @return string
*/
private function getMiscPath()
{
return $this->encryptor->hash(
implode('_', $this->convertToReadableFormat($this->miscParams)),
Encryptor::HASH_VERSION_MD5
);
}
/**
* Generate path from image info
*
* @return string
*/
private function getImageInfo()
{
$path = $this->getModule()
. DIRECTORY_SEPARATOR . $this->getMiscPath()
. DIRECTORY_SEPARATOR . $this->getFilePath();
return preg_replace('|\Q'. DIRECTORY_SEPARATOR . '\E+|', DIRECTORY_SEPARATOR, $path);
}
/**
* Converting bool into a string representation
* @param $miscParams
* @return array
*/
private function convertToReadableFormat($miscParams)
{
$miscParams['image_height'] = 'h:' . ($miscParams['image_height'] ?? 'empty');
$miscParams['image_width'] = 'w:' . ($miscParams['image_width'] ?? 'empty');
$miscParams['quality'] = 'q:' . ($miscParams['quality'] ?? 'empty');
$miscParams['angle'] = 'r:' . ($miscParams['angle'] ?? 'empty');
$miscParams['keep_aspect_ratio'] = (isset($miscParams['keep_aspect_ratio']) ? '' : 'non') . 'proportional';
$miscParams['keep_frame'] = (isset($miscParams['keep_frame']) ? '' : 'no') . 'frame';
$miscParams['keep_transparency'] = (isset($miscParams['keep_transparency']) ? '' : 'no') . 'transparency';
$miscParams['constrain_only'] = (isset($miscParams['constrain_only']) ? 'do' : 'not') . 'constrainonly';
$miscParams['background'] = isset($miscParams['background'])
? 'rgb' . implode(',', $miscParams['background'])
: 'nobackground';
return $miscParams;
}
}