ilDidacticTemplateIconHandler Class Reference

Icon handler for didactic template custom icons. More...

Collaboration diagram for ilDidacticTemplateIconHandler:

Public Member Functions
	__construct (ilDidacticTemplateSetting $setting)
	handleUpload (FileUpload $upload, string $tmpname)
	writeSvg (string $svg)
	getAbsolutePath ()
	copy (ilDidacticTemplateSetting $original)
	delete ()
	toXml (ilXmlWriter $writer)

Protected Attributes
const	WEBDIR_PREFIX = 'ilDidacticTemplateIcons'
ilDidacticTemplateSetting	$settings
ilLogger	$logger
Filesystem	$webDirectory

Private Member Functions
	initWebDir ()

Detailed Description

Icon handler for didactic template custom icons.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateIconHandler::__construct

(

ilDidacticTemplateSetting

$setting

)

Definition at line 42 of file class.ilDidacticTemplateIconHandler.php.

References $DIC, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->settings = $setting;
        $this->webDirectory = $DIC->filesystem()->web();
        $this->logger = $DIC->logger()->otpl();
    }

Here is the call graph for this function:

Member Function Documentation

copy()

ilDidacticTemplateIconHandler::copy

(

ilDidacticTemplateSetting

$original

)

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

References Vendor\Package\$e, ilDidacticTemplateSetting\getIconHandler(), ilDidacticTemplateSetting\getIconIdentifier(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

                                                             : void
    {
        if ($original->getIconHandler()->getAbsolutePath()) {
            try {
                $this->webDirectory->copy(
                    self::WEBDIR_PREFIX . '/' . $original->getIconIdentifier() . '.svg',
                    self::WEBDIR_PREFIX . '/' . $this->settings->getId() . '.svg'
                );
            } catch (Exception $e) {
                $this->logger->warning('Copying icon failed with message: ' . $e->getMessage());
            }
            $this->settings->setIconIdentifier((string) $this->settings->getId());
        } else {
            $this->settings->setIconIdentifier("0");
        }
        $this->settings->update();
    }

Here is the call graph for this function:

delete()

ilDidacticTemplateIconHandler::delete

(

)

Definition at line 117 of file class.ilDidacticTemplateIconHandler.php.

References Vendor\Package\$e, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

                            : void
    {
        if ($this->webDirectory->has(self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg')) {
            try {
                $this->webDirectory->delete(self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg');
                $this->settings->setIconIdentifier('');
                $this->settings->update();
            } catch (Exception $e) {
                $this->logger->warning('Deleting icon dfailed with message: ' . $e->getMessage());
            }
        }
    }

Here is the call graph for this function:

getAbsolutePath()

ilDidacticTemplateIconHandler::getAbsolutePath

(

)

Definition at line 90 of file class.ilDidacticTemplateIconHandler.php.

References ilFileUtils\getWebspaceDir(), and ILIAS\Repository\settings().

                                     : string
    {
        if ($this->webDirectory->has(self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg')) {
            return ilFileUtils::getWebspaceDir() . '/' . self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg';
        }

        return '';
    }

Here is the call graph for this function:

handleUpload()

ilDidacticTemplateIconHandler::handleUpload	(	FileUpload	$upload,
		string	$tmpname
	)

Definition at line 51 of file class.ilDidacticTemplateIconHandler.php.

References Vendor\Package\$e, ILIAS\FileUpload\FileUpload\getResults(), ILIAS\FileUpload\FileUpload\hasBeenProcessed(), ILIAS\FileUpload\FileUpload\hasUploads(), initWebDir(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\Repository\logger(), ILIAS\FileUpload\FileUpload\moveOneFileTo(), ILIAS\FileUpload\FileUpload\process(), and ILIAS\Repository\settings().

                                                                     : void
    {
        if ($upload->hasUploads() && !$upload->hasBeenProcessed()) {
            try {
                $upload->process();
            } catch (IllegalStateException $e) {
                $this->logger->warning('File upload already processed: ' . $e->getMessage());
            }
        }
        $this->initWebDir();
        $result = $upload->getResults()[$tmpname] ?? false;
        if ($result instanceof UploadResult && $result->isOK() && $result->getSize()) {
            $this->delete();
            $upload->moveOneFileTo(
                $result,
                self::WEBDIR_PREFIX,
                Location::WEB,
                $this->settings->getId() . '.svg'
            );

            $this->settings->setIconIdentifier((string) $this->settings->getId());
            $this->settings->update();
        }
    }

Here is the call graph for this function:

initWebDir()

ilDidacticTemplateIconHandler::initWebDir ( )

private

Definition at line 130 of file class.ilDidacticTemplateIconHandler.php.

References Vendor\Package\$e, and ILIAS\Repository\logger().

Referenced by handleUpload().

                                 : void
    {
        if (!$this->webDirectory->has(self::WEBDIR_PREFIX)) {
            try {
                $this->webDirectory->createDir(self::WEBDIR_PREFIX);
            } catch (IOException $e) {
                $this->logger->error('Creating icon directory failed with message: ' . $e->getMessage());
            } catch (IllegalStateException $e) {
                $this->logger->warning('Creating icon directory failed with message: ' . $e->getMessage());
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toXml()

ilDidacticTemplateIconHandler::toXml

(

ilXmlWriter

$writer

)

Definition at line 143 of file class.ilDidacticTemplateIconHandler.php.

References Vendor\Package\$e, ILIAS\Repository\logger(), ILIAS\Repository\settings(), and ilXmlWriter\xmlElement().

                                              : ilXmlWriter
    {
        if ($this->settings->getIconIdentifier()) {
            try {
                if ($this->webDirectory->has(self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg')) {
                    $writer->xmlElement('icon', [], $this->webDirectory->read(
                        self::WEBDIR_PREFIX . '/' . $this->settings->getIconIdentifier() . '.svg'
                    ));
                }
            } catch (Exception $e) {
                $this->logger->warning('Export xml failed with message: ' . $e->getMessage());
            }
        }
        return $writer;
    }

Here is the call graph for this function:

writeSvg()

ilDidacticTemplateIconHandler::writeSvg

(

string

$svg

)

Definition at line 76 of file class.ilDidacticTemplateIconHandler.php.

References Vendor\Package\$e, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

                                         : void
    {
        try {
            $this->webDirectory->write(
                self::WEBDIR_PREFIX . '/' . $this->settings->getId() . '.svg',
                trim($svg)
            );
            $this->settings->setIconIdentifier((string) $this->settings->getId());
            $this->settings->update();
        } catch (Exception $e) {
            $this->logger->warning('Error writing svg image from xml: ' . $e->getMessage());
        }
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilDidacticTemplateIconHandler::$logger

protected

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

$settings

ilDidacticTemplateSetting ilDidacticTemplateIconHandler::$settings

protected

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

$webDirectory

Filesystem ilDidacticTemplateIconHandler::$webDirectory

protected

Definition at line 40 of file class.ilDidacticTemplateIconHandler.php.

WEBDIR_PREFIX

const ilDidacticTemplateIconHandler::WEBDIR_PREFIX = 'ilDidacticTemplateIcons'

protected

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

---

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

• components/ILIAS/DidacticTemplate/classes/Icon/class.ilDidacticTemplateIconHandler.php