ilObjectCustomIconImpl Class Reference

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

Inheritance diagram for ilObjectCustomIconImpl:

Collaboration diagram for ilObjectCustomIconImpl:

Public Member Functions
	__construct (Filesystem $webDirectory, FileUpload $uploadService, ilCustomIconObjectConfiguration $config, int $objId)
	copy (int $targetObjId)
	delete ()
	Should be called if a consuming object is removed from system. More...
	getSupportedFileExtensions ()
	saveFromSourceFile (string $sourceFilePath)
	remove ()
	Should be called if a consuming object just wants to delete the icon The implementer MUST only delete the icon itself and corresponding persistent data (e.g. More...
	exists ()
	getFullPath ()
	createFromImportDir (string $source_dir)
Public Member Functions inherited from ilObjectCustomIcon
	saveFromHttpRequest ()

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

Protected Attributes
Filesystem	$webDirectory
FileUpload	$upload
ilCustomIconObjectConfiguration	$config
int	$objId

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

Constructor & Destructor Documentation

__construct()

ilObjectCustomIconImpl::__construct	(	Filesystem	$webDirectory,
		FileUpload	$uploadService,
		ilCustomIconObjectConfiguration	$config,
		int	$objId
	)

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

References $config, $objId, $webDirectory, and ILIAS\Repository\upload().

      {
        $this->objId = $objId;

        $this->webDirectory = $webDirectory;
        $this->upload = $uploadService;
        $this->config = $config;
    }

Here is the call graph for this function:

Member Function Documentation

copy()

ilObjectCustomIconImpl::copy

(

int

$targetObjId

)

Implements ilObjectCustomIcon.

Definition at line 58 of file class.ilObjectCustomIconImpl.php.

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

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

        try {
            $this->webDirectory->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()

ilObjectCustomIconImpl::createCustomIconDirectory ( )

protected

Exceptions

IOException

Definition at line 174 of file class.ilObjectCustomIconImpl.php.

References getIconDirectory().

Referenced by saveFromSourceFile().

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

createFromImportDir()

ilObjectCustomIconImpl::createFromImportDir

(

string

$source_dir

)

Exceptions

DirectoryNotFoundException
FileNotFoundException
IOException

Implements ilObjectCustomIcon.

Definition at line 226 of file class.ilObjectCustomIconImpl.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()

ilObjectCustomIconImpl::delete

(

)

Should be called if a consuming object is removed from system.

The implementer MUST delete all object specific custom icon data (folders, icons, persistent data)

Implements ilObjectCustomIcon.

Definition at line 81 of file class.ilObjectCustomIconImpl.php.

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

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

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

Here is the call graph for this function:

exists()

ilObjectCustomIconImpl::exists

(

)

Implements ilObjectCustomIcon.

Definition at line 208 of file class.ilObjectCustomIconImpl.php.

References ilContainer\_lookupContainerSetting(), getObjId(), and getRelativePath().

Referenced by copy().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFullPath()

ilObjectCustomIconImpl::getFullPath

(

)

Implements ilObjectCustomIcon.

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

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

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

getIconDirectory()

ilObjectCustomIconImpl::getIconDirectory ( )

protected

Definition at line 187 of file class.ilObjectCustomIconImpl.php.

References getObjId().

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

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

ilObjectCustomIconImpl::getIconFileName ( )

protected

Definition at line 195 of file class.ilObjectCustomIconImpl.php.

Referenced by getRelativePath(), and saveFromSourceFile().

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

Here is the caller graph for this function:

getObjId()

ilObjectCustomIconImpl::getObjId ( )

protected

Definition at line 53 of file class.ilObjectCustomIconImpl.php.

References $objId.

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

                                 : int
    {
        return $this->objId;
    }

Here is the caller graph for this function:

getRelativePath()

ilObjectCustomIconImpl::getRelativePath ( )

protected

Definition at line 200 of file class.ilObjectCustomIconImpl.php.

References getIconDirectory(), and getIconFileName().

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

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

ilObjectCustomIconImpl::getSupportedFileExtensions

(

)

Returns

string[]

Implements ilObjectCustomIcon.

Definition at line 96 of file class.ilObjectCustomIconImpl.php.

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

persistIconState()

ilObjectCustomIconImpl::persistIconState ( string  $fileName )

protected

Definition at line 151 of file class.ilObjectCustomIconImpl.php.

References ilContainer\_writeContainerSetting(), and getObjId().

Referenced by createFromImportDir(), and saveFromSourceFile().

                                                         : void
    {
        if ($this->webDirectory->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()

ilObjectCustomIconImpl::remove

(

)

Should be called if a consuming object just wants to delete the icon The implementer MUST only delete the icon itself and corresponding persistent data (e.g.

stored in a database)

Implements ilObjectCustomIcon.

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

References ilContainer\_writeContainerSetting(), getObjId(), and getRelativePath().

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

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

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

Here is the call graph for this function:

saveFromSourceFile()

ilObjectCustomIconImpl::saveFromSourceFile

(

string

$sourceFilePath

)

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException

Implements ilObjectCustomIcon.

Definition at line 101 of file class.ilObjectCustomIconImpl.php.

References createCustomIconDirectory(), getIconDirectory(), getIconFileName(), getRelativePath(), persistIconState(), ilObjectCustomIcon\saveFromHttpRequest(), and ILIAS\Repository\upload().

                                                              : void
    {
        $this->createCustomIconDirectory();

        $fileName = $this->getRelativePath();

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

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

        $this->persistIconState($fileName);
    }

Here is the call graph for this function:

Field Documentation

$config

ilCustomIconObjectConfiguration ilObjectCustomIconImpl::$config

protected

Definition at line 37 of file class.ilObjectCustomIconImpl.php.

Referenced by __construct().

$objId

int ilObjectCustomIconImpl::$objId

protected

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

Referenced by __construct(), and getObjId().

$upload

FileUpload ilObjectCustomIconImpl::$upload

protected

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

$webDirectory

Filesystem ilObjectCustomIconImpl::$webDirectory

protected

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

Referenced by __construct().

ICON_BASENAME

const ilObjectCustomIconImpl::ICON_BASENAME = 'icon_custom'

private

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

---

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

• Services/Object/Icon/classes/class.ilObjectCustomIconImpl.php