Favicon Class Reference

Inheritance diagram for Favicon:

Public Member Functions
	__construct (\Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\MediaStorage\Helper\File\Storage\Database $fileStorageDatabase, \Magento\Framework\Filesystem $filesystem)
	getFaviconFile ()
	getDefaultFavicon ()

Protected Member Functions
	prepareFaviconFile ()
	checkIsFile ($filename)

Protected Attributes
	$faviconFile
	$storeManager
	$scopeConfig
	$fileStorageDatabase
	$mediaDirectory

Detailed Description

Favicon implementation

Definition at line 13 of file Favicon.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDatabase,
		\Magento\Framework\Filesystem	$filesystem
	)

Parameters

\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\MediaStorage\Helper\File\Storage\Database	$fileStorageDatabase
\Magento\Framework\Filesystem	$filesystem

Definition at line 46 of file Favicon.php.

      {
        $this->storeManager = $storeManager;
        $this->scopeConfig = $scopeConfig;
        $this->fileStorageDatabase = $fileStorageDatabase;
        $this->mediaDirectory = $filesystem->getDirectoryRead(DirectoryList::MEDIA);
    }

Member Function Documentation

checkIsFile()

checkIsFile (   $filename )

protected

If DB file storage is on - find there, otherwise - just file_exists

Parameters

string

$filename

relative file path

Returns

bool

Definition at line 104 of file Favicon.php.

    {
        if ($this->fileStorageDatabase->checkDbUsage() && !$this->mediaDirectory->isFile($filename)) {
            $this->fileStorageDatabase->saveFileToFilesystem($filename);
        }
        return $this->mediaDirectory->isFile($filename);
    }

getDefaultFavicon()

getDefaultFavicon

(

)

Returns

string

Implements FaviconInterface.

Definition at line 72 of file Favicon.php.

    {
        return 'Magento_Theme::favicon.ico';
    }

getFaviconFile()

getFaviconFile

(

)

Returns

string

Implements FaviconInterface.

Definition at line 61 of file Favicon.php.

    {
        if (null === $this->faviconFile) {
            $this->faviconFile = $this->prepareFaviconFile();
        }
        return $this->faviconFile;
    }

prepareFaviconFile()

prepareFaviconFile ( )

protected

Returns

string

Definition at line 80 of file Favicon.php.

    {
        $folderName = \Magento\Config\Model\Config\Backend\Image\Favicon::UPLOAD_DIR;
        $scopeConfig = $this->scopeConfig->getValue(
            'design/head/shortcut_icon',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        $path = $folderName . '/' . $scopeConfig;
        $faviconUrl = $this->storeManager->getStore()
                ->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_MEDIA) . $path;

        if ($scopeConfig !== null && $this->checkIsFile($path)) {
            return $faviconUrl;
        }

        return false;
    }

Field Documentation

$faviconFile

$faviconFile

protected

Definition at line 18 of file Favicon.php.

$fileStorageDatabase

$fileStorageDatabase

protected

Definition at line 33 of file Favicon.php.

$mediaDirectory

$mediaDirectory

protected

Definition at line 38 of file Favicon.php.

$scopeConfig

$scopeConfig

protected

Definition at line 28 of file Favicon.php.

$storeManager

$storeManager

protected

Definition at line 23 of file Favicon.php.

---

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

• vendor/magento/module-theme/Model/Favicon/Favicon.php