Media Class Reference

Inheritance diagram for Media:

Public Member Functions
	__construct (\Magento\Catalog\Model\Product\Media\Config $mediaConfig, \Magento\Framework\Filesystem $filesystem, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDb, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Image\Factory $imageFactory, \Magento\Theme\Model\ResourceModel\Theme\Collection $themeCollection, \Magento\Framework\View\ConfigInterface $configInterface)
	getSwatchAttributeImage ($swatchType, $file)
	generateSwatchVariations ($imageUrl)
	getFolderNameSize ($swatchType, $imageConfig=null)
	getImageConfig ()
	getSwatchMediaUrl ()
	getAttributeSwatchPath ($file)
	getSwatchMediaPath ()
	getSwatchCachePath ($swatchType)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	SWATCH_MEDIA_PATH = 'attribute/swatch'

Protected Member Functions
	getUniqueFileName ($file)
	setupImageProperties (\Magento\Framework\Image $image, $isSwatch=false)
	generateNamePath ($imageConfig, $imageUrl, $swatchType)
	prepareFileName ($imageUrl)
	prepareFile ($file)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$mediaConfig
	$mediaDirectory
	$fileStorageDb = null
	$storeManager
	$imageFactory
	$themeCollection
	$viewConfig
	$swatchImageTypes = ['swatch_image', 'swatch_thumb']
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Helper to move images from tmp to catalog directory @api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 18 of file Media.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\Product\Media\Config	$mediaConfig,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Image\Factory	$imageFactory,
		\Magento\Theme\Model\ResourceModel\Theme\Collection	$themeCollection,
		\Magento\Framework\View\ConfigInterface	$configInterface
	)

Parameters

\Magento\Catalog\Model\Product\Media\Config	$mediaConfig
\Magento\Framework\Filesystem	$filesystem
\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDb
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Image\Factory	$imageFactory
\Magento\Theme\Model\ResourceModel\Theme\Collection	$themeCollection
\Magento\Framework\View\ConfigInterface	$configInterface

Definition at line 84 of file Media.php.

      {
        $this->mediaConfig = $mediaConfig;
        $this->fileStorageDb = $fileStorageDb;
        $this->mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        $this->storeManager = $storeManager;
        $this->imageFactory = $imageFactory;
        $this->themeCollection = $themeCollection;
        $this->viewConfig = $configInterface;
    }

Member Function Documentation

generateNamePath()

generateNamePath (   $imageConfig,   $imageUrl,   $swatchType  )

protected

Generate swatch path and name for saving

Parameters

array	$imageConfig
string	$imageUrl
string	$swatchType

Returns

array

Definition at line 227 of file Media.php.

    {
        $fileName = $this->prepareFileName($imageUrl);
        $absolutePath = $this->mediaDirectory->getAbsolutePath($this->getSwatchCachePath($swatchType));
        return [
            'path_for_save' => $absolutePath . $this->getFolderNameSize($swatchType, $imageConfig) . $fileName['path'],
            'name' => $fileName['name']
        ];
    }

generateSwatchVariations()

generateSwatchVariations

(

$imageUrl

)

Generate swatch thumb and small swatch image

Parameters

string

$imageUrl

Returns

$this

Definition at line 184 of file Media.php.

    {
        $absoluteImagePath = $this->mediaDirectory->getAbsolutePath($this->getAttributeSwatchPath($imageUrl));
        foreach ($this->swatchImageTypes as $swatchType) {
            $imageConfig = $this->getImageConfig();
            $swatchNamePath = $this->generateNamePath($imageConfig, $imageUrl, $swatchType);
            $image = $this->imageFactory->create($absoluteImagePath);
            $this->setupImageProperties($image);
            $image->resize($imageConfig[$swatchType]['width'], $imageConfig[$swatchType]['height']);
            $this->setupImageProperties($image, true);
            $image->save($swatchNamePath['path_for_save'], $swatchNamePath['name']);
        }
        return $this;
    }

getAttributeSwatchPath()

getAttributeSwatchPath

(

$file

)

Return example: attribute/swatch/m/a/magento.jpg

Parameters

string

$file

Returns

string

Definition at line 301 of file Media.php.

    {
        return $this->getSwatchMediaPath() . '/' . $this->prepareFile($file);
    }

getFolderNameSize()

getFolderNameSize	(		$swatchType,
			$imageConfig = null
	)

Generate folder name WIDTHxHEIGHT based on config in view.xml

Parameters

string	$swatchType
null	$imageConfig

Returns

string

Definition at line 244 of file Media.php.

    {
        if ($imageConfig === null) {
            $imageConfig = $this->getImageConfig();
        }
        return $imageConfig[$swatchType]['width'] . 'x' . $imageConfig[$swatchType]['height'];
    }

getImageConfig()

getImageConfig

(

)

Merged config from view.xml

