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 ilSystemStyleSkinContainer:

Public Member Functions
	__construct (ilSkinXML $skin, ilSystemStyleMessageStack $message_stack=null, ilSystemStyleConfig $system_styles_conf=null)
	ilSystemStyleSkinContainer constructor. More...

	create (ilSystemStyleMessageStack $message_stack)
	Creates a new skin. More...

	updateSkin (ilSkinXML $old_skin)
	Updates the skin. More...

	updateStyle ($style_id, ilSkinStyleXML $old_style)
	Updates one single style. More...

	createMainLessFile (ilSkinStyleXML $style)
	Creates the main less file. More...

	copyVariablesFromDefault (ilSkinStyleXML $style)
	Copies (resets) the variables file from delos. More...

	resetImages (ilSkinStyleXML $style)
	Copies (resets) the images from delos. More...

	copyCSSFromDefault (ilSkinStyleXML $style)
	Copies (resets) the images from delos. More...

	move ($from, $to)
	Used to move a complete directory of a skin. More...

	delete ()
	Deletes the container of a skin completely. More...

	deleteStyle (ilSkinStyleXML $style)
	Deletes a style completely. More...

	copy ()
	Copies a complete Skin. More...

	export ()
	Exports the complete skin to an zip file. More...

	createTempZip ()
	Creates a temp zip file. More...

	compileLess ($style_id)

	getSkin ()

	setSkin ($skin)

	getSkinDirectory ()

	getCSSFilePath ($style_id)

	getLessFilePath ($style_id)

	getLessVariablesFilePath ($style_id)

	getLessVariablesName ($style_id)

	getImagesSkinPath ($style_id)

	addStyle (ilSkinStyleXML $style)

	getSystemStylesConf ()

	setSystemStylesConf ($system_styles_conf)

Static Public Member Functions
static	generateFromId ($skin_id, ilSystemStyleMessageStack $message_stack=null, ilSystemStyleConfig $system_styles_conf=null)
	Generate the container class by parsing the corresponding XML. More...

static	xCopy ($src, $dest)
	Recursive copy of a folder. More...

static	recursiveRemoveDir ($dir)
	Recursive delete of a folder. More...

static	import ($import_zip_path, $name, ilSystemStyleMessageStack $message_stack=null, $system_styles_conf=null, $uploaded=true)
	Imports a skin from zip. More...

static	getMessageStack ()

static	setMessageStack ($message_stack)

Protected Member Functions
	resourcesStyleReferences ($resource)
	Checks if a given resource (folder) is still referenced by a style of the containers skin. More...

	createResourceDirectory ($source, $target)
	Creates a resource directory (sound, images or fonts) by copying from the source (mostly delos) More...

	changeResourceDirectory ($new_dir, $old_dir)
	Alters the name/path of a resource directory. More...

	removeResourceDirectory ($dir)
	Deletes a resource directory. More...

	createLessStructure (ilSkinStyleXML $style)
	Creates the less/css structure of a style. More...

	getLessMainFileDefautContent (ilSkinStyleXML $style)
	Returns the main less default content if a new style is created. More...

	deleteFile ($path)
	Deletes a given file in the container. More...

	changeVariablesImport ($main_path, $old_style_import, $new_style_import)

	writeSkinToXML ()

Protected Attributes
	$lng

	$skin

	$system_styles_conf

Static Protected Attributes
static	$message_stack = null

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.

Author: Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$*

Definition at line 19 of file class.ilSystemStyleSkinContainer.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleSkinContainer::__construct	(	ilSkinXML	$skin,
		ilSystemStyleMessageStack	$message_stack = `null`,
		ilSystemStyleConfig	$system_styles_conf = `null`
	)

ilSystemStyleSkinContainer constructor.

Parameters

ilSkinXML	$skin
ilSystemStyleMessageStack \| null	$message_stack
ilSystemStyleConfig	$system_styles_conf

Definition at line 55 of file class.ilSystemStyleSkinContainer.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
 
        $this->skin = $skin;
 
        if (!$message_stack) {
            $this->setMessageStack(new ilSystemStyleMessageStack());
        } else {
            $this->setMessageStack($message_stack);
        }
 
        if (!$system_styles_conf) {
            $this->setSystemStylesConf(new ilSystemStyleConfig());
        } else {
            $this->setSystemStylesConf($system_styles_conf);
        }
    }

References $DIC, $message_stack, $skin, $system_styles_conf, setMessageStack(), and setSystemStylesConf().

Here is the call graph for this function:

Member Function Documentation

◆ addStyle()

ilSystemStyleSkinContainer::addStyle ( ilSkinStyleXML $style )

Parameters

ilSkinStyleXML $style

Definition at line 767 of file class.ilSystemStyleSkinContainer.php.

    {
        $this->getSkin()->addStyle($style);
        $old_style = new ilSkinStyleXML("", "");
        $this->updateStyle($style->getId(), $old_style);
    }

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

Here is the call graph for this function:

