ilObjectTileImage Class Reference

Inheritance diagram for ilObjectTileImage:

Collaboration diagram for ilObjectTileImage:

Public Member Functions
	__construct (ilObjectService $service, int $obj_id)
	getExtension ()
	copy (int $target_obj_id)
	delete ()
	getRelativeDirectory ()
	exists ()
	getFullPath ()
	createFromImportDir (string $source_dir, string $ext)
Public Member Functions inherited from ilObjectTileImageInterface
	saveFromHttpRequest (string $tmp_name)
	Save image from request. More...

Protected Member Functions
	persistImageState (string $filename)
	createDirectory ()
	getFileName ()
	getRelativePath ()

Protected Attributes
ilObjectService	$service
int	$obj_id
Filesystem	$web
FileUpload	$upload
string	$ext

Detailed Description

Definition at line 29 of file class.ilObjectTileImage.php.

Constructor & Destructor Documentation

__construct()

ilObjectTileImage::__construct	(	ilObjectService	$service,
		int	$obj_id
	)

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

References $obj_id, $service, ilContainer\_lookupContainerSetting(), ilObjectService\filesystem(), ilObjectService\upload(), and ILIAS\Repository\upload().

    {
        $this->service = $service;
        $this->obj_id = $obj_id;
        $this->web = $service->filesystem()->web();
        $this->upload = $service->upload();
        $this->ext = ilContainer::_lookupContainerSetting($obj_id, 'tile_image');
    }

Here is the call graph for this function:

Member Function Documentation

copy()

ilObjectTileImage::copy

(

int

$target_obj_id

)

Implements ilObjectTileImageInterface.

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

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

                                            : void
    {
        if (!$this->exists()) {
            ilContainer::_deleteContainerSettings($target_obj_id, 'tile_image');
            return;
        }

        try {
            $this->web->copy(
                $this->getRelativePath(),
                preg_replace(
                    '/(' . "tile_image_" . ')(\d*)\/(.*)$/',
                    '${1}' . $target_obj_id . '/${3}',
                    $this->getRelativePath()
                )
            );

            ilContainer::_writeContainerSetting($target_obj_id, 'tile_image', $this->getExtension());
        } catch (Exception $e) {
            ilContainer::_deleteContainerSettings($target_obj_id, 'tile_image');
        }
    }

Here is the call graph for this function:

createDirectory()

ilObjectTileImage::createDirectory ( )

protected

Exceptions

IOException

Definition at line 152 of file class.ilObjectTileImage.php.

References getRelativeDirectory().

Referenced by delete().

                                        : void
    {
        $this->web->createDir($this->getRelativeDirectory());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFromImportDir()

ilObjectTileImage::createFromImportDir	(	string	$source_dir,
		string	$ext
	)

Implements ilObjectTileImageInterface.

Definition at line 206 of file class.ilObjectTileImage.php.

References Vendor\Package\$e, ilContainer\_writeContainerSetting(), getRelativeDirectory(), and ilFileUtils\getWebspaceDir().

                                                                        : void
    {
        $target_dir = implode(
            DIRECTORY_SEPARATOR,
            [
                ilFileUtils::getWebspaceDir(),
                $this->getRelativeDirectory()
            ]
        );
        $sourceFS = LegacyPathHelper::deriveFilesystemFrom($source_dir);
        $targetFS = LegacyPathHelper::deriveFilesystemFrom($target_dir);

        $sourceDir = LegacyPathHelper::createRelativePath($source_dir);
        $targetDir = LegacyPathHelper::createRelativePath($target_dir);


        $sourceList = $sourceFS->listContents($sourceDir, true);

        foreach ($sourceList as $item) {
            if ($item->isDir()) {
                continue;
            }
            try {
                $itemPath = $targetDir . '/' . substr($item->getPath(), strlen($sourceDir));
                $stream = $sourceFS->readStream($item->getPath());
                $targetFS->writeStream($itemPath, $stream);
            } catch (FileAlreadyExistsException $e) {
                // Do nothing with that type of exception
            }
        }

        ilContainer::_writeContainerSetting($this->obj_id, 'tile_image', $ext);
    }

Here is the call graph for this function:

delete()

ilObjectTileImage::delete

(

)

Implements ilObjectTileImageInterface.

Definition at line 74 of file class.ilObjectTileImage.php.

References Vendor\Package\$e, $results, ilContainer\_deleteContainerSettings(), CLIENT_WEB_DIR, createDirectory(), ilShellUtil\execConvert(), getFileName(), getRelativeDirectory(), getRelativePath(), persistImageState(), ilObjectTileImageInterface\saveFromHttpRequest(), and ILIAS\Repository\upload().

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

        ilContainer::_deleteContainerSettings($this->obj_id, 'tile_image');
    }

Here is the call graph for this function:

exists()

ilObjectTileImage::exists

(

)

Implements ilObjectTileImageInterface.

Definition at line 185 of file class.ilObjectTileImage.php.

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

Referenced by copy().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExtension()

ilObjectTileImage::getExtension

(

)

Implements ilObjectTileImageInterface.

Definition at line 46 of file class.ilObjectTileImage.php.

References $ext.

Referenced by copy(), and getFileName().

                                  : string
    {
        return $this->ext;
    }

Here is the caller graph for this function:

getFileName()

ilObjectTileImage::getFileName ( )

protected

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

References getExtension().

Referenced by delete(), and getRelativePath().

                                    : string
    {
        return 'tile_image.' . $this->getExtension();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullPath()

ilObjectTileImage::getFullPath

(

)

Implements ilObjectTileImageInterface.

Definition at line 194 of file class.ilObjectTileImage.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:

getRelativeDirectory()

ilObjectTileImage::getRelativeDirectory

(

)

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

Referenced by createDirectory(), createFromImportDir(), delete(), and getRelativePath().

                                          : string
    {
        return implode(
            DIRECTORY_SEPARATOR,
            [
                'obj_data',
                'tile_image',
                'tile_image_' . $this->obj_id
            ]
        );
    }

Here is the caller graph for this function:

getRelativePath()

ilObjectTileImage::getRelativePath ( )

protected

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

References getFileName(), and getRelativeDirectory().

Referenced by copy(), delete(), exists(), and getFullPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

persistImageState()

ilObjectTileImage::persistImageState ( string  $filename )

protected

Definition at line 138 of file class.ilObjectTileImage.php.

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

Referenced by delete().

                                                          : void
    {
        $ext = pathinfo($filename, PATHINFO_EXTENSION);

        if ($this->web->has($filename)) {
            ilContainer::_writeContainerSetting($this->obj_id, 'tile_image', $ext);
        } else {
            ilContainer::_deleteContainerSettings($this->obj_id, 'tile_image');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ext

string ilObjectTileImage::$ext

protected

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

Referenced by getExtension().

$obj_id

int ilObjectTileImage::$obj_id

protected

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

Referenced by __construct().

$service

ilObjectService ilObjectTileImage::$service

protected

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

Referenced by __construct().

$upload

FileUpload ilObjectTileImage::$upload

protected

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

$web

Filesystem ilObjectTileImage::$web

protected

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

---

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

• Services/Object/CommonSettings/TileImage/classes/class.ilObjectTileImage.php