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)
	ilObjectCustomIconImpl constructor. More...
	copy (int $targetObjId)
	Parameters int $targetObjId More...
	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) More...
	getSupportedFileExtensions ()
	saveFromSourceFile (string $sourceFilePath)
	Parameters string $sourceFilePath Exceptions More...
	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) More...
	exists ()
	Returns bool More...
	getFullPath ()
	Returns string More...
	createFromImportDir ($source_dir)
Public Member Functions inherited from ilObjectCustomIcon
	saveFromHttpRequest ()

Data Fields
const	ICON_BASENAME = 'icon_custom'

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

Protected Attributes
	$webDirectory
	$upload
	$config
	$objId

Detailed Description

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

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

Constructor & Destructor Documentation

__construct()

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

ilObjectCustomIconImpl constructor.

Parameters

Filesystem	$webDirectory
FileUpload	$uploadService
ilCustomIconObjectConfiguration	$config
	$objId

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

References $config, $objId, and $webDirectory.

    {
        $this->objId = $objId;

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

Member Function Documentation

copy()

ilObjectCustomIconImpl::copy

(

int

$targetObjId

)

Parameters

int

$targetObjId

Implements ilObjectCustomIcon.

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

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

    {
        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

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

References getIconDirectory().

Referenced by saveFromSourceFile().

    {
        $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

(

$source_dir

)

Parameters

$source_dir
$filename

Exceptions

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

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

    {
        $target_dir = implode(DIRECTORY_SEPARATOR, [
            \ilUtil::getWebspaceDir(),
            $this->getIconDirectory()
        ]);
        ilUtil::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 80 of file class.ilObjectCustomIconImpl.php.

References ilContainer\_deleteContainerSettings(), getIconDirectory(), and getObjId().

    {
        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

(

)

Returns

bool

Implements ilObjectCustomIcon.

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

(

)

Returns

string

Implements ilObjectCustomIcon.

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

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

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

Here is the call graph for this function:

getIconDirectory()

ilObjectCustomIconImpl::getIconDirectory ( )

protected

Returns

string

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

Returns

string

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

Returns

int

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

Returns

string

Definition at line 218 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 95 of file class.ilObjectCustomIconImpl.php.

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

persistIconState()

ilObjectCustomIconImpl::persistIconState ( string  $fileName )

protected

Parameters

string

$fileName

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

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

Referenced by createFromImportDir(), and saveFromSourceFile().

    {
        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 169 of file class.ilObjectCustomIconImpl.php.

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

    {
        $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

)

Parameters

string

$sourceFilePath

Exceptions

Implements ilObjectCustomIcon.

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

References $result, createCustomIconDirectory(), getIconDirectory(), getIconFileName(), getRelativePath(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, persistIconState(), and ilObjectCustomIcon\saveFromHttpRequest().

    {
        $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

ilObjectCustomIconImpl::$config

protected

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

Referenced by __construct().

$objId

ilObjectCustomIconImpl::$objId

protected

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

Referenced by __construct(), and getObjId().

$upload

ilObjectCustomIconImpl::$upload

protected

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

$webDirectory

ilObjectCustomIconImpl::$webDirectory

protected

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

Referenced by __construct().

ICON_BASENAME

const ilObjectCustomIconImpl::ICON_BASENAME = 'icon_custom'

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

---

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

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