ilSkinFactory Class Reference

Factory to create Skin classes holds an manages the basic data of a skin as provide by the template of the skin. More...

Collaboration diagram for ilSkinFactory:

Public Member Functions
	__construct (ilLanguage $lng, ?ilSystemStyleConfig $config=null)
	skinStyleContainerFromId (string $skin_id, ilSystemStyleMessageStack $message_stack)
	Get container 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...
	skinStyleContainerFromZip (string $import_zip_path, string $name, ilSystemStyleMessageStack $message_stack)
	Imports a skin from zip. More...
	copyFromSkinStyleContainer (ilSkinStyleContainer $container, ilFileSystemHelper $file_system, ilSystemStyleMessageStack $message_stack, string $new_skin_txt_addon='Copy')
	Copies a complete Skin. More...

Protected Attributes
ilSystemStyleConfig	$config
ilLanguage	$lng

Private Attributes
Archives	$archives

Detailed Description

Factory to create Skin classes holds an manages the basic data of a skin as provide by the template of the skin.

Definition at line 30 of file class.ilSkinFactory.php.

Constructor & Destructor Documentation

__construct()

ilSkinFactory::__construct	(	ilLanguage	$lng,
		?ilSystemStyleConfig	$config = null
	)

Definition at line 36 of file class.ilSkinFactory.php.

References $config, $DIC, Vendor\Package\$e, $id, $lng, $path, ilSystemStyleException\FILE_OPENING_FAILED, ILIAS\Repository\lng(), ilSystemStyleException\NO_PARENT_STYLE, ilSkinStyle\parseFromXMLElement(), and ilSkin\setVersion().

    {
        global $DIC;
        $this->lng = $lng;
        $this->archives = new Archives();

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

Here is the call graph for this function:

Member Function Documentation

copyFromSkinStyleContainer()

ilSkinFactory::copyFromSkinStyleContainer	(	ilSkinStyleContainer	$container,
		ilFileSystemHelper	$file_system,
		ilSystemStyleMessageStack	$message_stack,
		string	$new_skin_txt_addon = 'Copy'
	)

Copies a complete Skin.

Exceptions

ilSystemStyleException

Definition at line 161 of file class.ilSkinFactory.php.

References ilSkinStyleContainer\getSkin(), ilSkinStyleContainer\getSkinDirectory(), ilSkinStyleContainer\getSystemStylesConf(), ilFileSystemHelper\recursiveCopy(), ilStyleDefinition\skinExists(), and skinStyleContainerFromId().

     : ilSkinStyleContainer {
        $new_skin_id_addon = '';
        $new_skin_name_addon = '';

        while (ilStyleDefinition::skinExists(
            $container->getSkin()->getId() . $new_skin_id_addon,
            $container->getSystemStylesConf()
        )) {
            $new_skin_id_addon .= $new_skin_txt_addon;
            $new_skin_name_addon .= ' ' . $new_skin_txt_addon;
        }

        $new_skin_path = rtrim($container->getSkinDirectory(), '/') . $new_skin_id_addon;

        mkdir($new_skin_path, 0775, true);
        $file_system->recursiveCopy($container->getSkinDirectory(), $new_skin_path);
        $skin_container = $this->skinStyleContainerFromId($container->getSkin()->getId() . $new_skin_id_addon, $message_stack);
        $skin_container->getSkin()->setName($skin_container->getSkin()->getName() . $new_skin_name_addon);
        $skin_container->getSkin()->setVersion('0.1');
        $skin_container->updateSkin($skin_container->getSkin());
        return $skin_container;
    }

Here is the call graph for this function:

skinStyleContainerFromId()

ilSkinFactory::skinStyleContainerFromId	(	string	$skin_id,
		ilSystemStyleMessageStack	$message_stack
	)

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

Exceptions

ilSystemStyleException

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

References ILIAS\Repository\lng(), and ilSystemStyleException\NO_SKIN_ID.

Referenced by ilSystemStyleScssGUI\__construct(), ilSystemStyleIconsGUI\__construct(), ilSystemStyleOverviewGUI\__construct(), copyFromSkinStyleContainer(), and skinStyleContainerFromZip().

     : ilSkinStyleContainer {
        if (!$skin_id) {
            throw new ilSystemStyleException(ilSystemStyleException::NO_SKIN_ID);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

skinStyleContainerFromZip()

ilSkinFactory::skinStyleContainerFromZip	(	string	$import_zip_path,
		string	$name,
		ilSystemStyleMessageStack	$message_stack
	)

Imports a skin from zip.

Exceptions

ilSystemStyleException

Definition at line 123 of file class.ilSkinFactory.php.

References $container, ilStyleDefinition\skinExists(), and skinStyleContainerFromId().

     : ilSkinStyleContainer {
        $original_skin_id = preg_replace('/[^A-Za-z0-9\-_]/', '', rtrim($name, '.zip'));
        $skin_id = $original_skin_id;

        while (ilStyleDefinition::skinExists($skin_id, $this->config)) {
            $skin_id .= 'Copy';
        }

        $skin_path = $this->config->getCustomizingSkinPath() . $skin_id;
        $temp_skin_path = $skin_path."temp";
        $zip_path = $temp_skin_path . ".zip";
        rename($import_zip_path, $zip_path);

        $this->archives->unzip(
            Streams::ofResource(fopen($zip_path, 'rb')),
            $this->archives->unzipOptions()
             ->withZipOutputPath($temp_skin_path)
             ->withOverwrite(false)
             ->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
        )->extract();
        unlink($zip_path);
        rename($temp_skin_path."/".$original_skin_id, $skin_path);
        rmdir($temp_skin_path);
        $container = $this->skinStyleContainerFromId($skin_id, $message_stack);
        $container->getSkin()->setId($skin_id);
        $container->setSkin($container->getSkin());
        $container->updateSkin();
        return $container;
    }

Here is the call graph for this function:

Field Documentation

$archives

Archives ilSkinFactory::$archives

private

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

$config

ilSystemStyleConfig ilSkinFactory::$config

protected

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

Referenced by __construct().

$lng

ilLanguage ilSkinFactory::$lng

protected

Definition at line 34 of file class.ilSkinFactory.php.

Referenced by __construct().

---

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

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