Repository Class Reference

Public Member Functions
	__construct (\Magento\Framework\UrlInterface $baseUrl, \Magento\Framework\View\DesignInterface $design, \Magento\Framework\View\Design\Theme\ListInterface $themeList, \Magento\Framework\View\Asset\Source $assetSource, \Magento\Framework\App\Request\Http $request, FileFactory $fileFactory, File\FallbackContextFactory $fallbackContextFactory, File\ContextFactory $contextFactory, RemoteFactory $remoteFactory)
	updateDesignParams (array &$params)
	createAsset ($fileId, array $params=[])
	getStaticViewFileContext ()
	createSimilar ($fileId, LocalInterface $similarTo)
	createArbitrary ( $filePath, $dirPath, $baseDirType=DirectoryList::STATIC_VIEW, $baseUrlType=UrlInterface::URL_TYPE_STATIC)
	createRelated ($fileId, LocalInterface $relativeTo)
	createRemoteAsset ($url, $contentType)
	getUrl ($fileId)
	getUrlWithParams ($fileId, array $params)

Static Public Member Functions
static	extractModule ($fileId)

Data Fields
const	FILE_ID_SEPARATOR = '::'

Detailed Description

A repository service for view assets @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since

100.0.2

Definition at line 21 of file Repository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\UrlInterface	$baseUrl,
		\Magento\Framework\View\DesignInterface	$design,
		\Magento\Framework\View\Design\Theme\ListInterface	$themeList,
		\Magento\Framework\View\Asset\Source	$assetSource,
		\Magento\Framework\App\Request\Http	$request,
		FileFactory	$fileFactory,
		File\FallbackContextFactory	$fallbackContextFactory,
		File\ContextFactory	$contextFactory,
		RemoteFactory	$remoteFactory
	)

Parameters

\Magento\Framework\UrlInterface	$baseUrl
\Magento\Framework\View\DesignInterface	$design
\Magento\Framework\View\Design\Theme\ListInterface	$themeList
\Magento\Framework\View\Asset\Source	$assetSource
\Magento\Framework\App\Request\Http	$request
FileFactory	$fileFactory
File\FallbackContextFactory	$fallbackContextFactory
File\ContextFactory	$contextFactory
RemoteFactory	$remoteFactory

Definition at line 100 of file Repository.php.

      {
        $this->baseUrl = $baseUrl;
        $this->design = $design;
        $this->themeList = $themeList;
        $this->assetSource = $assetSource;
        $this->request = $request;
        $this->fileFactory = $fileFactory;
        $this->fallbackContextFactory = $fallbackContextFactory;
        $this->contextFactory = $contextFactory;
        $this->remoteFactory = $remoteFactory;
    }

Member Function Documentation

createArbitrary()

createArbitrary	(		$filePath,
			$dirPath,
			$baseDirType = DirectoryList::STATIC_VIEW,
			$baseUrlType = UrlInterface::URL_TYPE_STATIC
	)

Create a file asset with an arbitrary path

This kind of file is not subject of fallback system Client code is responsible for ensuring that the file is in specified directory

Parameters

string	$filePath
string	$dirPath
string	$baseDirType
string	$baseUrlType

Returns

File

Definition at line 323 of file Repository.php.

      {
        $context = $this->getFileContext($baseDirType, $baseUrlType, $dirPath);
        $contentType = $this->assetSource->getContentType($filePath);
        return $this->fileFactory->create(
            [
                'source' => $this->assetSource,
                'context' => $context,
                'filePath' => $filePath,
                'module' => '',
                'contentType' => $contentType
            ]
        );
    }

createAsset()

createAsset	(		$fileId,
		array	$params = []
	)

Create a file asset that's subject of fallback system

Parameters

string	$fileId
array	$params

Returns

File

Definition at line 201 of file Repository.php.

    {
        $this->updateDesignParams($params);
        list($module, $filePath) = self::extractModule($fileId);
        if (!$module && $params['module']) {
            $module = $params['module'];
        }

        if (!isset($params['publish'])) {
            $map = $this->getRepositoryFilesMap($fileId, $params);
            if ($map) {
                $params = array_replace($params, $map);
            }
        }

        $isSecure = isset($params['_secure']) ? (bool) $params['_secure'] : null;
        $themePath = isset($params['theme']) ? $params['theme'] : $this->design->getThemePath($params['themeModel']);
        $context = $this->getFallbackContext(
            UrlInterface::URL_TYPE_STATIC,
            $isSecure,
            $params['area'],
            $themePath,
            $params['locale']
        );
        return $this->fileFactory->create(
            [
                'source' => $this->assetSource,
                'context' => $context,
                'filePath' => $filePath,
                'module' => $module,
                'contentType' => $this->assetSource->getContentType($filePath)
            ]
        );
    }

createRelated()

createRelated	(		$fileId,
		LocalInterface	$relativeTo
	)

