ilSkinStyleContainer Class Reference

This class is responsible for all file system related actions related actions of a skin such as copying files and folders, generating a new skin, deleting a skin etc. More...

Collaboration diagram for ilSkinStyleContainer:

Public Member Functions
	__construct (ilLanguage $lng, ilSkin $skin, ilSystemStyleMessageStack $message_stack, ilSystemStyleConfig $system_styles_conf=null, ilFileSystemHelper $file_system=null)
	create (ilSystemStyleMessageStack $message_stack)
	Creates a new skin. More...
	updateSkin (ilSkin $old_skin=null)
	Updates the skin. More...
	updateStyle (string $style_id, ilSkinStyle $old_style)
	Updates one single style. More...
	createMainScssFile (ilSkinStyle $style)
	Creates the main Scss file. More...
	copySettingsFromDefault (ilSkinStyle $style)
	Copies (resets) the settings files from delos. More...
	resetImages (ilSkinStyle $style)
	Copies (resets) the images from delos. More...
	copyCSSFromDefault (ilSkinStyle $style)
	Copies (resets) the images from delos. More...
	delete ()
	Deletes the container of a skin completely. More...
	deleteStyle (ilSkinStyle $style)
	Deletes a style completely. More...
	export ()
	Exports the complete skin to an zip file. More...
	createTempZip ()
	Creates a temp zip file. More...
	compileScss (string $style_id)
	getSkin ()
	setSkin (ilSkin $skin)
	getSkinDirectory ()
	getCSSFilePath (string $style_id)
	getScssFilePath (string $style_id)
	getScssSettingsPath (string $style_id)
	getScssSettingsFolderName ()
	getImagesStylePath (string $style_id)
	getSoundsStylePath (string $style_id)
	getFontsStylePath (string $style_id)
	getMessageStack ()
	setMessageStack (ilSystemStyleMessageStack $message_stack)
	addStyle (ilSkinStyle $style)
	getSystemStylesConf ()
	setSystemStylesConf (ilSystemStyleConfig $system_styles_conf)

Protected Member Functions
	createScssStructure (ilSkinStyle $style)
	Creates the Scss/css structure of a style. More...
	getNewMainScssFileContent (string $replacement_start, string $replacement_end)
	writeSkinToXML ()

Protected Attributes
ilLanguage	$lng
ilSkin	$skin
	Data-scope for the skin this container capsules. More...
ilSystemStyleMessageStack	$message_stack
	Used to stack messages to be displayed to the user (mostly reports for failed actions) More...
ilSystemStyleConfig	$system_styles_conf
	Used to wire this component up with the correct pathes into the customizing directory. More...
ilFileSystemHelper	$file_system

Detailed Description

This class is responsible for all file system related actions related actions of a skin such as copying files and folders, generating a new skin, deleting a skin etc.

It contains exactly one skin containing several styles. Use this class to parse a skin from xml.

Definition at line 26 of file class.ilSkinStyleContainer.php.

Constructor & Destructor Documentation

__construct()

ilSkinStyleContainer::__construct	(	ilLanguage	$lng,
		ilSkin	$skin,
		ilSystemStyleMessageStack	$message_stack,
		ilSystemStyleConfig	$system_styles_conf = null,
		ilFileSystemHelper	$file_system = null
	)

Definition at line 47 of file class.ilSkinStyleContainer.php.

References $file_system, $lng, $skin, ILIAS\Repository\lng(), setMessageStack(), and setSystemStylesConf().

      {
        $this->lng = $lng;
        $this->skin = $skin;
        $this->setMessageStack($message_stack);

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

        if (!$file_system) {
            $this->file_system = new ilFileSystemHelper($this->lng, $message_stack);
        } else {
            $this->file_system = $file_system;
        }
    }

Here is the call graph for this function:

Member Function Documentation

addStyle()

ilSkinStyleContainer::addStyle

(

ilSkinStyle

$style

)

Definition at line 492 of file class.ilSkinStyleContainer.php.

References ilSkinStyle\getId(), getSkin(), and updateStyle().

