Storage Class Reference

Inheritance diagram for Storage:

Public Member Functions
	__construct (\Magento\Backend\Model\Session $session, \Magento\Backend\Model\UrlInterface $backendUrl, \Magento\Cms\Helper\Wysiwyg\Images $cmsWysiwygImages, \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDb, \Magento\Framework\Filesystem $filesystem, \Magento\Framework\Image\AdapterFactory $imageFactory, \Magento\Framework\View\Asset\Repository $assetRepo, \Magento\Cms\Model\Wysiwyg\Images\Storage\CollectionFactory $storageCollectionFactory, \Magento\MediaStorage\Model\File\Storage\FileFactory $storageFileFactory, \Magento\MediaStorage\Model\File\Storage\DatabaseFactory $storageDatabaseFactory, \Magento\MediaStorage\Model\File\Storage\Directory\DatabaseFactory $directoryDatabaseFactory, \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory, array $resizeParameters=[], array $extensions=[], array $dirs=[], array $data=[])
	getDirsCollection ($path)
	createDirectory ($name, $path)
	deleteDirectory ($path)
	deleteFile ($target)
	getThumbnailPath ($filePath, $checkFile=false)
	getThumbnailUrl ($filePath, $checkFile=false)
	resizeFile ($source, $keepRatio=true)
	resizeOnTheFly ($filename)
	getThumbsPath ($filePath=false)
	getSession ()
	getAllowedExtensions ($type=null)
	getThumbnailRoot ()
	isImage ($filename)
	getResizeWidth ()
	getResizeHeight ()
	getCmsWysiwygImages ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Data Fields
const	DIRECTORY_NAME_REGEXP = '/^[a-z0-9\-\_]+$/si'
const	THUMBS_DIRECTORY_NAME = '.thumbs'
const	THUMB_PLACEHOLDER_PATH_SUFFIX = 'Magento_Cms::images/placeholder_thumbnail.jpg'

Protected Member Functions
	getConditionsForExcludeDirs ()
	removeItemFromCollection ($collection, $conditions)
	_deleteByPath ($path)
	_validatePath ($path)
	_sanitizePath ($path)
	_getRelativePathToRoot ($path)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_config
	$_configAsArray
	$_directory
	$_imageFactory
	$_assetRepo
	$_coreFileStorageDb = null
	$_cmsWysiwygImages = null
	$_resizeParameters
	$_extensions
	$_dirs
	$_backendUrl
	$_session
	$_directoryDatabaseFactory
	$_storageDatabaseFactory
	$_storageFileFactory
	$_storageCollectionFactory
	$_uploaderFactory
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Wysiwyg Images model

@SuppressWarnings(PHPMD.LongVariable) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since

100.0.2

Definition at line 21 of file Storage.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Model\Session	$session,
		\Magento\Backend\Model\UrlInterface	$backendUrl,
		\Magento\Cms\Helper\Wysiwyg\Images	$cmsWysiwygImages,
		\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDb,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\Image\AdapterFactory	$imageFactory,
		\Magento\Framework\View\Asset\Repository	$assetRepo,
		\Magento\Cms\Model\Wysiwyg\Images\Storage\CollectionFactory	$storageCollectionFactory,
		\Magento\MediaStorage\Model\File\Storage\FileFactory	$storageFileFactory,
		\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$storageDatabaseFactory,
		\Magento\MediaStorage\Model\File\Storage\Directory\DatabaseFactory	$directoryDatabaseFactory,
		\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory,
		array	$resizeParameters = [],
		array	$extensions = [],
		array	$dirs = [],
		array	$data = []
	)

Construct

Parameters