Create a file asset with path relative to specified local asset

Parameters

string	$fileId
LocalInterface	$relativeTo

Returns

File

Definition at line 371 of file Repository.php.

    {
        list($module, $filePath) = self::extractModule($fileId);
        if ($module) {
            return $this->createSimilar($fileId, $relativeTo);
        }
        $filePath = \Magento\Framework\View\FileSystem::getRelatedPath($relativeTo->getFilePath(), $filePath);
        return $this->createSimilar($filePath, $relativeTo);
    }

createRemoteAsset()

createRemoteAsset	(		$url,
			$contentType
	)

Create a remote asset value object

Parameters

string	$url
string	$contentType

Returns

Remote @codeCoverageIgnore

Definition at line 389 of file Repository.php.

    {
        return $this->remoteFactory->create(['url' => $url, 'contentType' => $contentType]);
    }

createSimilar()

createSimilar	(		$fileId,
		LocalInterface	$similarTo
	)

Create a file asset similar to an existing local asset by using its context

Parameters

string	$fileId
LocalInterface	$similarTo

Returns

File

Definition at line 294 of file Repository.php.

    {
        list($module, $filePath) = self::extractModule($fileId);
        if (!$module) {
            $module = $similarTo->getModule();
        }
        return $this->fileFactory->create(
            [
                'source' => $this->assetSource,
                'context' => $similarTo->getContext(),
                'filePath' => $filePath,
                'module' => $module,
                'contentType' => $this->assetSource->getContentType($filePath)
            ]
        );
    }

extractModule()

static extractModule (   $fileId )

static

Extract module name from specified file ID

Parameters

string

$fileId

Returns

array

Exceptions

Definition at line 429 of file Repository.php.

    {
        if (strpos($fileId, self::FILE_ID_SEPARATOR) === false) {
            return ['', $fileId];
        }
        $result = explode(self::FILE_ID_SEPARATOR, $fileId, 2);
        if (empty($result[0])) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase('Scope separator "::" cannot be used without scope identifier.')
            );
        }
        return [$result[0], $result[1]];
    }

getStaticViewFileContext()

getStaticViewFileContext

(

)

Get current context for static view files

Returns

\Magento\Framework\View\Asset\File\FallbackContext

Definition at line 241 of file Repository.php.

    {
        $params = [];
        $this->updateDesignParams($params);
        $themePath = $this->design->getThemePath($params['themeModel']);
        $isSecure = $this->request->isSecure();
        return $this->getFallbackContext(
            UrlInterface::URL_TYPE_STATIC,
            $isSecure,
            $params['area'],
            $themePath,
            $params['locale']
        );
    }

getUrl()

getUrl

(

$fileId

)

Getter for static view file URL

Parameters

string

$fileId

Returns

string

Definition at line 400 of file Repository.php.

    {
        $asset = $this->createAsset($fileId);
        return $asset->getUrl();
    }

getUrlWithParams()

getUrlWithParams	(		$fileId,
		array	$params
	)

A getter for static view file URL with special parameters

To omit parameters and have them automatically determined from application state, use getUrl()

Parameters

string	$fileId
array	$params

Returns

string

See also

getUrl()

Definition at line 416 of file Repository.php.

    {
        $asset = $this->createAsset($fileId, $params);
        return $asset->getUrl();
    }

updateDesignParams()

updateDesignParams

(

array &

$params

)

Update required parameters with default values if custom not specified

Parameters

array

&$params

Exceptions

Definition at line 131 of file Repository.php.

    {
        // Set area
        if (empty($params['area'])) {
            $params['area'] = $this->getDefaultParameter('area');
        }

        // Set themeModel
        $theme = null;
        $area = $params['area'];
        if (!empty($params['themeId'])) {
            $theme = $params['themeId'];
        } elseif (isset($params['theme'])) {
            $theme = $params['theme'];
        } elseif (empty($params['themeModel']) && $area !== $this->getDefaultParameter('area')) {
            $theme = $this->design->getConfigurationDesignTheme($area);
        }

        if ($theme) {
            $params['themeModel'] = $this->getThemeProvider()->getThemeByFullPath($area . '/' . $theme);
            if (!$params['themeModel']) {
                throw new \UnexpectedValueException("Could not find theme '$theme' for area '$area'");
            }
        } elseif (empty($params['themeModel'])) {
            $params['themeModel'] = $this->getDefaultParameter('themeModel');
        }

        // Set module
        if (!array_key_exists('module', $params)) {
            $params['module'] = false;
        }

        // Set locale
        if (empty($params['locale'])) {
            $params['locale'] = $this->getDefaultParameter('locale');
        }
        return $this;
    }

Field Documentation

FILE_ID_SEPARATOR

const FILE_ID_SEPARATOR = '::'

Scope separator for module notation of file ID

Definition at line 26 of file Repository.php.

---

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

• vendor/magento/framework/View/Asset/Repository.php