Inheritance diagram for Theme:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\View\Design\Theme\FlyweightFactory $themeFactory, \Magento\Framework\View\Design\Theme\Domain\Factory $domainFactory, \Magento\Framework\View\Design\Theme\ImageFactory $imageFactory, \Magento\Framework\View\Design\Theme\Validator $validator, \Magento\Framework\View\Design\Theme\CustomizationFactory $customizationFactory, \Magento\Theme\Model\ResourceModel\Theme $resource=null, ThemeCollection $resourceCollection=null, array $data=[], ThemeFactory $themeModelFactory=null)

	getThemeImage ()

	getCustomization ()

	isDeletable ()

	isEditable ()

	isVirtual ()

	isPhysical ()

	isVisible ()

	hasChildThemes ()

	getStagingVersion ()

	getParentTheme ()

	getArea ()

	getThemePath ()

	getFullPath ()

	getCode ()

	getDomainModel ($type=null)

	beforeSave ()

	afterDelete ()

	getInheritedThemes ()

	toArray (array $keys=[])

	populateFromArray (array $data)

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from ThemeInterface
	getId ()

Protected Member Functions
	_construct ()

	_validate ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'theme'

	$_eventObject = 'theme'

	$_themeFactory

	$_domainFactory

	$_imageFactory

	$_validator

	$_customization

	$_customFactory

	$inheritanceSequence

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from ThemeInterface
const	PATH_SEPARATOR = '/'

const	CODE_SEPARATOR = '/'

const	TYPE_PHYSICAL = 0

const	TYPE_VIRTUAL = 1

const	TYPE_STAGING = 2

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Theme model class

@method string getPackageCode() @method string getParentThemePath() @method string getParentId() @method string getThemeTitle() @method string getPreviewImage() @method bool getIsFeatured() @method int getThemeId() @method int getType() @method array getAssignedStores() @method ThemeInterface setAssignedStores(array $stores) @method ThemeInterface setParentId(int $id) @method ThemeInterface setParentTheme($parentTheme) @method ThemeInterface setPackageCode(string $packageCode) @method ThemeInterface setThemeCode(string $themeCode) @method ThemeInterface setThemePath(string $themePath) @method ThemeInterface setThemeTitle(string $themeTitle) @method ThemeInterface setType(int $type) @method ThemeInterface setCode(string $code)

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 36 of file Theme.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\View\Design\Theme\FlyweightFactory	$themeFactory,
		\Magento\Framework\View\Design\Theme\Domain\Factory	$domainFactory,
		\Magento\Framework\View\Design\Theme\ImageFactory	$imageFactory,
		\Magento\Framework\View\Design\Theme\Validator	$validator,
		\Magento\Framework\View\Design\Theme\CustomizationFactory	$customizationFactory,
		\Magento\Theme\Model\ResourceModel\Theme	$resource = `null`,
		ThemeCollection	$resourceCollection = `null`,
		array	$data = `[]`,
		ThemeFactory	$themeModelFactory = `null`
	)