\Magento\Backend\Model\Session	$session
\Magento\Backend\Model\UrlInterface	$backendUrl
\Magento\Cms\Helper\Wysiwyg\Images	$cmsWysiwygImages
\Magento\MediaStorage\Helper\File\Storage\Database	$coreFileStorageDb
\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\Image\AdapterFactory	$imageFactory
\Magento\Framework\View\Asset\Repository	$assetRepo
\Magento\Cms\Model\Wysiwyg\Images\Storage\CollectionFactory	$storageCollectionFactory
\Magento\MediaStorage\Model\File\Storage\FileFactory	$storageFileFactory
\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$storageDatabaseFactory
\Magento\MediaStorage\Model\File\Storage\Directory\DatabaseFactory	$directoryDatabaseFactory
\Magento\MediaStorage\Model\File\UploaderFactory	$uploaderFactory
array	$resizeParameters
array	$extensions
array	$dirs
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 154 of file Storage.php.

      {
        $this->_session = $session;
        $this->_backendUrl = $backendUrl;
        $this->_cmsWysiwygImages = $cmsWysiwygImages;
        $this->_coreFileStorageDb = $coreFileStorageDb;
        $this->_directory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        $this->_imageFactory = $imageFactory;
        $this->_assetRepo = $assetRepo;
        $this->_storageCollectionFactory = $storageCollectionFactory;
        $this->_storageFileFactory = $storageFileFactory;
        $this->_storageDatabaseFactory = $storageDatabaseFactory;
        $this->_directoryDatabaseFactory = $directoryDatabaseFactory;
        $this->_uploaderFactory = $uploaderFactory;
        $this->_resizeParameters = $resizeParameters;
        $this->_extensions = $extensions;
        $this->_dirs = $dirs;
        parent::__construct($data);
    }

Member Function Documentation

_deleteByPath()

_deleteByPath (   $path )

protected

Delete by path

Parameters

string

$path

Returns

void

Definition at line 440 of file Storage.php.

    {
        $path = $this->_sanitizePath($path);
        if (!empty($path)) {
            $this->_validatePath($path);
            $this->_directory->delete($this->_directory->getRelativePath($path));
        }
    }

_getRelativePathToRoot()

_getRelativePathToRoot (   $path )

protected

Get path in root storage dir

Parameters

string

$path

Returns

string|bool

Definition at line 742 of file Storage.php.

    {
        return substr(
            $this->_sanitizePath($path),
            strlen($this->_sanitizePath($this->_cmsWysiwygImages->getStorageRoot()))
        );
    }

_sanitizePath()

_sanitizePath (   $path )

protected

Sanitize path

Parameters

string

$path

Returns

string

Definition at line 731 of file Storage.php.

    {
        return rtrim(preg_replace('~[/\\\]+~', '/', $this->_directory->getDriver()->getRealPathSafety($path)), '/');
    }

_validatePath()

_validatePath (   $path )

protected

Is path under storage root directory

Parameters

string

$path

Returns

void

Exceptions

Definition at line 710 of file Storage.php.

    {
        $root = $this->_sanitizePath($this->_cmsWysiwygImages->getStorageRoot());
        if ($root == $path) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We can\'t delete root directory %1 right now.', $path)
            );
        }
        if (strpos($path, $root) !== 0) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Directory %1 is not under storage root path.', $path)
            );
        }
    }

createDirectory()

createDirectory	(		$name,
			$path
	)

Create new directory in storage

Parameters

string	$name	New directory name
string	$path	Parent directory path

Returns

array New directory info

Exceptions

Definition at line 373 of file Storage.php.

    {
        if (!preg_match(self::DIRECTORY_NAME_REGEXP, $name)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('Please rename the folder using only letters, numbers, underscores and dashes.')
            );
        }

        $relativePath = $this->_directory->getRelativePath($path);
        if (!$this->_directory->isDirectory($relativePath) || !$this->_directory->isWritable($relativePath)) {
            $path = $this->_cmsWysiwygImages->getStorageRoot();
        }

        $newPath = $path . '/' . $name;
        $relativeNewPath = $this->_directory->getRelativePath($newPath);
        if ($this->_directory->isDirectory($relativeNewPath)) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We found a directory with the same name. Please try another folder name.')
            );
        }

        $this->_directory->create($relativeNewPath);
        try {
            if ($this->_coreFileStorageDb->checkDbUsage()) {
                $relativePath = $this->_coreFileStorageDb->getMediaRelativePath($newPath);
                $this->_directoryDatabaseFactory->create()->createRecursive($relativePath);
            }

            $result = [
                'name' => $name,
                'short_name' => $this->_cmsWysiwygImages->getShortFilename($name),
                'path' => $newPath,
                'id' => $this->_cmsWysiwygImages->convertPathToId($newPath),
            ];
            return $result;
        } catch (\Magento\Framework\Exception\FileSystemException $e) {
            throw new \Magento\Framework\Exception\LocalizedException(__('We cannot create a new directory.'));
        }
    }

