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/cartforge.co/vendor/magento/module-catalog/Model/View/Asset/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Model\View\Asset;
use Magento\Catalog\Model\Config\CatalogMediaConfig;
use Magento\Catalog\Model\Product\Media\ConfigInterface;
use Magento\Framework\Encryption\Encryptor;
use Magento\Framework\Encryption\EncryptorInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\View\Asset\ContextInterface;
use Magento\Framework\View\Asset\LocalInterface;
use Magento\Catalog\Helper\Image as ImageHelper;
use Magento\Framework\App\ObjectManager;
use Magento\Store\Model\StoreManagerInterface;
/**
* 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;
/**
* @var ImageHelper
*/
private $imageHelper;
/**
* @var StoreManagerInterface
*/
private $storeManager;
/**
* @var string
*/
private $mediaFormatUrl;
/**
* Image constructor.
*
* @param ConfigInterface $mediaConfig
* @param ContextInterface $context
* @param EncryptorInterface $encryptor
* @param string $filePath
* @param array $miscParams
* @param ImageHelper $imageHelper
* @param CatalogMediaConfig $catalogMediaConfig
* @param StoreManagerInterface $storeManager
*/
public function __construct(
ConfigInterface $mediaConfig,
ContextInterface $context,
EncryptorInterface $encryptor,
$filePath,
array $miscParams,
ImageHelper $imageHelper = null,
CatalogMediaConfig $catalogMediaConfig = null,
StoreManagerInterface $storeManager = null
) {
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;
$this->imageHelper = $imageHelper ?: ObjectManager::getInstance()->get(ImageHelper::class);
$this->storeManager = $storeManager ?: ObjectManager::getInstance()->get(StoreManagerInterface::class);
$catalogMediaConfig = $catalogMediaConfig ?: ObjectManager::getInstance()->get(CatalogMediaConfig::class);
$this->mediaFormatUrl = $catalogMediaConfig->getMediaUrlFormat();
}
/**
* Get catalog image URL.
*
* @return string
* @throws LocalizedException
*/
public function getUrl()
{
switch ($this->mediaFormatUrl) {
case CatalogMediaConfig::IMAGE_OPTIMIZATION_PARAMETERS:
return $this->getUrlWithTransformationParameters();
case CatalogMediaConfig::HASH:
return $this->context->getBaseUrl() . DIRECTORY_SEPARATOR . $this->getImageInfo();
default:
throw new LocalizedException(
__("The specified Catalog media URL format '$this->mediaFormatUrl' is not supported.")
);
}
}
/**
* Get image URL with transformation parameters
*
* @return string
*/
private function getUrlWithTransformationParameters()
{
return $this->getOriginalImageUrl() . '?' . http_build_query($this->getImageTransformationParameters());
}
/**
* The list of parameters to be used during image transformations (e.g. resizing or applying watermarks).
*
* This method can be used as an extension point.
*
* @return string[]
*/
public function getImageTransformationParameters()
{
return [
'width' => $this->miscParams['image_width'],
'height' => $this->miscParams['image_height'],
'store' => $this->storeManager->getStore()->getCode(),
'image-type' => $this->sourceContentType
];
}
/**
* Get URL to the original version of the product image.
*
* @return string
*/
private function getOriginalImageUrl()
{
$originalImageFile = $this->getSourceFile();
if (!$originalImageFile) {
return $this->imageHelper->getDefaultPlaceholderUrl();
} else {
return $this->context->getBaseUrl() . $this->getFilePath();
}
}
/**
* @inheritdoc
*/
public function getContentType()
{
return $this->contentType;
}
/**
* @inheritdoc
*/
public function getPath()
{
return $this->context->getPath() . DIRECTORY_SEPARATOR . $this->getImageInfo();
}
/**
* @inheritdoc
*/
public function getSourceFile()
{
$path = $this->getFilePath() ? ltrim($this->getFilePath(), DIRECTORY_SEPARATOR) : '';
return $this->mediaConfig->getBaseMediaPath() . DIRECTORY_SEPARATOR . $path;
}
/**
* 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 array $miscParams
* @return array
*/
private function convertToReadableFormat(array $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'] = (!empty($miscParams['keep_aspect_ratio']) ? '' : 'non') . 'proportional';
$miscParams['keep_frame'] = (!empty($miscParams['keep_frame']) ? '' : 'no') . 'frame';
$miscParams['keep_transparency'] = (!empty($miscParams['keep_transparency']) ? '' : 'no') . 'transparency';
$miscParams['constrain_only'] = (!empty($miscParams['constrain_only']) ? 'do' : 'not') . 'constrainonly';
$miscParams['background'] = !empty($miscParams['background'])
? 'rgb' . implode(',', $miscParams['background'])
: 'nobackground';
return $miscParams;
}
}