Inheritance diagram for ThemeList:

Public Member Functions
	__construct (\Magento\Framework\Data\Collection\EntityFactory $entityFactory, \Magento\Framework\Config\ThemeFactory $themeConfigFactory, ThemePackageList $themePackageList, ReadFactory $dirReadFactory)

	addConstraint ($type, $value)

	resetConstraints ()

	loadData ($printQuery=false, $logQuery=false)

	toOptionArray ($addEmptyField=false)

	hasTheme (ThemeInterface $theme)

	getThemeByFullPath ($fullPath)

Public Member Functions inherited from Collection
	__construct (EntityFactoryInterface $entityFactory)

	addFilter ($field, $value, $type='and')

	addFieldToFilter ($field, $condition)

	getFilter ($field)

	isLoaded ()

	getCurPage ($displacement=0)

	getLastPageNumber ()

	getPageSize ()

	getSize ()

	getFirstItem ()

	getLastItem ()

	getItems ()

	getColumnValues ($colName)

	getItemsByColumnValue ($column, $value)

	getItemByColumnValue ($column, $value)

	addItem (\Magento\Framework\DataObject $item)

	getAllIds ()

	removeItemByKey ($key)

	removeAllItems ()

	clear ()

	walk ($callback, array $args=[])

	each ($objMethod, $args=[])

	setDataToAll ($key, $value=null)

	setCurPage ($page)

	setPageSize ($size)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	setItemObjectClass ($className)

	getNewEmptyItem ()

	distinct ($flag)

	loadData ($printQuery=false, $logQuery=false)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	toXml ()

	toArray ($arrRequiredFields=[])

	toOptionArray ()

	toOptionHash ()

	getItemById ($idValue)

	getIterator ()

	count ()

	getFlag ($flag)

	setFlag ($flag, $value=null)

	hasFlag ($flag)

	__sleep ()

	__wakeup ()

Data Fields
const	CONSTRAINT_AREA = 'area'

const	CONSTRAINT_VENDOR = 'vendor'

const	CONSTRAINT_THEME_NAME = 'theme_name'

Data Fields inherited from Collection
const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Protected Member Functions
	_loadFromFilesystem (array $themes)

	_preparePathData ($themePackage)

	_prepareConfigurationData ($themePackage)

	_clearFilters ()

	_getConfigModel ($themePackage)

	_getItemId (\Magento\Framework\DataObject $item)

Protected Member Functions inherited from Collection
	_setIsLoaded ($flag=true)

	_addItem ($item)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderOrders ()

	_renderLimit ()

	_toOptionArray ($valueField='id', $labelField='name', $additional=[])

	_toOptionHash ($valueField='id', $labelField='name')

Protected Attributes
	$_itemObjectClass = ThemeInterface::class

	$themeConfigFactory

Protected Attributes inherited from Collection
	$_items = []

	$_itemObjectClass = \Magento\Framework\DataObject::class

	$_orders = []

	$_filters = []

	$_isFiltersRendered = false

	$_curPage = 1

	$_pageSize = false

	$_totalRecords

	$_isCollectionLoaded

	$_flags = []

	$_entityFactory

Detailed Description

Theme filesystem collection

Definition at line 14 of file ThemeList.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Data\Collection\EntityFactory	$entityFactory,
		\Magento\Framework\Config\ThemeFactory	$themeConfigFactory,
		ThemePackageList	$themePackageList,
		ReadFactory	$dirReadFactory
	)

Constructor

Parameters

\Magento\Framework\Data\Collection\EntityFactory	$entityFactory
\Magento\Framework\Config\ThemeFactory	$themeConfigFactory
ThemePackageList	$themePackageList
ReadFactory	$dirReadFactory

Definition at line 80 of file ThemeList.php.

       {
         parent::__construct($entityFactory);
         $this->themeConfigFactory = $themeConfigFactory;
         $this->themePackageList = $themePackageList;
         $this->dirReadFactory = $dirReadFactory;
     }

