class.ilSkinFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
use ILIAS\Language\Language;

class ilSkinFactory
{
    protected ilSystemStyleConfig $config;
    protected Language $lng;

    public function __construct(Language $lng, ?ilSystemStyleConfig $config = null)
    {
        $this->lng = $lng;

        if ($config) {
            $this->config = $config;
        } else {
            $this->config = new ilSystemStyleConfig();
        }
    }

    public function skinFromXML(string $path = ''): ilSkin
    {
        if (strpos($path, '../') === 0) { // we must resolve relative paths here
            $path = realpath(__DIR__ . '/../../../../../../templates/' . $path);
        }

        try {
            $xml = new SimpleXMLElement(file_get_contents($path));
        } catch (Exception) {
            throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $path);
        }

        $id = basename(dirname($path));
        $skin = new ilSkin($id, (string) $xml->attributes()['name']);
        $skin->setVersion((string) $xml->attributes()['version']);

        $last_style = null;

        foreach ($xml->children() as $style_xml) {
            $style = ilSkinStyle::parseFromXMLElement($style_xml);

            if ($style_xml->getName() == 'substyle') {
                if (!$last_style) {
                    throw new ilSystemStyleException(ilSystemStyleException::NO_PARENT_STYLE, $style->getId());
                }
                $style->setSubstyleOf($last_style->getId());
            } else {
                $last_style = $style;
            }
            $skin->addStyle($style);
        }
        return $skin;
    }

    public function skinStyleContainerFromId(
        string $skin_id,
        ilSystemStyleMessageStack $message_stack
    ): ilSkinStyleContainer {
        if (!$skin_id) {
            throw new ilSystemStyleException(ilSystemStyleException::NO_SKIN_ID);
        }

        if ($skin_id != 'default' && $skin_id != 'other') {
            return new ilSkinStyleContainer(
                $this->lng,
                $this->skinFromXML($this->config->getCustomizingSkinPath() . $skin_id . '/template.xml'),
                $message_stack,
                $this->config
            );
        } else {
            return new ilSkinStyleContainer(
                $this->lng,
                $this->skinFromXML($this->config->getDefaultTemplatePath()),
                $message_stack,
                $this->config,
            );
        }
    }
}