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 (Language $lng, ilSkin $skin, ilSystemStyleMessageStack $message_stack, ?ilSystemStyleConfig $system_styles_conf=null,)
	export ()
	Exports the complete skin to an zip file. More...
	createTempZip ()
	Creates a temp zip file. More...
	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)
	getSystemStylesConf ()
	setSystemStylesConf (ilSystemStyleConfig $system_styles_conf)

Protected Member Functions
	writeSkinToXML ()

Protected Attributes
Language	$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...

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 28 of file class.ilSkinStyleContainer.php.

Constructor & Destructor Documentation

__construct()

ilSkinStyleContainer::__construct	(	Language	$lng,
		ilSkin	$skin,
		ilSystemStyleMessageStack	$message_stack,
		?ilSystemStyleConfig	$system_styles_conf = null
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

createTempZip()

ilSkinStyleContainer::createTempZip

(

)

Creates a temp zip file.

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

                                   : string
    {
        $skin_directory = $this->getSkinDirectory(); // parent of skin directory
 
        if (strpos($skin_directory, '../') === 0) { // we must resolve relative paths here
            $skin_directory = realpath(__DIR__ . '/../../../../../../templates/' . $skin_directory);
        }
        $output_file = dirname($skin_directory) . '/' . $this->getSkin()->getId() . '.zip';
 
        ilFileUtils::zip($skin_directory, $output_file, true);
 
        return $output_file;
    }

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

Referenced by export().

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 67 of file class.ilSkinStyleContainer.php.

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

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

Here is the call graph for this function:

getCSSFilePath()

ilSkinStyleContainer::getCSSFilePath

(

string

$style_id

)

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

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

References getSkinDirectory().

Here is the call graph for this function:

getFontsStylePath()

ilSkinStyleContainer::getFontsStylePath

(

string

$style_id

)

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

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

References getSkin(), and getSkinDirectory().

Here is the call graph for this function:

getImagesStylePath()

ilSkinStyleContainer::getImagesStylePath

(

string

$style_id

)

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

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

References getSkin(), and getSkinDirectory().

Here is the call graph for this function:

getMessageStack()

ilSkinStyleContainer::getMessageStack

(

)

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

                                     : ilSystemStyleMessageStack
    {
        return $this->message_stack;
    }

References $message_stack.

getScssFilePath()

ilSkinStyleContainer::getScssFilePath

(

string

$style_id

)

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

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

References getSkinDirectory().

Here is the call graph for this function:

getScssSettingsFolderName()

ilSkinStyleContainer::getScssSettingsFolderName

(

)

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

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

getScssSettingsPath()

ilSkinStyleContainer::getScssSettingsPath

(

string

$style_id

)

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

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

References getSkinDirectory().

Here is the call graph for this function:

getSkin()

ilSkinStyleContainer::getSkin

(

)

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

                             : ilSkin
    {
        return $this->skin;
    }

References $skin.

Referenced by createTempZip(), export(), getFontsStylePath(), getImagesStylePath(), getSkinDirectory(), getSoundsStylePath(), ilSkinFactoryTest\testSkinStyleContainerFromId(), and writeSkinToXML().

Here is the caller graph for this function:

getSkinDirectory()

ilSkinStyleContainer::getSkinDirectory

(

)

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

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

References getSkin(), and getSystemStylesConf().

Referenced by createTempZip(), getCSSFilePath(), getFontsStylePath(), getImagesStylePath(), getScssFilePath(), getScssSettingsPath(), getSoundsStylePath(), and writeSkinToXML().

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 134 of file class.ilSkinStyleContainer.php.

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

References getSkin(), and getSkinDirectory().

Here is the call graph for this function:

getSystemStylesConf()

ilSkinStyleContainer::getSystemStylesConf

(

)

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

                                         : ilSystemStyleConfig
    {
        return $this->system_styles_conf;
    }

References $system_styles_conf.

Referenced by getSkinDirectory().

Here is the caller graph for this function:

setMessageStack()

ilSkinStyleContainer::setMessageStack

(

ilSystemStyleMessageStack

$message_stack

)

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

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

References $message_stack.

Referenced by __construct().

Here is the caller graph for this function:

setSkin()

ilSkinStyleContainer::setSkin

(

ilSkin

$skin

)

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

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

References $skin.

setSystemStylesConf()

ilSkinStyleContainer::setSystemStylesConf

(

ilSystemStyleConfig

$system_styles_conf

)

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

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

References $system_styles_conf.

Referenced by __construct().

Here is the caller graph for this function:

writeSkinToXML()

ilSkinStyleContainer::writeSkinToXML ( )

protected

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

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

References getSkin(), and getSkinDirectory().

Here is the call graph for this function:

Field Documentation

$lng

Language ilSkinStyleContainer::$lng

protected

Definition at line 30 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 40 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 35 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 45 of file class.ilSkinStyleContainer.php.

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

---

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

• components/ILIAS/Style/System/classes/Style/class.ilSkinStyleContainer.php