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...

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

	copyVariablesFromDefault (ilSkinStyle $style)
	Copies (resets) the variables file 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...

	compileLess (string $style_id)

	getSkin ()

	setSkin (ilSkin $skin)

	getSkinDirectory ()

	getCSSFilePath (string $style_id)

	getLessFilePath (string $style_id)

	getLessVariablesFilePath (string $style_id)

	getLessVariablesName (string $style_id)

	getImagesSkinPath (string $style_id)

	getMessageStack ()

	setMessageStack (ilSystemStyleMessageStack $message_stack)

	addStyle (ilSkinStyle $style)

	getSystemStylesConf ()

	setSystemStylesConf (ilSystemStyleConfig $system_styles_conf)

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

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

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

	changeVariablesImport (string $main_path, string $old_style_import, string $new_style_import)

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

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

Referenced by ilSkinStyleContainerTest\testAddStyle().

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

◆ changeVariablesImport()

ilSkinStyleContainer::changeVariablesImport	(	string	$main_path,
		string	$old_style_import,
		string	$new_style_import
	)

protected

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

Referenced by updateStyle().

      : void {
         $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);
     }

Here is the caller graph for this function:

◆ compileLess()

ilSkinStyleContainer::compileLess ( string $style_id )

Exceptions

ilSystemStyleException

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

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

Referenced by createLessStructure(), and updateStyle().

                                                  : void
     {
         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);
     }

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

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

Referenced by createLessStructure().

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

◆ copyVariablesFromDefault()

ilSkinStyleContainer::copyVariablesFromDefault ( ilSkinStyle $style )

Copies (resets) the variables file from delos.

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

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

Referenced by createLessStructure(), and updateStyle().

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

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 Vendor\Package\$e, ilSystemStyleMessageStack\addMessage(), createLessStructure(), getImagesSkinPath(), getSkin(), getSkinDirectory(), getSystemStylesConf(), ILIAS\Repository\lng(), ilSystemStyleException\SKIN_ALREADY_EXISTS, ilSystemStyleMessage\TYPE_ERROR, and writeSkinToXML().

