class.ilStyleDefinition.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilStyleDefinition
{
    public static string $current_style;

    public static ?array $skins = null;

    protected ilSkin $skin;

    protected static array $cached_all_styles_information;

    protected ilSystemStyleConfig $system_style_config;

    protected ilSkinFactory $skin_factory;

    public function __construct(string $skin_id = '', ilSystemStyleConfig $system_style_config = null)
    {
        global $DIC;

        if ($skin_id == '') {
            $skin_id = self::getCurrentSkin();
        }

        if (!$system_style_config) {
            $this->setSystemStylesConf(new ilSystemStyleConfig());
        } else {
            $this->setSystemStylesConf($system_style_config);
        }

        $this->skin_factory = new ilSkinFactory($DIC->language(), $this->getSystemStylesConf());

        if ($skin_id != $this->getSystemStylesConf()->getDefaultSkinId()) {
            $this->setSkin($this->skin_factory->skinFromXML($this->getSystemStylesConf()->getCustomizingSkinPath() . $skin_id . '/template.xml'));
        } else {
            $this->setSkin($this->skin_factory->skinFromXML($this->getSystemStylesConf()->getDefaultTemplatePath()));
        }
    }

    public static function getCurrentSkin(): ?string
    {
        global $DIC;

        if (!$DIC || is_array($DIC)) {
            return null;
        }
        if ($DIC->isDependencyAvailable('systemStyle') && is_object($DIC->systemStyle()->getSkin())) {
            return $DIC->systemStyle()->getSkin()->getId();
        } else {
            $system_style_conf = new ilSystemStyleConfig();

            if ($DIC->isDependencyAvailable('user') && is_object($DIC->user()) && property_exists(
                $DIC->user(),
                'skin'
            )) {
                $skin_id = $DIC->user()->skin;
                if ($skin_id && !self::skinExists($skin_id)) {
                    if($DIC->isDependencyAvailable('systemStyle')) {
                        $messages = new ilSystemStyleMessageStack($DIC->ui()->mainTemplate());
                        $message_text = $DIC->language()->txt('set_skin_does_not_exist') . ' ' . $skin_id;
                        $messages->addMessage(new ilSystemStyleMessage($message_text, ilSystemStyleMessage::TYPE_ERROR));
                        $messages->sendMessages();
                    }
                    $skin_id = $system_style_conf->getDefaultSkinId();
                }
                return $skin_id === '' ? $system_style_conf->getDefaultSkinId() : $skin_id;
            } else {
                return null;
            }
        }
    }

    public function getStyles(): array
    {
        return $this->getSkin()->getStyles();
    }

    public function getTemplateName(): string
    {
        return $this->getSkin()->getName();
    }

    public function getStyle(string $a_id): ilSkinStyle
    {
        return $this->getSkin()->getStyle($a_id);
    }

    public function getStyleName(string $a_id): string
    {
        return $this->getSkin()->getStyle($a_id)->getName();
    }

    public function getImageDirectory(string $style_id): string
    {
        if (!$style_id) {
            throw new ilSystemStyleException(ilSystemStyleException::NO_STYLE_ID, $style_id);
        }
        try {
            return $this->getSkin()->getStyle($style_id)->getImageDirectory();
        } catch (ilSystemStyleException $e) {
            throw new ilSystemStyleException(ilSystemStyleException::NOT_EXISTING_STYLE, $style_id);
        }
    }

    public function getSoundDirectory(string $style_id): string
    {
        return $this->getSkin()->getStyle($style_id)->getSoundDirectory();
    }

