ilObjectCustomIcon Class Reference

Class ilObjectCustomIconImpl TODO: Inject database persistence in future instead of using . More...

Collaboration diagram for ilObjectCustomIcon:

Public Member Functions
	__construct (protected Filesystem $filesystem, protected FileUpload $upload, protected ilObjectCustomIconConfiguration $config, protected int $objId)
	copy (int $targetObjId)
	delete ()
	getSupportedFileExtensions ()
	saveFromSourceFile (string $sourceFilePath)
	saveFromTempFileName (string $tempfile_name)
	remove ()
	exists ()
	getFullPath ()
	createFromImportDir (string $source_dir)

Protected Member Functions
	getObjId ()
	persistIconState (string $fileName)
	createCustomIconDirectory ()
	getIconDirectory ()
	getIconFileName ()
	getRelativePath ()

Private Attributes
const	ICON_BASENAME = 'icon_custom'

Detailed Description

Class ilObjectCustomIconImpl TODO: Inject database persistence in future instead of using .

Definition at line 31 of file class.ilObjectCustomIcon.php.

Constructor & Destructor Documentation

__construct()

ilObjectCustomIcon::__construct	(	protected Filesystem	$filesystem,
		protected FileUpload	$upload,
		protected ilObjectCustomIconConfiguration	$config,
		protected int	$objId
	)

Definition at line 35 of file class.ilObjectCustomIcon.php.

      {
    }

Member Function Documentation

copy()

ilObjectCustomIcon::copy

(

int

$targetObjId

)

Definition at line 48 of file class.ilObjectCustomIcon.php.

References Vendor\Package\$e, ilContainer\_writeContainerSetting(), exists(), ILIAS\Repository\filesystem(), and getRelativePath().

                                          : void
    {
        if (!$this->exists()) {
            ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', '0');
            return;
        }

        try {
            $this->filesystem->copy(
                $this->getRelativePath(),
                preg_replace(
                    '/(' . $this->config->getSubDirectoryPrefix() . ')(\d*)\/(.*)$/',
                    '${1}' . $targetObjId . '/${3}',
                    $this->getRelativePath()
                )
            );

            ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', '1');
        } catch (Exception $e) {
            ilContainer::_writeContainerSetting($targetObjId, 'icon_custom', '0');
        }
    }

Here is the call graph for this function:

createCustomIconDirectory()

ilObjectCustomIcon::createCustomIconDirectory ( )

protected

Exceptions

IOException

Definition at line 183 of file class.ilObjectCustomIcon.php.

References ILIAS\Repository\filesystem(), and getIconDirectory().

