Storage Class Reference

Inheritance diagram for Storage:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\Framework\Filesystem $filesystem, \Magento\Backend\Model\Session $session, \Magento\Framework\View\Design\Theme\FlyweightFactory $themeFactory)
	convertPathToId ($path)
	convertIdToPath ($value)
	getShortFilename ($filename, $maxLength=20)
	getStorageRoot ()
	getStorageType ()
	getRelativeUrl ()
	getCurrentPath ()
	getThumbnailDirectory ($path)
	getThumbnailPath ($imageName)
	getRequestParams ()
	getAllowedExtensionsByType ()
	getStorageTypeName ()
	getSession ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	PARAM_NODE = 'node'
const	PARAM_CONTENT_TYPE = 'content_type'
const	PARAM_THEME_ID = 'theme_id'
const	PARAM_FILENAME = 'filename'
const	NODE_ROOT = 'root'
const	IMAGES = 'Images'
const	FONTS = 'Fonts'

Protected Member Functions
	_getTheme ()
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_currentPath
	$_storageRoot
	$filesystem
	$_session
	$_themeFactory
	$mediaDirectoryWrite
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

@api

Since

100.0.2

Definition at line 18 of file Storage.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Backend\Model\Session	$session,
		\Magento\Framework\View\Design\Theme\FlyweightFactory	$themeFactory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Framework\Filesystem	$filesystem
\Magento\Backend\Model\Session	$session
\Magento\Framework\View\Design\Theme\FlyweightFactory	$themeFactory

Definition at line 97 of file Storage.php.

      {
        parent::__construct($context);
        $this->filesystem = $filesystem;
        $this->_session = $session;
        $this->_themeFactory = $themeFactory;
        $this->mediaDirectoryWrite = $this->filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        $this->mediaDirectoryWrite->create($this->mediaDirectoryWrite->getRelativePath($this->getStorageRoot()));
    }

Member Function Documentation

_getTheme()

_getTheme ( )

protected

Get theme module for custom static files

Returns

\Magento\Theme\Model\Theme

Exceptions

Definition at line 172 of file Storage.php.

    {
        $themeId = $this->_getRequest()->getParam(self::PARAM_THEME_ID);
        $theme = $this->_themeFactory->create($themeId);
        if (!$themeId || !$theme) {
            throw new \InvalidArgumentException('Theme was not found.');
        }
        return $theme;
    }

convertIdToPath()

convertIdToPath

(

$value

)

Convert id to path

Parameters

string

$value

Returns

string

Definition at line 129 of file Storage.php.

    {
        $path = $this->urlDecoder->decode($value);
        if (!strstr($path, $this->getStorageRoot())) {
            $path = $this->getStorageRoot() . $path;
        }
        return $path;
    }

convertPathToId()

convertPathToId

(

$path

)

Convert path to id

Parameters

string

$path

Returns

string

Definition at line 117 of file Storage.php.

    {
        $path = str_replace($this->getStorageRoot(), '', $path);
        return $this->urlEncoder->encode($path);
    }

getAllowedExtensionsByType()

getAllowedExtensionsByType

(

)

Get allowed extensions by type

Returns

string[]

Exceptions

Definition at line 291 of file Storage.php.

    {
        return $this->getStorageType() == \Magento\Theme\Model\Wysiwyg\Storage::TYPE_FONT
                ? ['ttf', 'otf', 'eot', 'svg', 'woff']
                : ['jpg', 'jpeg', 'gif', 'png', 'xbm', 'wbmp'];
    }

getCurrentPath()

getCurrentPath

(

)

Get current path

Returns

string

Definition at line 224 of file Storage.php.

    {
        if (!$this->_currentPath) {
            $currentPath = $this->getStorageRoot();
            $path = $this->_getRequest()->getParam(self::PARAM_NODE);
            if ($path && $path !== self::NODE_ROOT) {
                $path = $this->convertIdToPath($path);

                if ($this->mediaDirectoryWrite->isDirectory($path) && 0 === strpos($path, $currentPath)) {
                    $currentPath = $this->mediaDirectoryWrite->getRelativePath($path);
                }
            }
            $this->_currentPath = $currentPath;
        }
        return $this->_currentPath;
    }

getRelativeUrl()

getRelativeUrl

(

)

Relative url to static content

Returns

string

Definition at line 206 of file Storage.php.

    {
        $pathPieces = ['..', $this->getStorageType()];
        $node = $this->_getRequest()->getParam(self::PARAM_NODE);
        if ($node !== self::NODE_ROOT) {
            $node = $this->urlDecoder->decode($node);
            $nodes = explode('/', trim($node, '/'));
            $pathPieces = array_merge($pathPieces, $nodes);
        }
        $pathPieces[] = $this->urlDecoder->decode($this->_getRequest()->getParam(self::PARAM_FILENAME));
        return implode('/', $pathPieces);
    }

getRequestParams()

getRequestParams

(

)

Request params for selected theme