Member Function Documentation

◆ _clearFilters()

_clearFilters ( )

protected

Clear all added filters

Returns: $this

Definition at line 287 of file ThemeList.php.

     {
         $this->_filters = [];
         return $this;
     }

◆ _getConfigModel()

_getConfigModel ( $themePackage )

protected

Return configuration model for the theme

Parameters

ThemePackage $themePackage

Returns: \Magento\Framework\Config\Theme

Definition at line 299 of file ThemeList.php.

     {
         $themeDir = $this->dirReadFactory->create($themePackage->getPath());
         if ($themeDir->isExist('theme.xml')) {
             $configContent = $themeDir->readFile('theme.xml');
         } else {
             $configContent = '';
         }
         return $this->themeConfigFactory->create(['configContent' => $configContent]);
     }

◆ _getItemId()

_getItemId ( \Magento\Framework\DataObject $item )

protected

Retrieve item id

Parameters

\Magento\Framework\DataObject $item

Returns: string

Definition at line 316 of file ThemeList.php.

     {
         return $item->getFullPath();
     }

◆ _loadFromFilesystem()

_loadFromFilesystem ( array $themes )

protected

Load themes collection from file system

Parameters

ThemePackage[] $themes

Returns: $this

Definition at line 197 of file ThemeList.php.

     {
         foreach ($themes as $themePackage) {
             $theme = $this->getNewEmptyItem()->addData($this->_prepareConfigurationData($themePackage));
             $this->addItem($theme);
         }
         $this->_setIsLoaded();
 
         return $this;
     }

◆ _prepareConfigurationData()

_prepareConfigurationData ( $themePackage )

protected

Return default configuration data

Parameters

ThemePackage $themePackage

Returns: array

Definition at line 230 of file ThemeList.php.

     {
         $themeConfig = $this->_getConfigModel($themePackage);
         $pathData = $this->_preparePathData($themePackage);
         $media = $themeConfig->getMedia();
 
         $parentPathPieces = $themeConfig->getParentTheme();
         if (is_array($parentPathPieces) && count($parentPathPieces) == 1) {
             $pathPieces = $pathData['theme_path_pieces'];
             array_pop($pathPieces);
             $parentPathPieces = array_merge($pathPieces, $parentPathPieces);
         }
 
         $themePath = implode(ThemeInterface::PATH_SEPARATOR, $pathData['theme_path_pieces']);
         $themeCode = implode(ThemeInterface::CODE_SEPARATOR, $pathData['theme_path_pieces']);
         $parentPath = $parentPathPieces ? implode(ThemeInterface::PATH_SEPARATOR, $parentPathPieces) : null;
 
         return [
             'parent_id' => null,
             'type' => ThemeInterface::TYPE_PHYSICAL,
             'area' => $themePackage->getArea(),
             'theme_path' => $themePath,
             'code' => $themeCode,
             'theme_title' => $themeConfig->getThemeTitle(),
             'preview_image' => $media['preview_image'] ? $media['preview_image'] : null,
             'parent_theme_path' => $parentPath
         ];
     }

◆ _preparePathData()

_preparePathData ( $themePackage )

protected

Return default path related data

Parameters

ThemePackage $themePackage

Returns: array

Definition at line 214 of file ThemeList.php.

     {
         return [
             'theme_path_pieces' => [
                 $themePackage->getVendor(),
                 $themePackage->getName(),
             ]
         ];
     }

◆ addConstraint()

addConstraint	(	$type,
		$value
	)

Add constraint for the collection loading

See CONSTRAINT_* constants for supported types

Parameters

string	$type
string	$value

Returns: void

Definition at line 101 of file ThemeList.php.

     {
         if (!isset($this->constraints[$type])) {
             throw new \UnexpectedValueException("Constraint '$type' is not supported");
         }
         if ($this->isLoaded()) {
             $this->clear();
         }
         $this->constraints[$type][] = $value;
         $this->constraints[$type] = array_unique($this->constraints[$type]);
     }