Referenced by saveFromSourceFile(), and saveFromTempFileName().

                                                  : void
    {
        $iconDirectory = $this->getIconDirectory();

        if (!$this->filesystem->has(dirname($iconDirectory))) {
            $this->filesystem->createDir(dirname($iconDirectory));
        }

        if (!$this->filesystem->has($iconDirectory)) {
            $this->filesystem->createDir($iconDirectory);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFromImportDir()

ilObjectCustomIcon::createFromImportDir

(

string

$source_dir

)

Definition at line 235 of file class.ilObjectCustomIcon.php.

References getIconDirectory(), getRelativePath(), ilFileUtils\getWebspaceDir(), persistIconState(), and ilFileUtils\rCopy().

                                                           : void
    {
        $target_dir = implode(DIRECTORY_SEPARATOR, [
            ilFileUtils::getWebspaceDir(),
            $this->getIconDirectory()
        ]);
        ilFileUtils::rCopy($source_dir, $target_dir);
        $this->persistIconState($this->getRelativePath());
    }

Here is the call graph for this function:

delete()

ilObjectCustomIcon::delete

(

)

Definition at line 71 of file class.ilObjectCustomIcon.php.

References Vendor\Package\$e, ilContainer\_deleteContainerSettings(), ILIAS\Repository\filesystem(), getIconDirectory(), and getObjId().

                            : void
    {
        if ($this->filesystem->hasDir($this->getIconDirectory())) {
            try {
                $this->filesystem->deleteDir($this->getIconDirectory());
            } catch (Exception $e) {
            }
        }

        ilContainer::_deleteContainerSettings($this->getObjId(), 'icon_custom');
    }

Here is the call graph for this function:

exists()

ilObjectCustomIcon::exists

(

)

Definition at line 217 of file class.ilObjectCustomIcon.php.

References ilContainer\_lookupContainerSetting(), ILIAS\Repository\filesystem(), getObjId(), and getRelativePath().

Referenced by copy().

                            : bool
    {
        if (!ilContainer::_lookupContainerSetting($this->getObjId(), 'icon_custom', '0')) {
            return false;
        }

        return $this->filesystem->has($this->getRelativePath());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullPath()

ilObjectCustomIcon::getFullPath

(

)

Definition at line 226 of file class.ilObjectCustomIcon.php.

References getRelativePath(), and ilFileUtils\getWebspaceDir().

Referenced by saveFromTempFileName().

                                 : string
    {
        // TODO: Currently there is no option to get the relative base directory of a filesystem
        return implode(DIRECTORY_SEPARATOR, [
            ilFileUtils::getWebspaceDir(),
            $this->getRelativePath()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIconDirectory()

ilObjectCustomIcon::getIconDirectory ( )

protected

Definition at line 196 of file class.ilObjectCustomIcon.php.

References getObjId().

Referenced by createCustomIconDirectory(), createFromImportDir(), delete(), getRelativePath(), and saveFromTempFileName().

                                         : string
    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->config->getBaseDirectory(),
            $this->config->getSubDirectoryPrefix() . $this->getObjId()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIconFileName()

ilObjectCustomIcon::getIconFileName ( )

protected

Definition at line 204 of file class.ilObjectCustomIcon.php.

Referenced by getRelativePath(), and saveFromTempFileName().

                                        : string
    {
        return self::ICON_BASENAME . '.' . $this->config->getTargetFileExtension();
    }

Here is the caller graph for this function:

getObjId()

ilObjectCustomIcon::getObjId ( )

protected

Definition at line 43 of file class.ilObjectCustomIcon.php.

References $objId.

Referenced by delete(), exists(), getIconDirectory(), persistIconState(), and remove().

                                 : int
    {
        return $this->objId;
    }

Here is the caller graph for this function:

getRelativePath()

ilObjectCustomIcon::getRelativePath ( )

protected

Definition at line 209 of file class.ilObjectCustomIcon.php.

References getIconDirectory(), and getIconFileName().

Referenced by copy(), createFromImportDir(), exists(), getFullPath(), remove(), saveFromSourceFile(), and saveFromTempFileName().

                                        : string
    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->getIconDirectory(),
            $this->getIconFileName()
        ]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSupportedFileExtensions()

ilObjectCustomIcon::getSupportedFileExtensions

(

)

Returns

string[]

Definition at line 86 of file class.ilObjectCustomIcon.php.

                                                : array
    {
        return $this->config->getSupportedFileExtensions();
    }

persistIconState()

ilObjectCustomIcon::persistIconState ( string  $fileName )

protected

Definition at line 160 of file class.ilObjectCustomIcon.php.

References ilContainer\_writeContainerSetting(), ILIAS\Repository\filesystem(), and getObjId().

Referenced by createFromImportDir(), saveFromSourceFile(), and saveFromTempFileName().

                                                         : void
    {
        if ($this->filesystem->has($fileName)) {
            ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', '1');
        } else {
            ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', '0');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

ilObjectCustomIcon::remove

(

)

Definition at line 169 of file class.ilObjectCustomIcon.php.

References ilContainer\_writeContainerSetting(), ILIAS\Repository\filesystem(), getObjId(), and getRelativePath().

                            : void
    {
        $fileName = $this->getRelativePath();

        if ($this->filesystem->has($fileName)) {
            $this->filesystem->delete($fileName);
        }

        ilContainer::_writeContainerSetting($this->getObjId(), 'icon_custom', '0');
    }

Here is the call graph for this function:

saveFromSourceFile()

ilObjectCustomIcon::saveFromSourceFile

(

string

$sourceFilePath

)

Definition at line 91 of file class.ilObjectCustomIcon.php.

References createCustomIconDirectory(), ILIAS\Repository\filesystem(), getRelativePath(), and persistIconState().

                                                              : void
    {
        $this->createCustomIconDirectory();

        $fileName = $this->getRelativePath();

        if ($this->filesystem->has($fileName)) {
            $this->filesystem->delete($fileName);
        }

        $this->filesystem->copy($sourceFilePath, $fileName);

        $this->persistIconState($fileName);
    }

Here is the call graph for this function:

saveFromTempFileName()

ilObjectCustomIcon::saveFromTempFileName

(

string

$tempfile_name

)

Definition at line 106 of file class.ilObjectCustomIcon.php.

References createCustomIconDirectory(), ILIAS\Repository\filesystem(), ilFileUtils\getDataDir(), getFullPath(), getIconDirectory(), getIconFileName(), getRelativePath(), persistIconState(), and ILIAS\Repository\upload().

                                                               : void
    {
        $this->createCustomIconDirectory();

        $relative_path = $this->getRelativePath();

        if ($this->filesystem->has($relative_path)) {
            $this->filesystem->delete($relative_path);
        }

        rename(ilFileUtils::getDataDir() . '/temp/' . $tempfile_name, $this->getFullPath());
        $this->filesystem->setVisibility($relative_path, 'public');


        foreach ($this->config->getUploadPostProcessors() as $processor) {
            $processor->process($relative_path);
        }

        $this->persistIconState($relative_path);
    }

Here is the call graph for this function:

Field Documentation

ICON_BASENAME

const ilObjectCustomIcon::ICON_BASENAME = 'icon_custom'

private

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

---

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

• Services/Object/classes/Properties/AdditionalProperties/Icon/class.ilObjectCustomIcon.php