deleteDirectory()

deleteDirectory

(

$path

)

Recursively delete directory from storage

Parameters

string

$path

Target dir

Returns

void

Exceptions

Definition at line 420 of file Storage.php.

    {
        if ($this->_coreFileStorageDb->checkDbUsage()) {
            $this->_directoryDatabaseFactory->create()->deleteDirectory($path);
        }
        try {
            $this->_deleteByPath($path);
            $path = $this->getThumbnailRoot() . $this->_getRelativePathToRoot($path);
            $this->_deleteByPath($path);
        } catch (\Magento\Framework\Exception\FileSystemException $e) {
            throw new \Magento\Framework\Exception\LocalizedException(__('We cannot delete directory %1.', $path));
        }
    }

deleteFile()

deleteFile

(

$target

)

Delete file (and its thumbnail if exists) from storage

Parameters

string

$target

File path to be deleted

Returns

$this

Definition at line 455 of file Storage.php.

    {
        $relativePath = $this->_directory->getRelativePath($target);
        if ($this->_directory->isFile($relativePath)) {
            $this->_directory->delete($relativePath);
        }
        $this->_coreFileStorageDb->deleteFile($target);

        $thumb = $this->getThumbnailPath($target, true);
        $relativePathThumb = $this->_directory->getRelativePath($thumb);
        if ($thumb) {
            if ($this->_directory->isFile($relativePathThumb)) {
                $this->_directory->delete($relativePathThumb);
            }
            $this->_coreFileStorageDb->deleteFile($thumb);
        }
        return $this;
    }

getAllowedExtensions()

getAllowedExtensions

(

$type = null

)

Prepare allowed_extensions config settings

Parameters

string

$type

Type of storage, e.g. image, media etc.

Returns

array Array of allowed file extensions

Definition at line 641 of file Storage.php.

    {
        $allowed = $this->getExtensionsList($type);

        return array_keys(array_filter($allowed));
    }

getCmsWysiwygImages()

getCmsWysiwygImages

(

)

Get cms wysiwyg images helper

Returns

Images|null

Definition at line 698 of file Storage.php.

    {
        return $this->_cmsWysiwygImages;
    }

getConditionsForExcludeDirs()

getConditionsForExcludeDirs ( )

protected

Prepare and get conditions for exclude directories

Returns

array

Definition at line 214 of file Storage.php.

    {
        $conditions = ['reg_exp' => [], 'plain' => []];

        if ($this->_dirs['exclude']) {
            foreach ($this->_dirs['exclude'] as $dir) {
                $conditions[!empty($dir['regexp']) ? 'reg_exp' : 'plain'][$dir['name']] = true;
            }
        }

        // "include" section takes precedence and can revoke directory exclusion
        if ($this->_dirs['include']) {
            foreach ($this->_dirs['include'] as $dir) {
                unset($conditions['reg_exp'][$dir['name']], $conditions['plain'][$dir['name']]);
            }
        }

        return $conditions;
    }

getDirsCollection()

getDirsCollection

(

$path

)

Return one-level child directories for specified path

Parameters

string

$path

Parent directory path

Returns

\Magento\Framework\Data\Collection\Filesystem

Definition at line 266 of file Storage.php.

    {
        $this->createSubDirectories($path);

        $collection = $this->getCollection($path)
            ->setCollectDirs(true)
            ->setCollectFiles(false)
            ->setCollectRecursively(false);

        $conditions = $this->getConditionsForExcludeDirs();

        return $this->removeItemFromCollection($collection, $conditions);
    }

getResizeHeight()

getResizeHeight

(

)

Get resize height

Returns

int

Definition at line 688 of file Storage.php.

    {
        return $this->_resizeParameters['height'];
    }

getResizeWidth()

getResizeWidth

(

)

Get resize width

Returns

int

Definition at line 678 of file Storage.php.

    {
        return $this->_resizeParameters['width'];
    }

getSession()

getSession

(

)

Storage session

Returns

\Magento\Backend\Model\Session