◆ changeResourceDirectory()

ilSystemStyleSkinContainer::changeResourceDirectory	(	$new_dir,
		$old_dir
	)

protected

Alters the name/path of a resource directory.

Parameters

$new_dir
$old_dir

Exceptions

ilSystemStyleException

Definition at line 267 of file class.ilSystemStyleSkinContainer.php.

    {
        $absolut_new_dir = $this->getSkinDirectory() . $new_dir;
        $absolut_old_dir = $this->getSkinDirectory() . $old_dir;
 
        if (file_exists($absolut_new_dir)) {
            $this->getMessageStack()->addMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt("dir_changed_to") . " " . $absolut_new_dir,
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
            $this->getMessageStack()->addMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt("dir_preserved_backup") . " " . $absolut_old_dir,
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
        } else {
            mkdir($absolut_new_dir, 0777, true);
            self::xCopy($absolut_old_dir, $absolut_new_dir);
            $this->getMessageStack()->addMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt("dir_copied_from") . " " . $absolut_old_dir . " " . $this->lng->txt("to") . " " . $absolut_new_dir,
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
            if (count($this->resourcesStyleReferences($old_dir))==0) {
                self::recursiveRemoveDir(self::getSkinDirectory() . $old_dir);
                $this->getMessageStack()->addMessage(
                    new ilSystemStyleMessage(
                        $this->lng->txt("dir_deleted") . " " . $absolut_old_dir,
                        ilSystemStyleMessage::TYPE_SUCCESS
                    )
                );
            } else {
                $this->getMessageStack()->addMessage(
                    new ilSystemStyleMessage(
                        $this->lng->txt("dir_preserved_linked") . " " . $absolut_old_dir,
                        ilSystemStyleMessage::TYPE_SUCCESS
                    )
                );
            }
        }
    }

References getMessageStack(), getSkinDirectory(), recursiveRemoveDir(), resourcesStyleReferences(), ilSystemStyleMessage\TYPE_SUCCESS, and xCopy().

Referenced by updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeVariablesImport()

ilSystemStyleSkinContainer::changeVariablesImport	(	$main_path,
		$old_style_import,
		$new_style_import
	)

protected

Parameters

$main_path
$old_style_import
$new_style_import

Definition at line 647 of file class.ilSystemStyleSkinContainer.php.

    {
        $main_less_content = file_get_contents($main_path);
        $main_less_content = str_replace(
            "@import \"" . $old_style_import,
            "@import \"" . $new_style_import,
            $main_less_content
        );
        file_put_contents($main_path, $main_less_content);
    }

Referenced by updateStyle().

Here is the caller graph for this function:

◆ compileLess()

ilSystemStyleSkinContainer::compileLess ( $style_id )

Parameters

$style_id

Exceptions

ilSystemStyleException

Definition at line 662 of file class.ilSystemStyleSkinContainer.php.

    {
        if (!PATH_TO_LESSC) {
            throw new ilSystemStyleException(ilSystemStyleException::LESSC_NOT_INSTALLED);
        }
 
        $output = shell_exec(PATH_TO_LESSC . " " . $this->getLessFilePath($style_id));
        if (!$output) {
            $less_error = shell_exec(PATH_TO_LESSC . " " . $this->getLessFilePath($style_id) . " 2>&1");
            if (!$less_error) {
                throw new ilSystemStyleException(ilSystemStyleException::LESS_COMPILE_FAILED, "Empty css output, unknown error.");
            }
            throw new ilSystemStyleException(ilSystemStyleException::LESS_COMPILE_FAILED, $less_error);
        }
        file_put_contents($this->getCSSFilePath($style_id), $output);
    }

References $output, getCSSFilePath(), getLessFilePath(), ilSystemStyleException\LESS_COMPILE_FAILED, and ilSystemStyleException\LESSC_NOT_INSTALLED.

Referenced by createLessStructure(), and updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy()

ilSystemStyleSkinContainer::copy ( )

Copies a complete Skin.

Returns: ilSystemStyleSkinContainer

Exceptions

ilSystemStyleException

Definition at line 568 of file class.ilSystemStyleSkinContainer.php.

    {
        $new_skin_id_addon = "";
 
        while (ilStyleDefinition::skinExists($this->getSkin()->getId() . $new_skin_id_addon, $this->getSystemStylesConf())) {
            $new_skin_id_addon .= "Copy";
        }
 
        $new_skin_path = rtrim($this->getSkinDirectory(), "/") . $new_skin_id_addon;
 
        mkdir($new_skin_path, 0777, true);
        $this->xCopy($this->getSkinDirectory(), $new_skin_path);
        $this->getMessageStack()->addMessage(new ilSystemStyleMessage($this->lng->txt("directory_created") . " " . $new_skin_path, ilSystemStyleMessage::TYPE_SUCCESS));
        return self::generateFromId($this->getSkin()->getId() . $new_skin_id_addon, null, $this->getSystemStylesConf());
    }