Returns

array

Definition at line 257 of file Media.php.

    {
        if (!$this->imageConfig) {
            $this->imageConfig = $this->viewConfig->getViewConfig()->getMediaEntities(
                'Magento_Catalog',
                Image::MEDIA_TYPE_CONFIG_NODE
            );
        }

        return $this->imageConfig;
    }

getSwatchAttributeImage()

getSwatchAttributeImage	(		$swatchType,
			$file
	)

Parameters

string	$swatchType
string	$file

Returns

string

Definition at line 107 of file Media.php.

    {
        $generationPath = $swatchType . '/' . $this->getFolderNameSize($swatchType) . $file;
        $absoluteImagePath = $this->mediaDirectory
            ->getAbsolutePath($this->getSwatchMediaPath() . '/' . $generationPath);
        if (!file_exists($absoluteImagePath)) {
            try {
                $this->generateSwatchVariations($file);
            } catch (\Exception $e) {
                return '';
            }
        }
        return $this->getSwatchMediaUrl() . '/' . $generationPath;
    }

getSwatchCachePath()

getSwatchCachePath

(

$swatchType

)

Media path with swatch_image or swatch_thumb folder

Parameters

string

$swatchType

Returns

string

Definition at line 322 of file Media.php.

    {
        return self::SWATCH_MEDIA_PATH . '/' . $swatchType . '/';
    }

getSwatchMediaPath()

getSwatchMediaPath

(

)

Media swatch path

Returns

string

Definition at line 311 of file Media.php.

    {
        return self::SWATCH_MEDIA_PATH;
    }

getSwatchMediaUrl()

getSwatchMediaUrl

(

)

Url type http://url/pub/media/attribute/swatch/

Returns

string

Definition at line 288 of file Media.php.

    {
        return $this->storeManager
            ->getStore()
            ->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_MEDIA) . $this->getSwatchMediaPath();
    }

getUniqueFileName()

getUniqueFileName (   $file )

protected

Check whether file to move exists. Getting unique name

Parameters

<type>

$file

Returns

string

Definition at line 162 of file Media.php.

    {
        if ($this->fileStorageDb->checkDbUsage()) {
            $destFile = $this->fileStorageDb->getUniqueFilename(
                $this->mediaConfig->getBaseMediaUrlAddition(),
                $file
            );
        } else {
            $destFile = dirname($file) . '/' . \Magento\MediaStorage\Model\File\Uploader::getNewFileName(
                $this->mediaDirectory->getAbsolutePath($this->getAttributeSwatchPath($file))
            );
        }

        return $destFile;
    }

prepareFile()

prepareFile (   $file )

protected

Prepare file for saving

Parameters

string

$file

Returns

string

Definition at line 333 of file Media.php.

    {
        return ltrim(str_replace('\\', '/', $file), '/');
    }

prepareFileName()

prepareFileName (   $imageUrl )

protected

Image url /m/a/magento.png return ['name' => 'magento.png', 'path => '/m/a']

Parameters

string

$imageUrl

Returns

array

Definition at line 275 of file Media.php.

    {
        $fileArray = explode('/', $imageUrl);
        $fileName = array_pop($fileArray);
        $filePath = implode('/', $fileArray);
        return ['name' => $fileName, 'path' => $filePath];
    }

setupImageProperties()

setupImageProperties ( \Magento\Framework\Image  $image,   $isSwatch = false  )

protected

Setup base image properties for resize

Parameters

\Magento\Framework\Image	$image
bool	$isSwatch

Returns

$this

Definition at line 206 of file Media.php.

    {
        $image->quality(100);
        $image->constrainOnly(true);
        $image->keepAspectRatio(true);
        if ($isSwatch) {
            $image->keepFrame(true);
            $image->keepTransparency(true);
            $image->backgroundColor([255, 255, 255]);
        }
        return $this;
    }

Field Documentation

$fileStorageDb

$fileStorageDb = null

protected

Definition at line 41 of file Media.php.

$imageFactory

$imageFactory

protected

Definition at line 53 of file Media.php.

$mediaConfig

$mediaConfig

protected

Definition at line 29 of file Media.php.

$mediaDirectory

$mediaDirectory

protected

Definition at line 34 of file Media.php.

$storeManager

$storeManager

protected

Definition at line 48 of file Media.php.

$swatchImageTypes

$swatchImageTypes = ['swatch_image', 'swatch_thumb']

protected

Definition at line 68 of file Media.php.

$themeCollection

$themeCollection

protected

Definition at line 58 of file Media.php.

$viewConfig

$viewConfig

protected

Definition at line 63 of file Media.php.

SWATCH_MEDIA_PATH

const SWATCH_MEDIA_PATH = 'attribute/swatch'

Swatch area inside media folder

Definition at line 24 of file Media.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-swatches/Helper/Media.php