Definition at line 630 of file Storage.php.

    {
        return $this->_session;
    }

getThumbnailPath()

getThumbnailPath	(		$filePath,
			$checkFile = false
	)

Thumbnail path getter

Parameters

string	$filePath	original file path
bool	$checkFile	OPTIONAL is it necessary to check file availability

Returns

string|false

Definition at line 514 of file Storage.php.

    {
        $mediaRootDir = $this->_cmsWysiwygImages->getStorageRoot();

        if (strpos($filePath, $mediaRootDir) === 0) {
            $thumbPath = $this->getThumbnailRoot() . substr($filePath, strlen($mediaRootDir));

            if (!$checkFile || $this->_directory->isExist($this->_directory->getRelativePath($thumbPath))) {
                return $thumbPath;
            }
        }

        return false;
    }

getThumbnailRoot()

getThumbnailRoot

(

)

Thumbnail root directory getter

Returns

string

Definition at line 653 of file Storage.php.

    {
        return $this->_cmsWysiwygImages->getStorageRoot() . '/' . self::THUMBS_DIRECTORY_NAME;
    }

getThumbnailUrl()

getThumbnailUrl	(		$filePath,
			$checkFile = false
	)

Thumbnail URL getter

Parameters

string	$filePath	original file path
bool	$checkFile	OPTIONAL is it necessary to check file availability

Returns

string|false

Definition at line 536 of file Storage.php.

    {
        $mediaRootDir = $this->_cmsWysiwygImages->getStorageRoot();

        if (strpos($filePath, $mediaRootDir) === 0) {
            $thumbSuffix = self::THUMBS_DIRECTORY_NAME . substr($filePath, strlen($mediaRootDir));
            if (!$checkFile || $this->_directory->isExist(
                $this->_directory->getRelativePath($mediaRootDir . '/' . $thumbSuffix)
            )
            ) {
                $thumbSuffix = substr(
                    $mediaRootDir,
                    strlen($this->_directory->getAbsolutePath())
                ) . '/' . $thumbSuffix;
                $randomIndex = '?rand=' . time();
                return str_replace('\\', '/', $this->_cmsWysiwygImages->getBaseUrl() . $thumbSuffix) . $randomIndex;
            }
        }

        return false;
    }

getThumbsPath()

getThumbsPath

(

$filePath = false

)

Return thumbnails directory path for file/current directory

Parameters

bool | string

$filePath

Path to the file

Returns

string

Definition at line 613 of file Storage.php.

    {
        $mediaRootDir = $this->_cmsWysiwygImages->getStorageRoot();
        $thumbnailDir = $this->getThumbnailRoot();

        if ($filePath && strpos($filePath, $mediaRootDir) === 0) {
            $thumbnailDir .= dirname(substr($filePath, strlen($mediaRootDir)));
        }

        return $thumbnailDir;
    }

isImage()

isImage

(

$filename

)

Simple way to check whether file is image or not based on extension

Parameters

string

$filename

Returns

bool

Definition at line 664 of file Storage.php.

    {
        if (!$this->hasData('_image_extensions')) {
            $this->setData('_image_extensions', $this->getAllowedExtensions('image'));
        }
        $ext = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
        return in_array($ext, $this->_getData('_image_extensions'));
    }

removeItemFromCollection()

removeItemFromCollection (   $collection,   $conditions  )

protected

Remove excluded directories from collection

Parameters

\Magento\Framework\Data\Collection\Filesystem	$collection
array	$conditions

Returns

\Magento\Framework\Data\Collection\Filesystem

Definition at line 241 of file Storage.php.

    {
        $regExp = $conditions['reg_exp'] ? '~' . implode('|', array_keys($conditions['reg_exp'])) . '~i' : null;
        $storageRoot = $this->_cmsWysiwygImages->getStorageRoot();
        $storageRootLength = strlen($storageRoot);

        foreach ($collection as $key => $value) {
            $mediaSubPathname = substr($value->getFilename(), $storageRootLength);
            $rootChildParts = explode('/', '/' . ltrim($mediaSubPathname, '/'));

            if (array_key_exists($rootChildParts[1], $conditions['plain'])
                || ($regExp && preg_match($regExp, $value->getFilename()))) {
                $collection->removeItemByKey($key);
            }
        }

        return $collection;
    }