References generateFromId(), getMessageStack(), getSkin(), getSkinDirectory(), getSystemStylesConf(), ilStyleDefinition\skinExists(), ilSystemStyleMessage\TYPE_SUCCESS, and xCopy().

Referenced by copyCSSFromDefault(), updateStyle(), and xCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyCSSFromDefault()

ilSystemStyleSkinContainer::copyCSSFromDefault ( ilSkinStyleXML $style )

Copies (resets) the images from delos.

Parameters

ilSkinStyleXML $style

Definition at line 403 of file class.ilSystemStyleSkinContainer.php.

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

References copy(), getCSSFilePath(), ilSkinStyleXML\getId(), and getSystemStylesConf().

Referenced by createLessStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyVariablesFromDefault()

ilSystemStyleSkinContainer::copyVariablesFromDefault ( ilSkinStyleXML $style )

Copies (resets) the variables file from delos.

Parameters

ilSkinStyleXML $style

Returns: ilSystemStyleLessFile

Definition at line 379 of file class.ilSystemStyleSkinContainer.php.

    {
        $less_file = new ilSystemStyleLessFile($this->getSystemStylesConf()->getDefaultVariablesPath());
        $less_file->setLessVariablesFile($this->getLessVariablesFilePath($style->getId()));
        $less_file->write();
        return $less_file;
    }

References ilSkinStyleXML\getId(), getLessVariablesFilePath(), and getSystemStylesConf().

Referenced by createLessStructure(), and updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilSystemStyleSkinContainer::create ( ilSystemStyleMessageStack $message_stack )

Creates a new skin.

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

Parameters

ilSystemStyleMessageStack $message_stack

Exceptions

ilSystemStyleException

Definition at line 108 of file class.ilSystemStyleSkinContainer.php.

    {
        if (file_exists($this->getSkinDirectory())) {
            throw new ilSystemStyleException(ilSystemStyleException::SKIN_ALREADY_EXISTS, $this->getSkinDirectory());
        }
 
 
        mkdir($this->getSkinDirectory(), 0777, true);
 
        foreach ($this->getSkin()->getStyles() as $style) {
            $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultImagesPath(), $style->getImageDirectory());
            $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultSoundsPath(), $style->getSoundDirectory());
            $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultFontsPath(), $style->getFontDirectory());
            try {
                $this->createLessStructure($style);
            } catch (Exception $e) {
                $message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt("less_compile_failed") . " " . $e->getMessage(), ilSystemStyleMessage::TYPE_ERROR));
            }
        }
        $this->writeSkinToXML();
    }

References $message_stack, $style, createLessStructure(), createResourceDirectory(), getSkin(), getSkinDirectory(), getSystemStylesConf(), ilSystemStyleException\SKIN_ALREADY_EXISTS, ilSystemStyleMessage\TYPE_ERROR, and writeSkinToXML().

Here is the call graph for this function:

◆ createLessStructure()

ilSystemStyleSkinContainer::createLessStructure ( ilSkinStyleXML $style )

protected

Creates the less/css structure of a style.

Parameters

ilSkinStyleXML $style

Exceptions

ilSystemStyleException

Definition at line 348 of file class.ilSystemStyleSkinContainer.php.

    {
        $this->createMainLessFile($style);
        $this->copyVariablesFromDefault($style);
        $this->copyCSSFromDefault($style);
        $this->compileLess($style->getId());
    }

References compileLess(), copyCSSFromDefault(), copyVariablesFromDefault(), createMainLessFile(), and ilSkinStyleXML\getId().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMainLessFile()

ilSystemStyleSkinContainer::createMainLessFile ( ilSkinStyleXML $style )

Creates the main less file.

Parameters

ilSkinStyleXML $style

Definition at line 361 of file class.ilSystemStyleSkinContainer.php.

    {
        $path = $this->getLessFilePath($style->getId());
        file_put_contents($path, $this->getLessMainFileDefautContent($style));
        $this->getMessageStack()->addMessage(
            new ilSystemStyleMessage(
                $this->lng->txt("main_less_created") . " " . $path,
                ilSystemStyleMessage::TYPE_SUCCESS
            )
        );
    }