    public static function getAllSkins(?ilSystemStyleConfig $system_style_config = null): array
    {
        if (!self::$skins) {
            if (!$system_style_config) {
                $system_style_config = new ilSystemStyleConfig();
            }

            global $DIC;

            $skin_factory = new ilSkinFactory($DIC->language(), $system_style_config);

            $skins = [];
            $skins[$system_style_config->getDefaultSkinId()] = $skin_factory->skinFromXML($system_style_config->getDefaultTemplatePath());

            if (is_dir($system_style_config->getCustomizingSkinPath())) {
                $cust_skins_directory = new RecursiveDirectoryIterator(
                    $system_style_config->getCustomizingSkinPath(),
                    FilesystemIterator::SKIP_DOTS
                );
                foreach ($cust_skins_directory as $skin_folder) {
                    if ($skin_folder->isDir()) {
                        $template_path = $skin_folder->getRealPath() . '/template.xml';
                        if (file_exists($template_path)) {
                            $skin = $skin_factory->skinFromXML($template_path);
                            $skins[$skin->getId()] = $skin;
                        }
                    }
                }
            }

            self::setSkins($skins);
        }

        return self::$skins;
    }

    public static function skinExists(string $skin_id, ?ilSystemStyleConfig $system_style_config = null): bool
    {
        if (!$system_style_config) {
            $system_style_config = new ilSystemStyleConfig();
        }

        if ($skin_id == $system_style_config->getDefaultSkinId()) {
            if (is_file($system_style_config->getDefaultTemplatePath())) {
                return true;
            }
        } elseif (is_file($system_style_config->getCustomizingSkinPath() . $skin_id . '/template.xml')) {
            return true;
        }
        return false;
    }

    public static function getCurrentStyle(): ?string
    {
        global $DIC;

        if (isset(self::$current_style)) {
            return self::$current_style;
        }

        if (!$DIC || is_array($DIC) || !$DIC->isDependencyAvailable('user')) {
            return null;
        }

        if (array_key_exists('style', $DIC->user()->prefs) && $DIC->user()->prefs['style']) {
            self::setCurrentStyle($DIC->user()->prefs['style']);
        } else {
            $system_style_config = new ilSystemStyleConfig();
            self::setCurrentStyle($system_style_config->getDefaultStyleId());
        }

        if ($DIC->isDependencyAvailable('systemStyle') && self::styleExistsForCurrentSkin(self::$current_style)) {
            if ($DIC->systemStyle()->getSkin()->hasStyleSubstyles(self::$current_style)) {
                // read assignments, if given
                $assignments = ilSystemStyleSettings::getSystemStyleCategoryAssignments(
                    self::getCurrentSkin(),
                    self::$current_style
                );
                if (count($assignments) > 0) {
                    $ref_ass = [];
                    foreach ($assignments as $a) {
                        if ($DIC->systemStyle()->getSkin()->hasStyle($a['substyle'])) {
                            $ref_ass[$a['ref_id']] = $a['substyle'];
                        }
                    }

                    $ref_id = '';

                    if ($DIC->http()->wrapper()->query()->has('ref_id')) {
                        $ref_id = $DIC->http()->wrapper()->query()->retrieve(
                            'ref_id',
                            $DIC->refinery()->kindlyTo()->string()
                        );
                    } elseif ($DIC->http()->wrapper()->query()->has('target')) {
                        $target = $DIC->http()->wrapper()->query()->retrieve(
                            'target',
                            $DIC->refinery()->kindlyTo()->string()
                        );
                        $target_arr = explode('_', $target);
                        $ref_id = $target_arr[1] ?? '';
                    }

                    // check whether any ref id assigns a new style
                    if ($DIC->isDependencyAvailable('repositoryTree') && $ref_id && $DIC->repositoryTree()->isInTree((int) $ref_id)) {
                        $path = $DIC->repositoryTree()->getPathId((int) $ref_id);
                        for ($i = count($path) - 1; $i >= 0; $i--) {
                            if (isset($ref_ass[$path[$i]])) {
                                self::$current_style = $ref_ass[$path[$i]];
                                return self::$current_style;
                            }
                        }
                    }
                }
            }
        }

        if ($DIC->isDependencyAvailable('systemStyle') && !self::styleExistsForCurrentSkin(self::$current_style)) {
            $messages = new ilSystemStyleMessageStack($DIC->ui()->mainTemplate());
            $message_text = $DIC->language()->txt('set_style_does_not_exist') . ' ' . self::$current_style;
            $messages->addMessage(new ilSystemStyleMessage($message_text, ilSystemStyleMessage::TYPE_ERROR));
            $messages->sendMessages();
            $system_style_config = new ilSystemStyleConfig();
            self::setCurrentSkin($system_style_config->getDefaultSkinId());
            self::setCurrentStyle($system_style_config->getDefaultStyleId());
        }

        return self::$current_style;
    }