Referenced by ilSkinStyleContainerTest\testCreateDelete().

                                                                     : void
     {
         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->file_system->createResourceDirectory(
                 $this->getSystemStylesConf()->getDefaultImagesPath(),
                 $this->getImagesSkinPath($style->getId())
             );
             $this->file_system->createResourceDirectory(
                 $this->getSystemStylesConf()->getDefaultSoundsPath(),
                 $this->getSkinDirectory() . $style->getSoundDirectory()
             );
             $this->file_system->createResourceDirectory(
                 $this->getSystemStylesConf()->getDefaultFontsPath(),
                 $this->getSkinDirectory() . $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();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createLessStructure()

ilSkinStyleContainer::createLessStructure ( ilSkinStyle $style )

protected

Creates the less/css structure of a style.

Exceptions

ilSystemStyleException

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

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

Referenced by create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMainLessFile()

ilSkinStyleContainer::createMainLessFile ( ilSkinStyle $style )

Creates the main less file.

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

References $path, ilSkinStyle\getId(), getLessFilePath(), getLessMainFileDefautContent(), getMessageStack(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by createLessStructure(), and updateStyle().

                                                           : void
     {
         $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
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTempZip()

ilSkinStyleContainer::createTempZip ( )

Creates a temp zip file.

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

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

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

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

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

References ilSystemStyleSettings\deleteSubStyleCategoryAssignments(), getCSSFilePath(), ilSkinStyle\getFontDirectory(), ILIAS\Survey\Mode\getId(), ilSkinStyle\getId(), ilSkinStyle\getImageDirectory(), getLessFilePath(), getLessVariablesFilePath(), getMessageStack(), ilSkinStyle\getName(), getSkin(), getSkinDirectory(), ilSkinStyle\getSoundDirectory(), ilSkinStyle\getSubstyleOf(), ilSkinStyle\isSubstyle(), ILIAS\Repository\lng(), resourcesStyleReferences(), 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->getLessFilePath($style->getId()));
         $this->file_system->saveDeleteFile($this->getCSSFilePath($style->getId()));
         $this->file_system->saveDeleteFile($this->getLessVariablesFilePath($style->getId()));
 
         $this->getSkin()->removeStyle($style->getId());
 
         $this->file_system->removeResourceDirectory(
             $this->getSkinDirectory(),
             $style->getImageDirectory(),
             count($this->resourcesStyleReferences($style->getImageDirectory())) > 0
         );
         $this->file_system->removeResourceDirectory(
             $this->getSkinDirectory(),
             $style->getFontDirectory(),
             count($this->resourcesStyleReferences($style->getImageDirectory())) > 0
         );
         $this->file_system->removeResourceDirectory(
             $this->getSkinDirectory(),
             $style->getSoundDirectory(),
             count($this->resourcesStyleReferences($style->getImageDirectory())) > 0
         );
 
         $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 380 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 452 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSkinDirectory().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagesSkinPath()

ilSkinStyleContainer::getImagesSkinPath ( string $style_id )

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

References getSkin(), and getSkinDirectory().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessFilePath()

ilSkinStyleContainer::getLessFilePath ( string $style_id )

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

References getSkin(), and getSkinDirectory().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessMainFileDefautContent()

ilSkinStyleContainer::getLessMainFileDefautContent ( ilSkinStyle $style )

protected

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

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

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

Referenced by createMainLessFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessVariablesFilePath()

ilSkinStyleContainer::getLessVariablesFilePath ( string $style_id )

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

References getLessVariablesName(), and getSkinDirectory().

Referenced by copyVariablesFromDefault(), deleteStyle(), and updateStyle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLessVariablesName()

ilSkinStyleContainer::getLessVariablesName ( string $style_id )

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

References getSkin().

Referenced by getLessMainFileDefautContent(), getLessVariablesFilePath(), and updateStyle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessageStack()

ilSkinStyleContainer::getMessageStack ( )

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

References $message_stack.

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

                                      : ilSystemStyleMessageStack
     {
         return $this->message_stack;
     }

Here is the caller graph for this function:

◆ getSkin()

ilSkinStyleContainer::getSkin ( )

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

References $skin.

Referenced by addStyle(), ilSkinFactory\copyFromSkinStyleContainer(), create(), createTempZip(), deleteStyle(), export(), getCSSFilePath(), getImagesSkinPath(), getLessFilePath(), getLessVariablesName(), getSkinDirectory(), resourcesStyleReferences(), 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 447 of file class.ilSkinStyleContainer.php.

References getSkin(), and getSystemStylesConf().

Referenced by ilSkinFactory\copyFromSkinStyleContainer(), create(), createTempZip(), delete(), deleteStyle(), getCSSFilePath(), getImagesSkinPath(), getLessFilePath(), getLessVariablesFilePath(), resetImages(), 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:

◆ getSystemStylesConf()

ilSkinStyleContainer::getSystemStylesConf ( )

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

References $system_styles_conf.

Referenced by copyCSSFromDefault(), ilSkinFactory\copyFromSkinStyleContainer(), copyVariablesFromDefault(), create(), getLessMainFileDefautContent(), 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 284 of file class.ilSkinStyleContainer.php.

References ilSkinStyle\getId(), ilSkinStyle\getImageDirectory(), getImagesSkinPath(), getSkinDirectory(), and getSystemStylesConf().

                                                    : void
     {
         $this->file_system->recursiveRemoveDir($this->getSkinDirectory() . $style->getImageDirectory());
         $this->file_system->createResourceDirectory(
             $this->getSystemStylesConf()->getDefaultImagesPath(),
             $this->getImagesSkinPath($style->getId())
         );
     }

Here is the call graph for this function:

◆ resourcesStyleReferences()

ilSkinStyleContainer::resourcesStyleReferences ( string $resource )

protected

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

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

References getSkin().

Referenced by deleteStyle(), and updateStyle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMessageStack()

ilSkinStyleContainer::setMessageStack ( ilSystemStyleMessageStack $message_stack )

Definition at line 482 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 442 of file class.ilSkinStyleContainer.php.

References $skin.

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

◆ setSystemStylesConf()

ilSkinStyleContainer::setSystemStylesConf ( ilSystemStyleConfig $system_styles_conf )

Definition at line 504 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 112 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 132 of file class.ilSkinStyleContainer.php.

References Vendor\Package\$e, changeVariablesImport(), compileLess(), copyVariablesFromDefault(), createMainLessFile(), ilSkinStyle\getCssFile(), getCSSFilePath(), ilSkinStyle\getFontDirectory(), ilSkinStyle\getImageDirectory(), getImagesSkinPath(), getLessFilePath(), getLessVariablesFilePath(), getLessVariablesName(), getMessageStack(), getSkin(), getSkinDirectory(), ilSkinStyle\getSoundDirectory(), getSystemStylesConf(), resourcesStyleReferences(), ilSystemStyleMessage\TYPE_ERROR, and writeSkinToXML().

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

                                                                          : void
     {
         $style = $this->getSkin()->getStyle($style_id);
         if ($style->getImageDirectory() != $old_style->getImageDirectory()) {
             if (file_exists($this->getSkinDirectory() . $old_style->getImageDirectory())) {
                 $this->file_system->changeResourceDirectory(
                     $this->getSkinDirectory(),
                     $style->getImageDirectory(),
                     $old_style->getImageDirectory(),
                     count($this->resourcesStyleReferences($old_style->getImageDirectory())) > 0
                 );
             } else {
                 $this->file_system->createResourceDirectory(
                     $this->getSystemStylesConf()->getDefaultImagesPath(),
                     $this->getImagesSkinPath($style->getId())
                 );
             }
         }
 
         if ($style->getFontDirectory() != $old_style->getFontDirectory()) {
             if (file_exists($this->getSkinDirectory() . $old_style->getFontDirectory())) {
                 $this->file_system->changeResourceDirectory(
                     $this->getSkinDirectory(),
                     $style->getFontDirectory(),
                     $old_style->getFontDirectory(),
                     count($this->resourcesStyleReferences($old_style->getFontDirectory())) > 0
                 );
             } else {
                 $this->file_system->createResourceDirectory(
                     $this->getSystemStylesConf()->getDefaultFontsPath(),
                     $this->getSkinDirectory() . $style->getFontDirectory()
                 );
             }
         }
 
         if ($style->getSoundDirectory() != $old_style->getSoundDirectory()) {
             if (file_exists($this->getSkinDirectory() . $old_style->getSoundDirectory())) {
                 $this->file_system->changeResourceDirectory(
                     $this->getSkinDirectory(),
                     $style->getSoundDirectory(),
                     $old_style->getSoundDirectory(),
                     count($this->resourcesStyleReferences($old_style->getSoundDirectory())) > 0
                 );
             } else {
                 $this->file_system->createResourceDirectory(
                     $this->getSystemStylesConf()->getDefaultSoundsPath(),
                     $this->getSkinDirectory() . $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();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSkinToXML()

ilSkinStyleContainer::writeSkinToXML ( )

protected

Definition at line 494 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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStyle()

◆ changeVariablesImport()

◆ compileLess()

◆ copyCSSFromDefault()

◆ copyVariablesFromDefault()

◆ create()

◆ createLessStructure()

◆ createMainLessFile()

◆ createTempZip()

◆ delete()

◆ deleteStyle()

◆ export()

◆ getCSSFilePath()

◆ getImagesSkinPath()

◆ getLessFilePath()

◆ getLessMainFileDefautContent()

◆ getLessVariablesFilePath()

◆ getLessVariablesName()

◆ getMessageStack()

◆ getSkin()

◆ getSkinDirectory()

◆ getSystemStylesConf()

◆ resetImages()

◆ resourcesStyleReferences()

◆ setMessageStack()

◆ setSkin()

◆ setSystemStylesConf()

◆ updateSkin()

◆ updateStyle()

◆ writeSkinToXML()

Field Documentation

◆ $file_system

◆ $lng

◆ $message_stack

◆ $skin

◆ $system_styles_conf