◆ getThemeByFullPath()

getThemeByFullPath ( $fullPath )

Get theme from file system by area and theme_path

Parameters

string $fullPath

Returns: ThemeInterface

Implements ListInterface.

Definition at line 351 of file ThemeList.php.

     {
         list($area, $themePath) = explode('/', $fullPath, 2);
         $this->addConstraint(self::CONSTRAINT_AREA, $area);
         $this->addFilter('theme_path', $themePath);
 
         return $this->getFirstItem();
     }

◆ hasTheme()

hasTheme ( ThemeInterface $theme )

Checks that a theme present in filesystem collection

Parameters

ThemeInterface $theme

Returns: bool

Definition at line 339 of file ThemeList.php.

     {
         $themeItems = $this->getItems();
         return $theme->getThemePath() && isset($themeItems[$theme->getFullPath()]);
     }

◆ loadData()

loadData	(	$printQuery = `false`,
		$logQuery = `false`
	)

Fill collection with theme model loaded from filesystem

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 145 of file ThemeList.php.

     {
         if ($this->isLoaded()) {
             return $this;
         }
 
         $themes = [];
         foreach ($this->themePackageList->getThemes() as $themePackage) {
             if ($this->isAcceptable(self::CONSTRAINT_AREA, $themePackage->getArea())
                 && $this->isAcceptable(self::CONSTRAINT_VENDOR, $themePackage->getVendor())
                 && $this->isAcceptable(self::CONSTRAINT_THEME_NAME, $themePackage->getName())
             ) {
                 $themes[] = $themePackage;
             }
         }
 
         $this->_loadFromFilesystem($themes);
         $this->resetConstraints();
         $this->_updateRelations()
             ->_renderFilters()
             ->_clearFilters();
 
         return $this;
     }

◆ resetConstraints()

resetConstraints ( )

Reset constraints for the collection loading

Returns: void

Definition at line 118 of file ThemeList.php.

     {
         foreach (array_keys($this->constraints) as $key) {
             $this->constraints[$key] = [];
         }
     }

◆ toOptionArray()

toOptionArray ( $addEmptyField = false )

Return array for select field

Parameters

bool $addEmptyField

Returns: array

Definition at line 327 of file ThemeList.php.

     {
         $optionArray = $addEmptyField ? ['' => ''] : [];
         return $optionArray + $this->_toOptionArray('theme_id', 'theme_title');
     }

Field Documentation

◆ $_itemObjectClass

$_itemObjectClass = ThemeInterface::class

protected

Definition at line 40 of file ThemeList.php.

◆ $themeConfigFactory

Magento Framework Config ThemeFactory $themeConfigFactory

protected

Definition at line 45 of file ThemeList.php.

◆ CONSTRAINT_AREA

const CONSTRAINT_AREA = 'area'

Area constraint type

Definition at line 19 of file ThemeList.php.

◆ CONSTRAINT_THEME_NAME

const CONSTRAINT_THEME_NAME = 'theme_name'

Theme name constraint type

For example, "blank" part for theme "frontend/Magento/blank"

Definition at line 33 of file ThemeList.php.

◆ CONSTRAINT_VENDOR

const CONSTRAINT_VENDOR = 'vendor'

Vendor constraint type

For example, "Magento" part for theme "frontend/Magento/blank"

Definition at line 26 of file ThemeList.php.

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

vendor/magento/framework/View/Design/Theme/ThemeList.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _clearFilters()

◆ _getConfigModel()

◆ _getItemId()

◆ _loadFromFilesystem()

◆ _prepareConfigurationData()

◆ _preparePathData()

◆ addConstraint()

◆ getThemeByFullPath()

◆ hasTheme()

◆ loadData()

◆ resetConstraints()

◆ toOptionArray()

Field Documentation

◆ $_itemObjectClass

◆ $themeConfigFactory

◆ CONSTRAINT_AREA

◆ CONSTRAINT_THEME_NAME

◆ CONSTRAINT_VENDOR