Referenced by ilSkinStyleContainerTest\testAddStyle(), and ilSkinStyleContainerTest\testAddSubstyle().

                                                : void
    {
        $this->getSkin()->addStyle($style);
        $old_style = new ilSkinStyle('', '', '-', '-', '-', '-');
        $this->updateStyle($style->getId(), $old_style);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

compileScss()

ilSkinStyleContainer::compileScss

(

string

$style_id

)

Exceptions

ilSystemStyleException

Definition at line 412 of file class.ilSkinStyleContainer.php.

References getCSSFilePath(), getScssFilePath(), ilSystemStyleException\SCSS_COMPILE_FAILED, and ilSystemStyleException\SCSS_NOT_INSTALLED.

Referenced by createScssStructure(), and updateStyle().

                                                 : void
    {
        if (!PATH_TO_SCSS) {
            throw new ilSystemStyleException(ilSystemStyleException::SCSS_NOT_INSTALLED);
        }

        $output = shell_exec(PATH_TO_SCSS . ' ' . $this->getScssFilePath($style_id));
        if (!$output) {
            $Scss_error = shell_exec(PATH_TO_SCSS . ' ' . $this->getScssFilePath($style_id) . ' 2>&1');
            if (!$Scss_error) {
                throw new ilSystemStyleException(
                    ilSystemStyleException::SCSS_COMPILE_FAILED,
                    'Empty css output, unknown error.'
                );
            }
            throw new ilSystemStyleException(ilSystemStyleException::SCSS_COMPILE_FAILED, $Scss_error);
        }
        file_put_contents($this->getCSSFilePath($style_id), $output);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyCSSFromDefault()

ilSkinStyleContainer::copyCSSFromDefault

(

ilSkinStyle

$style

)

Copies (resets) the images from delos.

Definition at line 317 of file class.ilSkinStyleContainer.php.

References getCSSFilePath(), ilSkinStyle\getId(), and getSystemStylesConf().

Referenced by createScssStructure().

                                                          : void
    {
        copy($this->getSystemStylesConf()->getDelosPath() . '.css', $this->getCSSFilePath($style->getId()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copySettingsFromDefault()

ilSkinStyleContainer::copySettingsFromDefault

(

ilSkinStyle

$style

)

Copies (resets) the settings files from delos.

Definition at line 281 of file class.ilSkinStyleContainer.php.

References ILIAS\LTI\ToolProvider\$settings, ilSkinStyle\getId(), getScssSettingsFolderName(), getScssSettingsPath(), getSkinDirectory(), and getSystemStylesConf().

Referenced by createScssStructure(), and updateStyle().

                                                               : ilSystemStyleScssSettings
    {
        if (is_dir($this->getScssSettingsPath($style->getId()))) {
            $this->file_system->removeResourceDirectory($this->getSkinDirectory(), $style->getId()."/".$this->getScssSettingsFolderName());
        }

        $this->file_system->createResourceDirectory(
            $this->getSystemStylesConf()->getDefaultSettingsPath(),
            $this->getScssSettingsPath($style->getId())
        );

        $settings = new ilSystemStyleScssSettings($this->getScssSettingsPath($style->getId()));

        $settings->readAndreplaceContentOfFolder([
            "@use \"../030-tools/" => "@use \"../../../../../../templates/default/030-tools/",
            "@use \"../050-layout/" => "@use \"../../../../../../templates/default/050-layout/"
        ]);

        return $settings;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilSkinStyleContainer::create

(

ilSystemStyleMessageStack

$message_stack

)

Creates a new skin.

This includes the generation of the XML and the corresponding folders of all contained styles.

Exceptions

ilSystemStyleException

Definition at line 75 of file class.ilSkinStyleContainer.php.

References getSkin(), getSkinDirectory(), ilSystemStyleException\SKIN_ALREADY_EXISTS, updateStyle(), and writeSkinToXML().

Referenced by ilSkinStyleContainerTest\testCreateDelete().

                                                                    : void
    {
        if (file_exists($this->getSkinDirectory())) {
            throw new ilSystemStyleException(ilSystemStyleException::SKIN_ALREADY_EXISTS, $this->getSkinDirectory());
        }

        mkdir($this->getSkinDirectory(), 0775, true);

        foreach ($this->getSkin()->getStyles() as $style) {
            $old_style = new ilSkinStyle('', '', '-', '-', '-', '-');
            $this->updateStyle($style->getId(), $old_style);
        }
        $this->writeSkinToXML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createMainScssFile()

ilSkinStyleContainer::createMainScssFile

(

ilSkinStyle

$style

)

Creates the main Scss file.

Definition at line 229 of file class.ilSkinStyleContainer.php.

References $path, ILIAS\LTI\ToolProvider\$settings, ilSkinStyle\getId(), getMessageStack(), getNewMainScssFileContent(), getScssFilePath(), getScssSettingsPath(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by createScssStructure(), and updateStyle().

                                                          : void
    {

        $replacement_start = "// ## Begin Replacement Variables";
        $replacement_end = "// ## End Replacement Variables";

        $path = $this->getScssFilePath($style->getId());

        if(!is_file($path)) {
            $main_scss_content = $this->getNewMainScssFileContent($replacement_start, $replacement_end);
        } else {
            $main_scss_content = file_get_contents($path);
        }

        $regex_part_to_replace_start = "%$replacement_start.*?$replacement_end%s";
        $settings = new ilSystemStyleScssSettings($this->getScssSettingsPath($style->getId()));
        $replacement = $settings->getVariablesForDelosOverride();
        $new_variabales_content = "$replacement_start $replacement $replacement_end";

        $main_scss_content = preg_replace(
            $regex_part_to_replace_start,
            $new_variabales_content,
            $main_scss_content
        );

        file_put_contents($path, $main_scss_content);

        $this->getMessageStack()->addMessage(
            new ilSystemStyleMessage(
                $this->lng->txt('main_scss_created') . ' ' . $path,
                ilSystemStyleMessage::TYPE_SUCCESS
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createScssStructure()

ilSkinStyleContainer::createScssStructure ( ilSkinStyle  $style )

protected

Creates the Scss/css structure of a style.

Exceptions

ilSystemStyleException

Definition at line 218 of file class.ilSkinStyleContainer.php.

References compileScss(), copyCSSFromDefault(), copySettingsFromDefault(), createMainScssFile(), and ilSkinStyle\getId().

                                                              : void
    {
        $this->copySettingsFromDefault($style);
        $this->createMainScssFile($style);
        $this->copyCSSFromDefault($style);
        $this->compileScss($style->getId());
    }

Here is the call graph for this function:

createTempZip()

ilSkinStyleContainer::createTempZip

(

)

Creates a temp zip file.

Definition at line 399 of file class.ilSkinStyleContainer.php.

References getSkin(), getSkinDirectory(), and ilFileUtils\zip().

Referenced by export(), and ilSkinFactoryTest\testImportSkin().

                                   : string
    {
        $skin_directory = $this->getSkinDirectory(); // parent of skin directory
        $output_file = dirname($skin_directory) . '/' . $this->getSkin()->getId() . '.zip';

        ilFileUtils::zip($skin_directory, $output_file, true);

        return $output_file;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilSkinStyleContainer::delete

(

)

Deletes the container of a skin completely.

Definition at line 325 of file class.ilSkinStyleContainer.php.

References getMessageStack(), getSkinDirectory(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by ilSkinStyleContainerTest\testCreateDelete(), and ilSkinStyleContainerTest\testDeleteSkin().

                            : void
    {
        $this->file_system->recursiveRemoveDir(self::getSkinDirectory());
        $this->getMessageStack()->addMessage(
            new ilSystemStyleMessage(
                $this->lng->txt('skin_deleted') . $this->getSkinDirectory(),
                ilSystemStyleMessage::TYPE_SUCCESS
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteStyle()

ilSkinStyleContainer::deleteStyle

(

ilSkinStyle

$style

)

Deletes a style completely.

Definition at line 339 of file class.ilSkinStyleContainer.php.

References ilSystemStyleSettings\deleteSubStyleCategoryAssignments(), getCSSFilePath(), ilSkinStyle\getFontDirectory(), ILIAS\Survey\Mode\getId(), ilSkinStyle\getId(), ilSkinStyle\getImageDirectory(), getMessageStack(), ilSkinStyle\getName(), getScssFilePath(), getSkin(), getSkinDirectory(), ilSkinStyle\getSoundDirectory(), ilSkinStyle\getSubstyleOf(), ilSkinStyle\isSubstyle(), ILIAS\Repository\lng(), ilSystemStyleMessage\TYPE_SUCCESS, and writeSkinToXML().

Referenced by ilSkinStyleContainerTest\testDeleteStyle().

                                                   : void
    {
        if ($style->isSubstyle()) {
            ilSystemStyleSettings::deleteSubStyleCategoryAssignments(
                $this->getSkin()->getId(),
                $style->getSubstyleOf(),
                $style->getId()
            );
            $this->getMessageStack()->prependMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt('style_assignments_deleted') . ' ' . $style->getName(),
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
        }

        $this->file_system->saveDeleteFile($this->getScssFilePath($style->getId()));
        $this->file_system->saveDeleteFile($this->getCSSFilePath($style->getId()));
        $this->file_system->removeResourceDirectory($this->getSkinDirectory(), $style->getId(), false);

        $this->getSkin()->removeStyle($style->getId());

        $this->file_system->removeResourceDirectory(
            $this->getSkinDirectory(),
            $style->getImageDirectory()
        );
        $this->file_system->removeResourceDirectory(
            $this->getSkinDirectory(),
            $style->getFontDirectory()
        );
        $this->file_system->removeResourceDirectory(
            $this->getSkinDirectory(),
            $style->getSoundDirectory()
        );

        $this->writeSkinToXML();
        $this->getMessageStack()->prependMessage(
            new ilSystemStyleMessage(
                $this->lng->txt('style_deleted') . ' ' . $style->getName(),
                ilSystemStyleMessage::TYPE_SUCCESS
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

export()

ilSkinStyleContainer::export

(

)

Exports the complete skin to an zip file.

Definition at line 386 of file class.ilSkinStyleContainer.php.

References createTempZip(), ilFileDelivery\deliverFileAttached(), ILIAS\Survey\Mode\getId(), and getSkin().

                            : void
    {
        ilFileDelivery::deliverFileAttached(
            $this->createTempZip(),
            $this->getSkin()->getId() . '.zip',
            '',
            true
        );
    }

Here is the call graph for this function:

getCSSFilePath()

ilSkinStyleContainer::getCSSFilePath

(

string

$style_id

)

Definition at line 447 of file class.ilSkinStyleContainer.php.

References getSkinDirectory().

Referenced by compileScss(), copyCSSFromDefault(), deleteStyle(), and updateStyle().

                                                    : string
    {
        return $this->getSkinDirectory() . $style_id . "/".$this->getSkin()->getStyle($style_id)->getCssFile() . '.css';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFontsStylePath()

ilSkinStyleContainer::getFontsStylePath

(

string

$style_id

)

Definition at line 477 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSkinDirectory().

Referenced by updateStyle().

                                                       : string
    {
        return $this->getSkinDirectory().$style_id."/".$this->getSkin()->getStyle($style_id)->getFontDirectory();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImagesStylePath()

ilSkinStyleContainer::getImagesStylePath

(

string

$style_id

)

Definition at line 467 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSkinDirectory().

Referenced by resetImages(), and updateStyle().

                                                        : string
    {
        return $this->getSkinDirectory().$style_id."/".$this->getSkin()->getStyle($style_id)->getImageDirectory();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMessageStack()

ilSkinStyleContainer::getMessageStack

(

)

Definition at line 482 of file class.ilSkinStyleContainer.php.

References $message_stack.

Referenced by createMainScssFile(), delete(), deleteStyle(), and updateStyle().

                                     : ilSystemStyleMessageStack
    {
        return $this->message_stack;
    }

Here is the caller graph for this function:

getNewMainScssFileContent()

ilSkinStyleContainer::getNewMainScssFileContent ( string  $replacement_start, string  $replacement_end  )

protected

Definition at line 264 of file class.ilSkinStyleContainer.php.

References getScssSettingsFolderName(), and getSystemStylesConf().

Referenced by createMainScssFile().

                                                                                                    : string
    {
        return "// # ITCSS structure
            // Try to apply changes by only changing the variables in the settings
            @use \"./" . $this->getScssSettingsFolderName() . "\" as globals;
            
            // Default Skin is loaded with the custom setting being applied.
            @use \"" . $this->getSystemStylesConf()->getRelDelosPath() . "\" with ( \n".
            $replacement_start . "\n" .
            $replacement_end . "\n" .
            ");" . "\n" .
            "// Apply/load other styling changes here.";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScssFilePath()

ilSkinStyleContainer::getScssFilePath

(

string

$style_id

)

Definition at line 452 of file class.ilSkinStyleContainer.php.

References getSkinDirectory().

Referenced by compileScss(), createMainScssFile(), deleteStyle(), and updateStyle().

                                                     : string
    {
        return $this->getSkinDirectory() . $style_id . "/".$this->getSkin()->getStyle($style_id)->getCssFile() . '.scss';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScssSettingsFolderName()

ilSkinStyleContainer::getScssSettingsFolderName

(

)

Definition at line 462 of file class.ilSkinStyleContainer.php.

Referenced by copySettingsFromDefault(), getNewMainScssFileContent(), and updateStyle().

                                               : string
    {
        return  $this->system_styles_conf->getScssSettingsFolderName();
    }

Here is the caller graph for this function:

getScssSettingsPath()

ilSkinStyleContainer::getScssSettingsPath

(

string

$style_id

)

Definition at line 457 of file class.ilSkinStyleContainer.php.

References getSkinDirectory().

Referenced by copySettingsFromDefault(), createMainScssFile(), and updateStyle().

                                                         : string
    {
        return $this->getSkinDirectory() . $style_id . "/".$this->getScssSettingsFolderName();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSkin()

ilSkinStyleContainer::getSkin

(

)

Definition at line 432 of file class.ilSkinStyleContainer.php.

References $skin.

Referenced by addStyle(), ilSkinFactory\copyFromSkinStyleContainer(), create(), createTempZip(), deleteStyle(), export(), getFontsStylePath(), getImagesStylePath(), getSkinDirectory(), getSoundsStylePath(), ilSkinStyleContainerTest\testAddSubstyle(), ilSkinFactoryTest\testCopySkin(), ilSkinFactoryTest\testCopySkinWithInjectedName(), ilSkinStyleContainerTest\testCreateDelete(), ilSkinStyleContainerTest\testDeleteSkin(), ilSkinFactoryTest\testImportSkin(), ilSkinFactoryTest\testSkinStyleContainerFromId(), ilSkinStyleContainerTest\testUpdateSkinWithChangedID(), ilSkinStyleContainerTest\testUpdateStyle(), updateSkin(), updateStyle(), and writeSkinToXML().

                             : ilSkin
    {
        return $this->skin;
    }

Here is the caller graph for this function:

getSkinDirectory()

ilSkinStyleContainer::getSkinDirectory

(

)

Definition at line 442 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSystemStylesConf().

Referenced by ilSkinFactory\copyFromSkinStyleContainer(), copySettingsFromDefault(), create(), createTempZip(), delete(), deleteStyle(), getCSSFilePath(), getFontsStylePath(), getImagesStylePath(), getScssFilePath(), getScssSettingsPath(), getSoundsStylePath(), updateSkin(), updateStyle(), and writeSkinToXML().

                                      : string
    {
        return $this->getSystemStylesConf()->getCustomizingSkinPath() . $this->getSkin()->getId() . '/';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSoundsStylePath()

ilSkinStyleContainer::getSoundsStylePath

(

string

$style_id

)

Definition at line 472 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSkinDirectory().

Referenced by updateStyle().

                                                        : string
    {
        return $this->getSkinDirectory().$style_id."/".$this->getSkin()->getStyle($style_id)->getSoundDirectory();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSystemStylesConf()

ilSkinStyleContainer::getSystemStylesConf

(

)

Definition at line 504 of file class.ilSkinStyleContainer.php.

References $system_styles_conf.

Referenced by copyCSSFromDefault(), ilSkinFactory\copyFromSkinStyleContainer(), copySettingsFromDefault(), getNewMainScssFileContent(), getSkinDirectory(), resetImages(), updateSkin(), and updateStyle().

                                         : ilSystemStyleConfig
    {
        return $this->system_styles_conf;
    }

Here is the caller graph for this function:

resetImages()

ilSkinStyleContainer::resetImages

(

ilSkinStyle

$style

)

Copies (resets) the images from delos.

Definition at line 305 of file class.ilSkinStyleContainer.php.

References ilSkinStyle\getId(), getImagesStylePath(), and getSystemStylesConf().

                                                   : void
    {
        $this->file_system->recursiveRemoveDir($this->getImagesStylePath($style->getId()));
        $this->file_system->createResourceDirectory(
            $this->getSystemStylesConf()->getDefaultImagesPath(),
            $this->getImagesStylePath($style->getId())
        );
    }

Here is the call graph for this function:

setMessageStack()

ilSkinStyleContainer::setMessageStack

(

ilSystemStyleMessageStack

$message_stack

)

Definition at line 487 of file class.ilSkinStyleContainer.php.

References $message_stack.

Referenced by __construct().

                                                                             : void
    {
        $this->message_stack = $message_stack;
    }

Here is the caller graph for this function:

setSkin()

ilSkinStyleContainer::setSkin

(

ilSkin

$skin

)

Definition at line 437 of file class.ilSkinStyleContainer.php.

References $skin.

                                         : void
    {
        $this->skin = $skin;
    }

setSystemStylesConf()

ilSkinStyleContainer::setSystemStylesConf

(

ilSystemStyleConfig

$system_styles_conf

)

Definition at line 509 of file class.ilSkinStyleContainer.php.

References $system_styles_conf.

Referenced by __construct().

                                                                                : void
    {
        $this->system_styles_conf = $system_styles_conf;
    }

Here is the caller graph for this function:

updateSkin()

ilSkinStyleContainer::updateSkin

(

ilSkin

$old_skin = null

)

Updates the skin.

Style are not updated, use updateStyle for that.

Exceptions

ilSystemStyleException

Definition at line 94 of file class.ilSkinStyleContainer.php.

References getSkin(), getSkinDirectory(), getSystemStylesConf(), and writeSkinToXML().

Referenced by ilSkinStyleContainerTest\testUpdateSkinNoIdChange(), and ilSkinStyleContainerTest\testUpdateSkinWithChangedID().

                                                       : void
    {
        if (!$old_skin) {
            $old_skin = $this->getSkin();
        }
        $old_customizing_skin_directory = $this->getSystemStylesConf()->getCustomizingSkinPath() . $old_skin->getId() . '/';

        //Move if skin id has been changed
        if ($old_skin->getId() != $this->getSkin()->getId()) {
            $this->file_system->move($old_customizing_skin_directory, $this->getSkinDirectory());
        }

        //Delete old template.xml and write a new one
        $this->file_system->delete($this->getSkinDirectory() . 'template.xml');
        $this->writeSkinToXML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateStyle()

ilSkinStyleContainer::updateStyle	(	string	$style_id,
		ilSkinStyle	$old_style
	)

Updates one single style.

Definition at line 114 of file class.ilSkinStyleContainer.php.

References Vendor\Package\$e, compileScss(), copySettingsFromDefault(), createMainScssFile(), ilSkinStyle\getCssFile(), getCSSFilePath(), ilSkinStyle\getFontDirectory(), getFontsStylePath(), ilSkinStyle\getId(), ilSkinStyle\getImageDirectory(), getImagesStylePath(), getMessageStack(), getScssFilePath(), getScssSettingsFolderName(), getScssSettingsPath(), getSkin(), getSkinDirectory(), ilSkinStyle\getSoundDirectory(), getSoundsStylePath(), getSystemStylesConf(), ilSystemStyleMessage\TYPE_ERROR, and writeSkinToXML().

Referenced by addStyle(), create(), and ilSkinStyleContainerTest\testUpdateStyle().

                                                                         : void
    {
        $style = $this->getSkin()->getStyle($style_id);

        if(!is_dir($this->getSkinDirectory().$style->getId())) {
            mkdir($this->getSkinDirectory().$style->getId(), 0775, true);
        }

        if ($style->getId()."/".$style->getImageDirectory() != $old_style->getId()."/".$old_style->getImageDirectory()
            && !is_dir($this->getImagesStylePath($style->getId()))) {
            if (is_dir($this->getSkinDirectory() .$old_style->getId()."/". $old_style->getImageDirectory())) {
                $this->file_system->changeResourceDirectory(
                    $this->getSkinDirectory(),
                    $style->getId()."/".$style->getImageDirectory(),
                    $old_style->getId()."/".$old_style->getImageDirectory()
                );
            } else {
                $this->file_system->createResourceDirectory(
                    $this->getSystemStylesConf()->getDefaultImagesPath(),
                    $this->getImagesStylePath($style->getId())
                );
            }
        }

        if ($style->getId()."/".$style->getFontDirectory() != $old_style->getId()."/".$old_style->getFontDirectory()
            && !is_dir($this->getFontsStylePath($style->getId()))) {
            if (is_dir($this->getSkinDirectory() . $old_style->getId()."/". $old_style->getFontDirectory())) {
                $this->file_system->changeResourceDirectory(
                    $this->getSkinDirectory(),
                    $style->getId()."/".$style->getFontDirectory(),
                    $old_style->getId()."/".$old_style->getFontDirectory()
                );
            } else {
                $this->file_system->createResourceDirectory(
                    $this->getSystemStylesConf()->getDefaultFontsPath(),
                    $this->getFontsStylePath($style->getId())
                );
            }
        }

        if ($style->getId()."/".$style->getSoundDirectory() != $old_style->getId()."/".$old_style->getSoundDirectory()
            && !is_dir($this->getSoundsStylePath($style->getId()))) {
            if (is_dir($this->getSkinDirectory() . $old_style->getId()."/". $old_style->getSoundDirectory())) {
                $this->file_system->changeResourceDirectory(
                    $this->getSkinDirectory(),
                    $style->getId()."/".$style->getSoundDirectory(),
                    $old_style->getId()."/".$old_style->getSoundDirectory()
                );
            } else {
                $this->file_system->createResourceDirectory(
                    $this->getSystemStylesConf()->getDefaultSoundsPath(),
                    $this->getSoundsStylePath($style->getId())
                );
            }
        }

        if($style->getId() != $old_style->getId()) {
            if (is_dir($this->getScssSettingsPath($old_style->getId()))) {
                $this->file_system->changeResourceDirectory(
                    $this->getSkinDirectory(),
                    $style->getId().'/'.$this->getScssSettingsFolderName(),
                    $old_style->getId().'/'.$this->getScssSettingsFolderName()
                );
            } elseif(!is_dir($this->getScssSettingsPath($old_style->getId()))) {
                $this->copySettingsFromDefault($style);
            }

            if (file_exists($this->getSkinDirectory() .$old_style->getId().'/'.$old_style->getCssFile() . '.scss')) {
                rename(
                    $this->getSkinDirectory().$old_style->getId().'/'.$old_style->getCssFile().'.scss',
                    $this->getScssFilePath($style->getId())
                );
            } else {
                $this->createMainScssFile($style);
            }

            if (file_exists($this->getSkinDirectory().$old_style->getId().'/'.$old_style->getCssFile().'.css')) {
                rename(
                    $this->getSkinDirectory().$old_style->getId().'/'.$old_style->getCssFile().'.css',
                    $this->getCSSFilePath($style->getId())
                );
            } else {
                try {
                    $this->compileScss($style->getId());
                } catch (Exception $e) {
                    $this->getMessageStack()->addMessage(
                        new ilSystemStyleMessage(
                            $e->getMessage(),
                            ilSystemStyleMessage::TYPE_ERROR
                        )
                    );
                    copy($this->getSystemStylesConf()->getDelosPath() . '.css', $this->getCSSFilePath($style->getId()));
                }
            }
        }


        $this->writeSkinToXML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

writeSkinToXML()

ilSkinStyleContainer::writeSkinToXML ( )

protected

Definition at line 499 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSkinDirectory().

Referenced by create(), deleteStyle(), updateSkin(), and updateStyle().

                                       : void
    {
        $this->getSkin()->writeToXMLFile($this->getSkinDirectory() . 'template.xml');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$file_system

ilFileSystemHelper ilSkinStyleContainer::$file_system

protected

Definition at line 45 of file class.ilSkinStyleContainer.php.

Referenced by __construct().

$lng

ilLanguage ilSkinStyleContainer::$lng

protected

Definition at line 28 of file class.ilSkinStyleContainer.php.

Referenced by __construct().

$message_stack

ilSystemStyleMessageStack ilSkinStyleContainer::$message_stack

protected

Used to stack messages to be displayed to the user (mostly reports for failed actions)

Definition at line 38 of file class.ilSkinStyleContainer.php.

Referenced by getMessageStack(), and setMessageStack().

$skin

ilSkin ilSkinStyleContainer::$skin

protected

Data-scope for the skin this container capsules.

Definition at line 33 of file class.ilSkinStyleContainer.php.

Referenced by __construct(), getSkin(), and setSkin().

$system_styles_conf

ilSystemStyleConfig ilSkinStyleContainer::$system_styles_conf

protected

Used to wire this component up with the correct pathes into the customizing directory.

Definition at line 43 of file class.ilSkinStyleContainer.php.

Referenced by getSystemStylesConf(), and setSystemStylesConf().

---

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

• Services/Style/System/classes/Style/class.ilSkinStyleContainer.php