resizeFile()

resizeFile	(		$source,
			$keepRatio = true
	)

Create thumbnail for image and save it to thumbnails directory

Parameters

string	$source	Image path to be resized
bool	$keepRatio	Keep aspect ratio or not

Returns

bool|string Resized filepath or false if errors were occurred

Definition at line 565 of file Storage.php.

    {
        $realPath = $this->_directory->getRelativePath($source);
        if (!$this->_directory->isFile($realPath) || !$this->_directory->isExist($realPath)) {
            return false;
        }

        $targetDir = $this->getThumbsPath($source);
        $pathTargetDir = $this->_directory->getRelativePath($targetDir);
        if (!$this->_directory->isExist($pathTargetDir)) {
            $this->_directory->create($pathTargetDir);
        }
        if (!$this->_directory->isExist($pathTargetDir)) {
            return false;
        }
        $image = $this->_imageFactory->create();
        $image->open($source);
        $image->keepAspectRatio($keepRatio);
        $image->resize($this->_resizeParameters['width'], $this->_resizeParameters['height']);
        $dest = $targetDir . '/' . pathinfo($source, PATHINFO_BASENAME);
        $image->save($dest);
        if ($this->_directory->isFile($this->_directory->getRelativePath($dest))) {
            return $dest;
        }
        return false;
    }

resizeOnTheFly()

resizeOnTheFly

(

$filename

)

Resize images on the fly in controller action

Parameters

string

$filename

File basename

Returns

bool|string Thumbnail path or false for errors

Definition at line 598 of file Storage.php.

    {
        $path = $this->getSession()->getCurrentPath();
        if (!$path) {
            $path = $this->_cmsWysiwygImages->getCurrentPath();
        }
        return $this->resizeFile($path . '/' . $filename);
    }

Field Documentation

$_assetRepo

$_assetRepo

protected

Definition at line 56 of file Storage.php.

$_backendUrl

$_backendUrl

protected

Definition at line 90 of file Storage.php.

$_cmsWysiwygImages

$_cmsWysiwygImages = null

protected

Definition at line 70 of file Storage.php.

$_config

$_config

protected

Definition at line 34 of file Storage.php.

$_configAsArray

$_configAsArray

protected

Definition at line 41 of file Storage.php.

$_coreFileStorageDb

$_coreFileStorageDb = null

protected

Definition at line 63 of file Storage.php.

$_directory

$_directory

protected

Definition at line 46 of file Storage.php.

$_directoryDatabaseFactory

$_directoryDatabaseFactory

protected

Definition at line 102 of file Storage.php.

$_dirs

$_dirs

protected

Definition at line 85 of file Storage.php.

$_extensions

$_extensions

protected

Definition at line 80 of file Storage.php.

$_imageFactory

$_imageFactory

protected

Definition at line 51 of file Storage.php.

$_resizeParameters

$_resizeParameters

protected

Definition at line 75 of file Storage.php.

$_session

$_session

protected

Definition at line 95 of file Storage.php.

$_storageCollectionFactory

$_storageCollectionFactory

protected

Definition at line 123 of file Storage.php.

$_storageDatabaseFactory

$_storageDatabaseFactory

protected

Definition at line 109 of file Storage.php.

$_storageFileFactory

$_storageFileFactory

protected

Definition at line 116 of file Storage.php.

$_uploaderFactory

$_uploaderFactory

protected

Definition at line 130 of file Storage.php.

DIRECTORY_NAME_REGEXP

const DIRECTORY_NAME_REGEXP = '/^[a-z0-9\-\_]+$/si'

Definition at line 23 of file Storage.php.

THUMB_PLACEHOLDER_PATH_SUFFIX

const THUMB_PLACEHOLDER_PATH_SUFFIX = 'Magento_Cms::images/placeholder_thumbnail.jpg'

Definition at line 27 of file Storage.php.

THUMBS_DIRECTORY_NAME

const THUMBS_DIRECTORY_NAME = '.thumbs'

Definition at line 25 of file Storage.php.

---

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

• vendor/magento/module-cms/Model/Wysiwyg/Images/Storage.php