References $path, ilSkinStyleXML\getId(), getLessFilePath(), getLessMainFileDefautContent(), getMessageStack(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by createLessStructure(), and updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createResourceDirectory()

ilSystemStyleSkinContainer::createResourceDirectory	(	$source,
		$target
	)

protected

Creates a resource directory (sound, images or fonts) by copying from the source (mostly delos)

Parameters

$source
$target

Exceptions

ilSystemStyleException

Definition at line 243 of file class.ilSystemStyleSkinContainer.php.

    {
        $path = $this->getSkinDirectory() . $target;
 
        mkdir($path, 0777, true);
 
        if ($source != "") {
            self::xCopy($source, $path);
            $this->getMessageStack()->addMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt("dir_created") . $path,
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
        }
    }

References $path, $source, $target, getMessageStack(), getSkinDirectory(), ilSystemStyleMessage\TYPE_SUCCESS, and xCopy().

Referenced by create(), resetImages(), and updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTempZip()

ilSystemStyleSkinContainer::createTempZip ( )

Creates a temp zip file.

Returns: string $temp_path

Definition at line 597 of file class.ilSystemStyleSkinContainer.php.

    {
        $rel_tmp_zip = "../" . $this->getSkin()->getId() . ".zip";
        ilUtil::zip($this->getSkinDirectory(), $rel_tmp_zip, true);
        return rtrim($this->getSkinDirectory(), "/") . ".zip";
    }

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

Referenced by export().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilSystemStyleSkinContainer::delete ( )

Deletes the container of a skin completely.

Definition at line 497 of file class.ilSystemStyleSkinContainer.php.

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

References getMessageStack(), recursiveRemoveDir(), and ilSystemStyleMessage\TYPE_SUCCESS.

Here is the call graph for this function:

◆ deleteFile()

ilSystemStyleSkinContainer::deleteFile ( $path )

protected

Deletes a given file in the container.

Parameters

$path

Definition at line 513 of file class.ilSystemStyleSkinContainer.php.

    {
        if (file_exists($path)) {
            unlink($path);
            $this->getMessageStack()->addMessage(
                new ilSystemStyleMessage(
                    $this->lng->txt("file_deleted") . " " . $path,
                    ilSystemStyleMessage::TYPE_SUCCESS
                )
            );
        }
    }

References $path, getMessageStack(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by deleteStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteStyle()

ilSystemStyleSkinContainer::deleteStyle ( ilSkinStyleXML $style )

Deletes a style completely.

Parameters

ilSkinStyleXML $style

Definition at line 531 of file class.ilSystemStyleSkinContainer.php.

    {
        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->deleteFile($this->getLessFilePath($style->getId()));
        $this->deleteFile($this->getCSSFilePath($style->getId()));
        $this->deleteFile($this->getLessVariablesFilePath($style->getId()));
 
        $this->getSkin()->removeStyle($style->getId());
 
        $this->removeResourceDirectory($style->getImageDirectory());
        $this->removeResourceDirectory($style->getFontDirectory());
        $this->removeResourceDirectory($style->getSoundDirectory());
 
        $this->writeSkinToXML();
        $this->getMessageStack()->prependMessage(
            new ilSystemStyleMessage(
                $this->lng->txt("style_deleted") . " " . $style->getName(),
                ilSystemStyleMessage::TYPE_SUCCESS
            )
        );
    }

References $style, deleteFile(), ilSystemStyleSettings\deleteSubStyleCategoryAssignments(), getCSSFilePath(), ilSkinStyleXML\getFontDirectory(), ilSkinStyleXML\getId(), ilSkinStyleXML\getImageDirectory(), getLessFilePath(), getLessVariablesFilePath(), getMessageStack(), getSkin(), ilSkinStyleXML\getSoundDirectory(), removeResourceDirectory(), ilSystemStyleMessage\TYPE_SUCCESS, and writeSkinToXML().

Here is the call graph for this function:

◆ export()

ilSystemStyleSkinContainer::export ( )

Exports the complete skin to an zip file.

Definition at line 587 of file class.ilSystemStyleSkinContainer.php.

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

References createTempZip(), ilFileDelivery\deliverFileAttached(), and getSkin().

Here is the call graph for this function:

◆ generateFromId()

static ilSystemStyleSkinContainer::generateFromId	(		$skin_id,
		ilSystemStyleMessageStack	$message_stack = `null`,
		ilSystemStyleConfig	$system_styles_conf = `null`
	)

static

Generate the container class by parsing the corresponding XML.

Parameters

	$skin_id
ilSystemStyleMessageStack \| null	$message_stack
ilSystemStyleConfig	$system_styles_conf

Returns: ilSystemStyleSkinContainer

Exceptions

ilSystemStyleException

Definition at line 85 of file class.ilSystemStyleSkinContainer.php.

    {
        if (!$skin_id) {
            throw new ilSystemStyleException(ilSystemStyleException::NO_SKIN_ID);
        }
 
        if (!$system_styles_conf) {
            $system_styles_conf = new ilSystemStyleConfig();
        }
 
        if ($skin_id != "default") {
            return new self(ilSkinXML::parseFromXML($system_styles_conf->getCustomizingSkinPath() . $skin_id . "/template.xml"), $message_stack, $system_styles_conf);
        } else {
            return new self(ilSkinXML::parseFromXML($system_styles_conf->getDefaultTemplatePath()), $message_stack, $system_styles_conf);
        }
    }

References $message_stack, $system_styles_conf, and ilSystemStyleException\NO_SKIN_ID.

Here is the caller graph for this function:

◆ getCSSFilePath()

ilSystemStyleSkinContainer::getCSSFilePath ( $style_id )

Parameters

$style_id

Returns: string

Definition at line 707 of file class.ilSystemStyleSkinContainer.php.

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

References getSkin(), and getSkinDirectory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagesSkinPath()

ilSystemStyleSkinContainer::getImagesSkinPath ( $style_id )

Parameters

$style_id

Returns: string

Definition at line 743 of file class.ilSystemStyleSkinContainer.php.

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

References getSkin(), and getSkinDirectory().

Here is the call graph for this function:

◆ getLessFilePath()

ilSystemStyleSkinContainer::getLessFilePath ( $style_id )

Parameters

$style_id

Returns: string

Definition at line 716 of file class.ilSystemStyleSkinContainer.php.

    {
        return $this->getSkinDirectory() . $this->getSkin()->getStyle($style_id)->getCssFile() . ".less";
    }

References getSkin(), and getSkinDirectory().

Referenced by compileLess(), createMainLessFile(), deleteStyle(), and updateStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessMainFileDefautContent()

ilSystemStyleSkinContainer::getLessMainFileDefautContent ( ilSkinStyleXML $style )

protected

Returns the main less default content if a new style is created.

Parameters

ilSkinStyleXML $style

Returns: string

Definition at line 473 of file class.ilSystemStyleSkinContainer.php.

    {
        $content = "@import \"" . $this->getSystemStylesConf()->getRelDelosPath() . "\";\n";
        $content .= "// Import Custom Less Files here\n";
 
        $content .= "@import \"" . $this->getLessVariablesName($style->getId()) . "\";\n";
        return $content;
    }

References ilSkinStyleXML\getId(), getLessVariablesName(), and getSystemStylesConf().

Referenced by createMainLessFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessVariablesFilePath()

ilSystemStyleSkinContainer::getLessVariablesFilePath ( $style_id )

Parameters

$style_id

Returns: string

Definition at line 725 of file class.ilSystemStyleSkinContainer.php.

    {
        return $this->getSkinDirectory() . $this->getLessVariablesName($style_id);
    }

References getLessVariablesName(), and getSkinDirectory().

Referenced by copyVariablesFromDefault(), and deleteStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessVariablesName()

ilSystemStyleSkinContainer::getLessVariablesName ( $style_id )

Parameters

$style_id

Returns: string

Definition at line 734 of file class.ilSystemStyleSkinContainer.php.

    {
        return $this->getSkin()->getStyle($style_id)->getCssFile() . "-variables.less";
    }

References getSkin().

Referenced by getLessMainFileDefautContent(), and getLessVariablesFilePath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessageStack()

static ilSystemStyleSkinContainer::getMessageStack ( )

static

Returns: ilSystemStyleMessageStack

Definition at line 751 of file class.ilSystemStyleSkinContainer.php.

    {
        return self::$message_stack;
    }

References $message_stack.

Referenced by changeResourceDirectory(), copy(), createMainLessFile(), createResourceDirectory(), delete(), deleteFile(), deleteStyle(), removeResourceDirectory(), and updateStyle().

Here is the caller graph for this function:

◆ getSkin()

ilSystemStyleSkinContainer::getSkin ( )

Returns: ilSkinXML

Definition at line 681 of file class.ilSystemStyleSkinContainer.php.

    {
        return $this->skin;
    }

References $skin.

Referenced by addStyle(), copy(), create(), createTempZip(), deleteStyle(), export(), getCSSFilePath(), getImagesSkinPath(), getLessFilePath(), getLessVariablesName(), getSkinDirectory(), resourcesStyleReferences(), updateStyle(), and writeSkinToXML().

Here is the caller graph for this function:

◆ getSkinDirectory()

ilSystemStyleSkinContainer::getSkinDirectory ( )

Returns: mixed

Definition at line 697 of file class.ilSystemStyleSkinContainer.php.

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

References getSkin(), and getSystemStylesConf().

Referenced by changeResourceDirectory(), copy(), create(), createResourceDirectory(), createTempZip(), getCSSFilePath(), getImagesSkinPath(), getLessFilePath(), getLessVariablesFilePath(), removeResourceDirectory(), resetImages(), updateSkin(), updateStyle(), and writeSkinToXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSystemStylesConf()

ilSystemStyleSkinContainer::getSystemStylesConf ( )

Returns: ilSystemStyleConfig

Definition at line 782 of file class.ilSystemStyleSkinContainer.php.

    {
        return $this->system_styles_conf;
    }

References $system_styles_conf.

Referenced by copy(), copyCSSFromDefault(), copyVariablesFromDefault(), create(), getLessMainFileDefautContent(), getSkinDirectory(), resetImages(), updateSkin(), and updateStyle().

Here is the caller graph for this function:

◆ import()

static ilSystemStyleSkinContainer::import	(		$import_zip_path,
			$name,
		ilSystemStyleMessageStack	$message_stack = `null`,
			$system_styles_conf = `null`,
			$uploaded = `true`
	)

static

Imports a skin from zip.

Parameters

	$import_zip_path
	$name
ilSystemStyleMessageStack \| null	$message_stack
null	$system_styles_conf
bool \| true	$uploaded

Returns: ilSystemStyleSkinContainer

Exceptions

ilSystemStyleException

Definition at line 615 of file class.ilSystemStyleSkinContainer.php.

    {
        if (!$system_styles_conf) {
            $system_styles_conf = new ilSystemStyleConfig();
        }
 
        $skin_id = preg_replace('/[^A-Za-z0-9\-_]/', '', rtrim($name, ".zip"));
 
        while (ilStyleDefinition::skinExists($skin_id, $system_styles_conf)) {
            $skin_id .= "Copy";
        }
 
        $skin_path = $system_styles_conf->getCustomizingSkinPath() . $skin_id;
        mkdir($skin_path, 0777, true);
 
        $temp_zip_path = $skin_path . "/" . $name;
        if ($uploaded) {
            move_uploaded_file($import_zip_path, $temp_zip_path);
        } else {
            rename($import_zip_path, $temp_zip_path);
        }
        ilUtil::unzip($temp_zip_path);
        unlink($temp_zip_path);
 
        return self::generateFromId($skin_id, $message_stack, $system_styles_conf);
    }

References $message_stack, $name, $system_styles_conf, generateFromId(), ilStyleDefinition\skinExists(), and ilUtil\unzip().

Referenced by ilSystemStyleOverviewGUI\importStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ move()

ilSystemStyleSkinContainer::move	(	$from,
		$to
	)

Used to move a complete directory of a skin.

Parameters

$from
$to

Definition at line 488 of file class.ilSystemStyleSkinContainer.php.

    {
        rename($from, $to);
    }

References $from.

Referenced by updateSkin().

Here is the caller graph for this function:

◆ recursiveRemoveDir()

static ilSystemStyleSkinContainer::recursiveRemoveDir ( $dir )

static

Recursive delete of a folder.

Parameters

$dir

Definition at line 449 of file class.ilSystemStyleSkinContainer.php.

    {
        if (is_dir($dir)) {
            $objects = scandir($dir);
            foreach ($objects as $object) {
                if ($object != "." && $object != "..") {
                    if (is_dir($dir . "/" . $object)) {
                        self::recursiveRemoveDir($dir . "/" . $object);
                    } else {
                        unlink($dir . "/" . $object);
                    }
                }
            }
            rmdir($dir);
        }
    }

References recursiveRemoveDir().

Referenced by changeResourceDirectory(), delete(), recursiveRemoveDir(), removeResourceDirectory(), resetImages(), ilSkinStyleLessFileTest\tearDown(), ilSkinXMLTest\tearDown(), ilSystemStyleIconFolderTest\tearDown(), ilSystemStyleIconTest\tearDown(), ilSystemStyleSkinContainerTest\tearDown(), ilSystemStyleSkinXMLTest\tearDown(), and ilSystemStyleStyleLessFileTest\tearDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeResourceDirectory()

ilSystemStyleSkinContainer::removeResourceDirectory ( $dir )

protected

Deletes a resource directory.

Parameters

$dir

Definition at line 318 of file class.ilSystemStyleSkinContainer.php.

    {
        $absolut_dir = $this->getSkinDirectory() . $dir;
 
        if (file_exists($absolut_dir)) {
            if (count($this->resourcesStyleReferences($dir)) == 0) {
                self::recursiveRemoveDir($this->getSkinDirectory() . $dir);
                $this->getMessageStack()->addMessage(
                    new ilSystemStyleMessage(
                        $this->lng->txt("dir_deleted") . " " . $dir,
                        ilSystemStyleMessage::TYPE_SUCCESS
                    )
                );
            } else {
                $this->getMessageStack()->addMessage(
                    new ilSystemStyleMessage(
                        $this->lng->txt("dir_preserved_linked") . " " . $dir,
                        ilSystemStyleMessage::TYPE_SUCCESS
                    )
                );
            }
        }
    }

References getMessageStack(), getSkinDirectory(), recursiveRemoveDir(), resourcesStyleReferences(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by deleteStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetImages()

ilSystemStyleSkinContainer::resetImages ( ilSkinStyleXML $style )

Copies (resets) the images from delos.

Parameters

ilSkinStyleXML $style

Definition at line 392 of file class.ilSystemStyleSkinContainer.php.

    {
        self::recursiveRemoveDir($this->getSkinDirectory() . $style->getImageDirectory());
        $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultImagesPath(), $style->getImageDirectory());
    }

References $style, createResourceDirectory(), ilSkinStyleXML\getImageDirectory(), getSkinDirectory(), getSystemStylesConf(), and recursiveRemoveDir().

Here is the call graph for this function:

◆ resourcesStyleReferences()

ilSystemStyleSkinContainer::resourcesStyleReferences ( $resource )

protected

Checks if a given resource (folder) is still referenced by a style of the containers skin.

Parameters

$resource

Returns: array

Definition at line 225 of file class.ilSystemStyleSkinContainer.php.

    {
        $references_ids = array();
        foreach ($this->getSkin()->getStyles() as $style) {
            if ($style->referencesResource($resource)) {
                $references_ids[] = $style->getId();
            }
        }
        return $references_ids;
    }

References $style, and getSkin().

Referenced by changeResourceDirectory(), and removeResourceDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMessageStack()

static ilSystemStyleSkinContainer::setMessageStack ( $message_stack )

static

Parameters

ilSystemStyleMessageStack $message_stack

Definition at line 759 of file class.ilSystemStyleSkinContainer.php.

    {
        self::$message_stack = $message_stack;
    }

References $message_stack.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSkin()

ilSystemStyleSkinContainer::setSkin ( $skin )

Parameters

ilSkinXML $skin

Definition at line 689 of file class.ilSystemStyleSkinContainer.php.

    {
        $this->skin = $skin;
    }

References $skin.

◆ setSystemStylesConf()

ilSystemStyleSkinContainer::setSystemStylesConf ( $system_styles_conf )

Parameters

ilSystemStyleConfig $system_styles_conf

Definition at line 790 of file class.ilSystemStyleSkinContainer.php.

    {
        $this->system_styles_conf = $system_styles_conf;
    }

References $system_styles_conf.

Referenced by __construct().

Here is the caller graph for this function:

◆ updateSkin()

ilSystemStyleSkinContainer::updateSkin ( ilSkinXML $old_skin )

Updates the skin.

Style are not updated, use updateStyle for that.

Parameters

ilSkinXML $old_skin

Exceptions

ilSystemStyleException

Definition at line 136 of file class.ilSystemStyleSkinContainer.php.

    {
        $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->move($old_customizing_skin_directory, $this->getSkinDirectory());
        }
 
        //Delete old template.xml and write a new one
        unlink($this->getSkinDirectory() . "template.xml");
        $this->writeSkinToXML();
    }

References ilSkinXML\getId(), getSkinDirectory(), getSystemStylesConf(), move(), and writeSkinToXML().

Here is the call graph for this function:

◆ updateStyle()

ilSystemStyleSkinContainer::updateStyle	(		$style_id,
		ilSkinStyleXML	$old_style
	)

Updates one single style.

Parameters

	$style_id
ilSkinStyleXML	$old_style

Definition at line 156 of file class.ilSystemStyleSkinContainer.php.

    {
        $style = $this->getSkin()->getStyle($style_id);
 
        if ($style->getImageDirectory()!=$old_style->getImageDirectory()) {
            if (file_exists($this->getSkinDirectory() . $old_style->getImageDirectory())) {
                $this->changeResourceDirectory($style->getImageDirectory(), $old_style->getImageDirectory());
            } else {
                $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultImagesPath(), $style->getImageDirectory());
            }
        }
 
        if ($style->getFontDirectory()!=$old_style->getFontDirectory()) {
            if (file_exists($this->getSkinDirectory() . $old_style->getFontDirectory())) {
                $this->changeResourceDirectory($style->getFontDirectory(), $old_style->getFontDirectory());
            } else {
                $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultFontsPath(), $style->getFontDirectory());
            }
        }
 
        if ($style->getSoundDirectory()!=$old_style->getSoundDirectory()) {
            if (file_exists($this->getSkinDirectory() . $old_style->getSoundDirectory())) {
                $this->changeResourceDirectory($style->getSoundDirectory(), $old_style->getSoundDirectory());
            } else {
                $this->createResourceDirectory($this->getSystemStylesConf()->getDefaultSoundsPath(), $style->getSoundDirectory());
            }
        }
 
 
 
        if (file_exists($this->getSkinDirectory() . $old_style->getCssFile() . ".less")) {
            rename($this->getSkinDirectory() . $old_style->getCssFile() . ".less", $this->getLessFilePath($style->getId()));
        } else {
            $this->createMainLessFile($style);
        }
 
        if (file_exists($this->getSkinDirectory() . $old_style->getCssFile() . "-variables.less")) {
            rename($this->getSkinDirectory() . $old_style->getCssFile() . "-variables.less", $this->getLessVariablesFilePath($style->getId()));
        } else {
            $this->copyVariablesFromDefault($style);
        }
 
        $this->changeVariablesImport($this->getLessFilePath($style->getId()), $old_style->getCssFile() . "-variables.less", $this->getLessVariablesName($style->getId()));
 
        if (file_exists($this->getSkinDirectory() . $old_style->getCssFile() . ".css")) {
            rename($this->getSkinDirectory() . $old_style->getCssFile() . ".css", $this->getCSSFilePath($style->getId()));
        } else {
            try {
                $this->compileLess($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();
    }

References $style, changeResourceDirectory(), changeVariablesImport(), compileLess(), copy(), copyVariablesFromDefault(), createMainLessFile(), createResourceDirectory(), ilSkinStyleXML\getCssFile(), getCSSFilePath(), ilSkinStyleXML\getFontDirectory(), ilSkinStyleXML\getImageDirectory(), getLessFilePath(), getMessageStack(), getSkin(), getSkinDirectory(), ilSkinStyleXML\getSoundDirectory(), getSystemStylesConf(), ilSystemStyleMessage\TYPE_ERROR, and writeSkinToXML().

Referenced by addStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSkinToXML()

ilSystemStyleSkinContainer::writeSkinToXML ( )

protected

Definition at line 774 of file class.ilSystemStyleSkinContainer.php.

    {
        $this->getSkin()->writeToXMLFile($this->getSkinDirectory() . "template.xml");
    }

References getSkin(), and getSkinDirectory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xCopy()

static ilSystemStyleSkinContainer::xCopy	(	$src,
		$dest
	)

static

Recursive copy of a folder.

Parameters

$src
$dest

Exceptions

ilSystemStyleException

Definition at line 415 of file class.ilSystemStyleSkinContainer.php.

    {
        foreach (scandir($src) as $file) {
            $src_file = rtrim($src, '/') . '/' . $file;
            $dest_file = rtrim($dest, '/') . '/' . $file;
            if (!is_readable($src_file)) {
                throw new ilSystemStyleException(ilSystemStyleException::FILE_OPENING_FAILED, $src_file);
            }
            if (substr($file, 0, 1) != ".") {
                if (is_dir($src_file)) {
                    if (!file_exists($dest_file)) {
                        try {
                            mkdir($dest_file);
                        } catch (Exception $e) {
                            throw new ilSystemStyleException(ilSystemStyleException::FOLDER_CREATION_FAILED, "Copy " . $src_file . " to " . $dest_file . " Error: " . $e);
                        }
                    }
                    self::xCopy($src_file, $dest_file);
                } else {
                    try {
                        copy($src_file, $dest_file);
                    } catch (Exception $e) {
                        throw new ilSystemStyleException(ilSystemStyleException::FILE_CREATION_FAILED, "Copy " . $src_file . " to " . $dest_file . " Error: " . $e);
                    }
                }
            }
        }
    }

References $file, copy(), ilSystemStyleException\FILE_CREATION_FAILED, ilSystemStyleException\FILE_OPENING_FAILED, ilSystemStyleException\FOLDER_CREATION_FAILED, and xCopy().

Referenced by changeResourceDirectory(), copy(), createResourceDirectory(), ilSkinStyleLessFileTest\setUp(), ilSkinXMLTest\setUp(), ilSystemStyleIconFolderTest\setUp(), ilSystemStyleIconTest\setUp(), ilSystemStyleSkinContainerTest\setUp(), ilSystemStyleSkinXMLTest\setUp(), ilSystemStyleStyleLessFileTest\setUp(), and xCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $lng

ilSystemStyleSkinContainer::$lng

protected

Definition at line 25 of file class.ilSystemStyleSkinContainer.php.

◆ $message_stack

ilSystemStyleSkinContainer::$message_stack = null

staticprotected

Definition at line 39 of file class.ilSystemStyleSkinContainer.php.

Referenced by __construct(), create(), generateFromId(), getMessageStack(), import(), and setMessageStack().

◆ $skin

ilSystemStyleSkinContainer::$skin

protected

Definition at line 32 of file class.ilSystemStyleSkinContainer.php.

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

◆ $system_styles_conf

ilSystemStyleSkinContainer::$system_styles_conf

protected

Definition at line 46 of file class.ilSystemStyleSkinContainer.php.

Referenced by __construct(), generateFromId(), getSystemStylesConf(), import(), and setSystemStylesConf().

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

Services/Style/System/classes/Utilities/class.ilSystemStyleSkinContainer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStyle()

◆ changeResourceDirectory()

◆ changeVariablesImport()

◆ compileLess()

◆ copy()

◆ copyCSSFromDefault()

◆ copyVariablesFromDefault()

◆ create()

◆ createLessStructure()

◆ createMainLessFile()

◆ createResourceDirectory()

◆ createTempZip()

◆ delete()

◆ deleteFile()

◆ deleteStyle()

◆ export()

◆ generateFromId()

◆ getCSSFilePath()

◆ getImagesSkinPath()

◆ getLessFilePath()

◆ getLessMainFileDefautContent()

◆ getLessVariablesFilePath()

◆ getLessVariablesName()

◆ getMessageStack()

◆ getSkin()

◆ getSkinDirectory()

◆ getSystemStylesConf()

◆ import()

◆ move()

◆ recursiveRemoveDir()

◆ removeResourceDirectory()

◆ resetImages()

◆ resourcesStyleReferences()

◆ setMessageStack()

◆ setSkin()

◆ setSystemStylesConf()

◆ updateSkin()

◆ updateStyle()

◆ writeSkinToXML()

◆ xCopy()

Field Documentation

◆ $lng

◆ $message_stack

◆ $skin

◆ $system_styles_conf