Initialize dependencies

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\View\Design\Theme\FlyweightFactory	$themeFactory
\Magento\Framework\View\Design\Theme\Domain\Factory	$domainFactory
\Magento\Framework\View\Design\Theme\ImageFactory	$imageFactory
\Magento\Framework\View\Design\Theme\Validator	$validator
\Magento\Framework\View\Design\Theme\CustomizationFactory	$customizationFactory
\Magento\Theme\Model\ResourceModel\Theme	$resource
\Magento\Theme\Model\ResourceModel\Theme\Collection	$resourceCollection
array	$data
ThemeFactory	$themeModelFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 108 of file Theme.php.

       {
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
         $this->_themeFactory = $themeFactory;
         $this->_domainFactory = $domainFactory;
         $this->_imageFactory = $imageFactory;
         $this->_validator = $validator;
         $this->_customFactory = $customizationFactory;
         $this->themeModelFactory = $themeModelFactory ?: ObjectManager::getInstance()->get(ThemeFactory::class);
         $this->addData(['type' => self::TYPE_VIRTUAL]);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Init resource model

Returns: void

Definition at line 136 of file Theme.php.

     {
         $this->_init(\Magento\Theme\Model\ResourceModel\Theme::class);
     }

◆ _validate()

_validate ( )

protected

Validate theme data

Returns: $this

Exceptions

Definition at line 333 of file Theme.php.

     {
         if (!$this->_validator->validate($this)) {
             $messages = $this->_validator->getErrorMessages();
             throw new \Magento\Framework\Exception\LocalizedException(__(implode(PHP_EOL, reset($messages))));
         }
         return $this;
     }

◆ afterDelete()

afterDelete ( )

Update all relations after deleting theme

Returns: $this

Definition at line 358 of file Theme.php.

     {
         $stagingVersion = $this->getStagingVersion();
         if ($stagingVersion) {
             $stagingVersion->delete();
         }
         $this->getCollection()->updateChildRelations($this);
         return parent::afterDelete();
     }

◆ beforeSave()

beforeSave ( )

Before theme save

Returns: $this

Definition at line 347 of file Theme.php.

     {
         $this->_validate();
         return parent::beforeSave();
     }

◆ getArea()

getArea ( )

{Retrieve code of an area a theme belongs to

Returns: string

}

Implements ThemeInterface.

Definition at line 266 of file Theme.php.

     {
         // In order to support environment emulation of area, if area is set, return it
         if ($this->getData('area') && !$this->_appState->isAreaCodeEmulated()) {
             return $this->getData('area');
         }
         return $this->_appState->getAreaCode();
     }

◆ getCode()

getCode ( )

{Get code of the theme

Returns: string

}

Implements ThemeInterface.

Definition at line 299 of file Theme.php.

     {
         return (string)$this->getData('code');
     }

◆ getCustomization()

getCustomization ( )

Returns: \Magento\Framework\View\Design\Theme\Customization

Definition at line 154 of file Theme.php.

     {
         if ($this->_customization === null) {
             $this->_customization = $this->_customFactory->create(['theme' => $this]);
         }
         return $this->_customization;
     }

◆ getDomainModel()

getDomainModel ( $type = null )

Get one of theme domain models

Parameters

int | null $type

Returns: \Magento\Theme\Model\Theme\Domain\Virtual|\Magento\Theme\Model\Theme\Domain\Staging

Exceptions

Definition at line 311 of file Theme.php.

     {
         if ($type !== null && $type != $this->getType()) {
             throw new \InvalidArgumentException(
                 sprintf(
                     'Invalid domain model "%s" requested for theme "%s" of type "%s"',
                     $type,
                     $this->getId(),
                     $this->getType()
                 )
             );
         }
 
         return $this->_domainFactory->create($this);
     }

◆ getFullPath()

getFullPath ( )

Retrieve theme full path which is used to distinguish themes if they are not in DB yet

Alternative id looks like "<area>/<theme_path>". Used as id in file-system theme collection

Returns: string|null

Implements ThemeInterface.

Definition at line 291 of file Theme.php.

     {
         return $this->getThemePath() ? $this->getArea() . self::PATH_SEPARATOR . $this->getThemePath() : null;
     }

◆ getInheritedThemes()

getInheritedThemes ( )

Return the full theme inheritance sequence, from the root theme till a specified one

Returns: ThemeInterface[]

Implements ThemeInterface.

Definition at line 373 of file Theme.php.

     {
         if (null === $this->inheritanceSequence) {
             $theme = $this;
             $result = [];
             while ($theme) {
                 $result[] = $theme;
                 $theme = $theme->getParentTheme();
             }
             $this->inheritanceSequence = array_reverse($result);
         }
         return $this->inheritanceSequence;
     }

◆ getParentTheme()

getParentTheme ( )

{Retrieve parent theme instance

Returns: ThemeInterface|null

}

Implements ThemeInterface.

Definition at line 249 of file Theme.php.

     {
         if ($this->hasData('parent_theme')) {
             return $this->getData('parent_theme');
         }
 
         $theme = null;
         if ($this->getParentId()) {
             $theme = $this->_themeFactory->create($this->getParentId());
         }
         $this->setParentTheme($theme);
         return $theme;
     }

◆ getStagingVersion()

getStagingVersion ( )

Retrieve theme instance representing the latest changes to a theme

Returns: Theme|null

Definition at line 232 of file Theme.php.

     {
         if ($this->getId()) {
             $collection = $this->getCollection();
             $collection->addFieldToFilter('parent_id', $this->getId());
             $collection->addFieldToFilter('type', self::TYPE_STAGING);
             $stagingTheme = $collection->getFirstItem();
             if ($stagingTheme->getId()) {
                 return $stagingTheme;
             }
         }
         return null;
     }

◆ getThemeImage()

getThemeImage ( )

Get theme image model

Returns: \Magento\Framework\View\Design\Theme\Image

Definition at line 146 of file Theme.php.

     {
         return $this->_imageFactory->create(['theme' => $this]);
     }

◆ getThemePath()

getThemePath ( )

{Retrieve theme path unique within an area

Returns: string

}

Implements ThemeInterface.

Definition at line 278 of file Theme.php.

     {
         return $this->getData('theme_path');
     }

◆ hasChildThemes()

hasChildThemes ( )

Check is theme has child virtual themes

Returns: bool

Definition at line 217 of file Theme.php.

     {
         return (bool)$this->getCollection()->addTypeFilter(
             self::TYPE_VIRTUAL
         )->addFieldToFilter(
             'parent_id',
             ['eq' => $this->getId()]
         )->getSize();
     }

◆ isDeletable()

isDeletable ( )

Check if theme is deletable

Returns: bool

Definition at line 167 of file Theme.php.

     {
         return $this->isEditable();
     }

◆ isEditable()

isEditable ( )

Check if theme is editable

Returns: bool

Definition at line 177 of file Theme.php.

     {
         return self::TYPE_PHYSICAL != $this->getType();
     }

◆ isPhysical()

isPhysical ( )

Check if theme is physical

Returns: bool

Implements ThemeInterface.

Definition at line 197 of file Theme.php.

     {
         return $this->getType() == self::TYPE_PHYSICAL;
     }

◆ isVirtual()

isVirtual ( )

Check if theme is virtual

Returns: bool

Definition at line 187 of file Theme.php.

     {
         return $this->getType() == self::TYPE_VIRTUAL;
     }

◆ isVisible()

isVisible ( )

Check theme is visible in backend

Returns: bool

Definition at line 207 of file Theme.php.

     {
         return in_array($this->getType(), [self::TYPE_PHYSICAL, self::TYPE_VIRTUAL]);
     }

◆ populateFromArray()

populateFromArray ( array $data )

Populate Theme object from an array

Parameters

array $data

Returns: Theme

Definition at line 412 of file Theme.php.

     {
         $this->_data = $data;
         if (isset($data['parent_theme'])) {
             $this->_data['parent_theme'] = $this->createThemeInstance()->populateFromArray($data['parent_theme']);
         }
 
         if (isset($data['inherited_themes'])) {
             foreach ($data['inherited_themes'] as $key => $inheritedTheme) {
                 $themeInstance = $this->createThemeInstance()->populateFromArray($inheritedTheme);
                 $this->_data['inherited_themes'][$key] = $themeInstance;
             }
         }
 
         return $this;
     }

◆ toArray()

toArray ( array $keys = [] )

Definition at line 390 of file Theme.php.

     {
         $data = parent::toArray($keys);
         if (isset($data['parent_theme'])) {
             $data['parent_theme'] = $this->getParentTheme()->toArray();
         }
 
         if (isset($data['inherited_themes'])) {
             foreach ($data['inherited_themes'] as $key => $inheritedTheme) {
                 $data['inherited_themes'][$key] = $inheritedTheme->toArray();
             }
         }
 
         return $data;
     }

Field Documentation

◆ $_customFactory

$_customFactory

protected

Definition at line 80 of file Theme.php.

◆ $_customization

$_customization

protected

Definition at line 75 of file Theme.php.

◆ $_domainFactory

$_domainFactory

protected

Definition at line 60 of file Theme.php.

◆ $_eventObject

$_eventObject = 'theme'

protected

Definition at line 50 of file Theme.php.

◆ $_eventPrefix

$_eventPrefix = 'theme'

protected

Definition at line 43 of file Theme.php.

◆ $_imageFactory

$_imageFactory

protected

Definition at line 65 of file Theme.php.

◆ $_themeFactory

$_themeFactory

protected

Definition at line 55 of file Theme.php.

◆ $_validator

$_validator

protected

Definition at line 70 of file Theme.php.

◆ $inheritanceSequence

$inheritanceSequence

protected

Definition at line 90 of file Theme.php.

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

vendor/magento/module-theme/Model/Theme.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ _validate()

◆ afterDelete()

◆ beforeSave()

◆ getArea()

◆ getCode()

◆ getCustomization()

◆ getDomainModel()

◆ getFullPath()

◆ getInheritedThemes()

◆ getParentTheme()

◆ getStagingVersion()

◆ getThemeImage()

◆ getThemePath()

◆ hasChildThemes()

◆ isDeletable()

◆ isEditable()

◆ isPhysical()

◆ isVirtual()

◆ isVisible()

◆ populateFromArray()

◆ toArray()

Field Documentation

◆ $_customFactory

◆ $_customization

◆ $_domainFactory

◆ $_eventObject

◆ $_eventPrefix

◆ $_imageFactory

◆ $_themeFactory

◆ $_validator

◆ $inheritanceSequence