How are new design themes registered on «bin/magento setup:upgrade»?

dmitry_fedyuk · May 6, 2017, 10:14pm

Step 1. Magento\Theme\Setup\RecurringData::install()

magento/magento2/blob/2.1.6/app/code/Magento/Theme/Setup/RecurringData.php#L39-L42


public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
{
    $this->themeRegistration->register();
}

Step 2. Magento\Theme\Model\Theme\Registration::register()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Theme/Model/Theme/Registration.php#L63-L79


/**
 * Theme registration
 *
 * @return $this
 */
public function register()
{
    $this->_themeCollection->clear();


    foreach ($this->_themeCollection as $theme) {
        $this->_registerThemeRecursively($theme);
    }


    $this->checkPhysicalThemes()->checkAllowedThemeRelations();


    return $this;
}

Step 3A. (Magento 2.2) Magento\Framework\View\Design\Theme\ThemeList::loadData()

github.com

magento/magento2/blob/62667cb6/lib/internal/Magento/Framework/View/Design/Theme/ThemeList.php#L137-L168


/**
 * Fill collection with theme model loaded from filesystem
 *
 * @param bool $printQuery
 * @param bool $logQuery
 * @return $this
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function loadData($printQuery = false, $logQuery = false)
{
    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;
}

Step 3B. (Magento 2.1.6) Magento\Theme\Model\Theme\Collection::loadData()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Theme/Model/Theme/Collection.php#L140-L171


/**
 * Fill collection with theme model loaded from filesystem
 *
 * @param bool $printQuery
 * @param bool $logQuery
 * @return $this
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function loadData($printQuery = false, $logQuery = false)
{
    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;
}

Step 4. Magento\Framework\View\Design\Theme\ThemePackageList::getThemes()

github.com

magento/magento2/blob/2.1.6/lib/internal/Magento/Framework/View/Design/Theme/ThemePackageList.php#L58-L70


/**
 * Get all themes
 *
 * @return ThemePackage[]
 */
public function getThemes()
{
    $themes = [];
    foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::THEME) as $key => $path) {
        $themes[$key] = $this->factory->create($key, $path);
    }
    return $themes;
}

Step 5. Magento\Theme\Model\Theme\Registration::_registerThemeRecursively()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Theme/Model/Theme/Registration.php#L81-L117


/**
 * Register theme and recursively all its ascendants
 * Second param is optional and is used to prevent circular references in inheritance chain
 *
 * @param ThemeInterface &$theme
 * @param array $inheritanceChain
 * @return $this
 * @throws LocalizedException
 */
protected function _registerThemeRecursively(&$theme, $inheritanceChain = [])
{
    if ($theme->getId()) {
        return $this;
    }
    $themeModel = $this->getThemeFromDb($theme->getFullPath());
    if ($themeModel->getId()) {
        $theme = $themeModel;
        return $this;
    }


    $tempId = $theme->getFullPath();
    if (in_array($tempId, $inheritanceChain)) {
        throw new LocalizedException(__('Circular-reference in theme inheritance detected for "%1"', $tempId));
    }
    $inheritanceChain[] = $tempId;
    $parentTheme = $theme->getParentTheme();
    if ($parentTheme) {
        $this->_registerThemeRecursively($parentTheme, $inheritanceChain);
        $theme->setParentId($parentTheme->getId());
    }


    $this->_savePreviewImage($theme);
    $theme->setType(ThemeInterface::TYPE_PHYSICAL);
    $theme->save();


    return $this;
}