How is Magento\Framework\View\Page\Config::addPageAsset() implemented and used?

dmitry_fedyuk · May 7, 2017, 10:01am

Implementation

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Page/Config.php#L406-L419


/**
 * @param string $file
 * @param array $properties
 * @param string|null $name
 * @return $this
 */
public function addPageAsset($file, array $properties = [], $name = null)
{
    $asset = $this->assetRepo->createAsset($file);
    $name = $name ?: $file;
    $this->pageAssets->add($name, $asset, $properties);


    return $this;
}

Usages

1. Magento\Framework\View\Page\Config\Generator\Head::processAssets()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Page/Config/Generator/Head.php#L100-L120


/**
 * Add assets to page config
 *
 * @param \Magento\Framework\View\Page\Config\Structure $pageStructure
 * @return $this
 */
protected function processAssets(Structure $pageStructure)
{
    foreach ($pageStructure->getAssets() as $name => $data) {
        if (isset($data['src_type']) && in_array($data['src_type'], $this->remoteAssetTypes)) {
            $this->pageConfig->addRemotePageAsset(
                $name,
                isset($data['content_type']) ? $data['content_type'] : self::VIRTUAL_CONTENT_TYPE_LINK,
                $this->getAssetProperties($data)
            );
        } else {
            $this->pageConfig->addPageAsset($name, $this->getAssetProperties($data));
        }
    }
    return $this;
}

2. Magento\Framework\View\Page\Config\Renderer::prepareFavicon()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Page/Config/Renderer.php#L182-L209


public function prepareFavicon()
{
    if ($this->pageConfig->getFaviconFile()) {
        $this->pageConfig->addRemotePageAsset(
            $this->pageConfig->getFaviconFile(),
            Generator\Head::VIRTUAL_CONTENT_TYPE_LINK,
            ['attributes' => ['rel' => 'icon', 'type' => 'image/x-icon']],
            'icon'
        );
        $this->pageConfig->addRemotePageAsset(
            $this->pageConfig->getFaviconFile(),
            Generator\Head::VIRTUAL_CONTENT_TYPE_LINK,
            ['attributes' => ['rel' => 'shortcut icon', 'type' => 'image/x-icon']],
            'shortcut-icon'
        );
    } else {
        $this->pageConfig->addPageAsset(
            $this->pageConfig->getDefaultFavicon(),
            ['attributes' => ['rel' => 'icon', 'type' => 'image/x-icon']],
            'icon'
        );
        $this->pageConfig->addPageAsset(
            $this->pageConfig->getDefaultFavicon(),
            ['attributes' => ['rel' => 'shortcut icon', 'type' => 'image/x-icon']],
            'shortcut-icon'
        );
    }
}

3. Magento\Backend\Block\Media\Uploader::_prepareLayout()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Backend/Block/Media/Uploader.php#L80-L89


/**
 * Prepares layout and set element renderer
 *
 * @return $this
 */
protected function _prepareLayout()
{
    $this->pageConfig->addPageAsset('jquery/fileUploader/css/jquery.fileupload-ui.css');
    return parent::_prepareLayout();
}

4. Magento\Email\Block\Adminhtml\Template\Edit\Form::_prepareLayout()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Email/Block/Adminhtml/Template/Edit/Form.php#L45-L55


/**
 * Prepare layout.
 * Add files to use dialog windows
 *
 * @return $this
 */
protected function _prepareLayout()
{
    $this->pageConfig->addPageAsset('prototype/windows/themes/default.css');
    return parent::_prepareLayout();
}

dmitry_fedyuk · May 7, 2017, 10:08am