Returns

array

Definition at line 273 of file Storage.php.

    {
        $themeId = $this->_getRequest()->getParam(self::PARAM_THEME_ID);
        $contentType = $this->_getRequest()->getParam(self::PARAM_CONTENT_TYPE);
        $node = $this->_getRequest()->getParam(self::PARAM_NODE);
        return [
            self::PARAM_THEME_ID => $themeId,
            self::PARAM_CONTENT_TYPE => $contentType,
            self::PARAM_NODE => $node
        ];
    }

getSession()

getSession

(

)

Get session model

Returns

\Magento\Backend\Model\Session

Definition at line 316 of file Storage.php.

    {
        return $this->_session;
    }

getShortFilename()

getShortFilename	(		$filename,
			$maxLength = 20
	)

Get short file name

Parameters

string	$filename
int	$maxLength

Returns

string

Definition at line 145 of file Storage.php.

    {
        return strlen($filename) <= $maxLength ? $filename : substr($filename, 0, $maxLength) . '...';
    }

getStorageRoot()

getStorageRoot

(

)

Get storage root directory

Returns

string

Definition at line 155 of file Storage.php.

    {
        if (null === $this->_storageRoot) {
            $this->_storageRoot = implode(
                '/',
                [$this->_getTheme()->getCustomization()->getCustomizationPath(), $this->getStorageType()]
            );
        }
        return $this->_storageRoot;
    }

getStorageType()

getStorageType

(

)

Get storage type

Returns

string

Exceptions

Definition at line 188 of file Storage.php.

    {
        $allowedTypes = [
            \Magento\Theme\Model\Wysiwyg\Storage::TYPE_FONT,
            \Magento\Theme\Model\Wysiwyg\Storage::TYPE_IMAGE,
        ];
        $type = (string)$this->_getRequest()->getParam(self::PARAM_CONTENT_TYPE);
        if (!in_array($type, $allowedTypes)) {
            throw new \Magento\Framework\Exception\LocalizedException(__('Invalid type'));
        }
        return $type;
    }

getStorageTypeName()

getStorageTypeName

(

)

Get storage type name for display.

Returns

string

Exceptions

Definition at line 304 of file Storage.php.

    {
        return $this->getStorageType() == \Magento\Theme\Model\Wysiwyg\Storage::TYPE_FONT
            ? self::FONTS
            : self::IMAGES;
    }

getThumbnailDirectory()

getThumbnailDirectory

(

$path

)

Get thumbnail directory for path

Parameters

string

$path

Returns

string

Definition at line 247 of file Storage.php.

    {
        return pathinfo($path, PATHINFO_DIRNAME) . '/' . \Magento\Theme\Model\Wysiwyg\Storage::THUMBNAIL_DIRECTORY;
    }

getThumbnailPath()

getThumbnailPath

(

$imageName

)

Get thumbnail path in current directory by image name

Parameters

string

$imageName

Returns

string

Exceptions

Definition at line 259 of file Storage.php.

    {
        $imagePath = $this->getCurrentPath() . '/' . $imageName;
        if (!$this->mediaDirectoryWrite->isExist($imagePath) || 0 !== strpos($imagePath, $this->getStorageRoot())) {
            throw new \InvalidArgumentException('The image not found.');
        }
        return $this->getThumbnailDirectory($imagePath) . '/' . pathinfo($imageName, PATHINFO_BASENAME);
    }

Field Documentation

$_currentPath

$_currentPath

protected

Definition at line 60 of file Storage.php.

$_session

$_session

protected

Definition at line 79 of file Storage.php.

$_storageRoot

$_storageRoot

protected

Definition at line 67 of file Storage.php.

$_themeFactory

$_themeFactory

protected

Definition at line 84 of file Storage.php.

$filesystem

$filesystem

protected

Definition at line 74 of file Storage.php.

$mediaDirectoryWrite

$mediaDirectoryWrite

protected

Definition at line 89 of file Storage.php.

FONTS

const FONTS = 'Fonts'

Display name for fonts storage type

Definition at line 53 of file Storage.php.

IMAGES

const IMAGES = 'Images'

Display name for images storage type

Definition at line 48 of file Storage.php.

NODE_ROOT

const NODE_ROOT = 'root'

Root node value identification number

Definition at line 43 of file Storage.php.

PARAM_CONTENT_TYPE

const PARAM_CONTENT_TYPE = 'content_type'

Parameter name of content type

Definition at line 28 of file Storage.php.

PARAM_FILENAME

const PARAM_FILENAME = 'filename'

Parameter name of filename

Definition at line 38 of file Storage.php.

PARAM_NODE

const PARAM_NODE = 'node'

Parameter name of node

Definition at line 23 of file Storage.php.

PARAM_THEME_ID

const PARAM_THEME_ID = 'theme_id'

Parameter name of theme identification number

Definition at line 33 of file Storage.php.

---

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

• vendor/magento/module-theme/Helper/Storage.php