    public static function getAllSkinStyles(): ?array
    {
        global $DIC;

        if (!self::getCachedAllStylesInformation()) {
            $all_styles = [];

            $skins = $DIC->systemStyle()->getSkins();

            foreach ($skins as $skin) {
                foreach ($skin->getStyles() as $style) {
                    $num_users = ilObjUser::_getNumberOfUsersForStyle($skin->getId(), $style->getId());

                    $parent_name = '';
                    if ($style->getSubstyleOf()) {
                        $parent_name = $skin->getStyle($style->getSubstyleOf())->getName();
                    }

                    $version = $skin->getVersion();
                    if ($version == '$Id$') {
                        $version = '-';
                    }
                    // default selection list
                    $all_styles[$skin->getId() . ':' . $style->getId()] = [
                        'title' => $skin->getName() . ' / ' . $style->getName(),
                        'id' => $skin->getId() . ':' . $style->getId(),
                        'skin_id' => $skin->getId(),
                        'skin_name' => $skin->getName(),
                        'template_id' => $skin->getId(),
                        'template_name' => $skin->getName(),
                        'style_id' => $style->getId(),
                        'style_name' => $style->getName(),
                        'substyle_of' => $style->getSubstyleOf(),
                        'substyle_of_name' => $parent_name,
                        'users' => $num_users,
                        'version' => $version,
                    ];
                }
            }
            self::setCachedAllStylesInformation($all_styles);
        }

        return self::getCachedAllStylesInformation();
    }

    public static function setCurrentSkin(string $a_skin): void
    {
        global $DIC;

        if ($DIC->isDependencyAvailable('systemStyle') && $DIC->systemStyle()->getSkin()->getName() != $a_skin) {
            $styleDefinition = new ilStyleDefinition($a_skin);
            if (!self::styleExistsForCurrentSkin(self::$current_style)) {
                $styleDefinition->setCurrentStyle($DIC->systemStyle()->getSkin()->getDefaultStyle()->getId());
            }
        }
    }

    public static function styleExists(string $style_id): bool
    {
        foreach (self::getSkins() as $skin) {
            if ($skin->hasStyle($style_id)) {
                return true;
            }
        }
        return false;
    }

    public static function styleExistsForSkinId(string $skin_id, string $style_id): bool
    {
        global $DIC;

        if (!self::skinExists($skin_id)) {
            return false;
        }
        $factory = new ilSkinFactory($DIC->language());
        $skin = $factory->skinStyleContainerFromId($skin_id, new ilSystemStyleMessageStack($DIC->ui()->mainTemplate()))->getSkin();
        return $skin->hasStyle($style_id);
    }

    public static function styleExistsForCurrentSkin(string $style_id): bool
    {
        global $DIC;

        return $DIC->systemStyle()->getSkin()->hasStyle($style_id);
    }

    public static function setCurrentStyle(string $a_style): void
    {
        self::$current_style = $a_style;
    }

    public static function getSkins(): array
    {
        return self::getAllSkins();
    }

    public static function setSkins(array $skins): void
    {
        self::$skins = $skins;
    }

    public function getSkin(): ilSkin
    {
        return $this->skin;
    }

    public function setSkin(ilSkin $skin): void
    {
        $this->skin = $skin;
    }

    protected static function getCachedAllStylesInformation(): ?array
    {
        if (!isset(self::$cached_all_styles_information)) {
            return null;
        }
        return self::$cached_all_styles_information;
    }

    protected static function setCachedAllStylesInformation(array $cached_all_styles_information): void
    {
        self::$cached_all_styles_information = $cached_all_styles_information;
    }

    public function getSystemStylesConf(): ilSystemStyleConfig
    {
        return $this->system_style_config;
    }

    public function setSystemStylesConf(ilSystemStyleConfig $system_style_config)
    {
        $this->system_style_config = $system_style_config;
    }
}