ilObjectTileImage Class Reference

Tile image object. More...

Inheritance diagram for ilObjectTileImage:

Collaboration diagram for ilObjectTileImage:

Public Member Functions
	__construct (ilObjectService $service, int $obj_id)
	Constructor. More...
	getExtension ()
	Get extenstion. Returns string More...
	copy (int $target_obj_id)
	Copy tile image to repository object. Parameters int $target_obj_id More...
	delete ()
	Delete tile image. More...
	getRelativeDirectory ()
	exists ()
	Does tile image file exist? Returns bool More...
	getFullPath ()
	Get full path of the tile image file. Returns string More...
	createFromImportDir ($source_dir, $ext)
Public Member Functions inherited from ilObjectTileImageInterface
	saveFromHttpRequest (string $tmpname)
	Save image from request. More...

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

Protected Attributes
	$service
	$obj_id
	$web
	$upload
	$ext

Detailed Description

Tile image object.

Author

killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

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

References $obj_id, $service, ilContainer\_lookupContainerSetting(), ilObjectService\filesystem(), and ilObjectService\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

)

Copy tile image to repository object.

Parameters

int

$target_obj_id

Implements ilObjectTileImageInterface.

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

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

    {
        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

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

References getRelativeDirectory().

Referenced by delete().

    {
        $this->web->createDir($this->getRelativeDirectory());

        /*

        $rel_directory  = $this->getRelDirectory();

        if (!$this->web->has(dirname($rel_directory))) {
            $this->web->createDir(dirname($rel_directory));
        }

        if (!$this->web->has($rel_directory)) {
            $this->web->createDir($rel_directory);
        }*/
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createFromImportDir()

ilObjectTileImage::createFromImportDir	(		$source_dir,
			$ext
	)

Parameters

$source_dir
$ext

Exceptions

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

References $ext, ilContainer\_writeContainerSetting(), getRelativeDirectory(), ilUtil\getWebspaceDir(), and ilUtil\rCopy().

    {
        $target_dir = implode(DIRECTORY_SEPARATOR, [
            \ilUtil::getWebspaceDir(),
            $this->getRelativeDirectory()
        ]);
        ilUtil::rCopy($source_dir, $target_dir);
        ilContainer::_writeContainerSetting($this->obj_id, 'tile_image', $ext);
    }

Here is the call graph for this function:

delete()

ilObjectTileImage::delete

(

)

Delete tile image.

Implements ilObjectTileImageInterface.

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

References $result, $results, $type, ilContainer\_deleteContainerSettings(), createDirectory(), ilUtil\execConvert(), getFileName(), getRelativeDirectory(), getRelativePath(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, persistImageState(), and ilObjectTileImageInterface\saveFromHttpRequest().

    {
        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

(

)

Does tile image file exist?

Returns

bool

Implements ilObjectTileImageInterface.

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

(

)

Get extenstion.

Returns

string

Implements ilObjectTileImageInterface.

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

Returns

string

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

References getExtension().

Referenced by delete(), and getRelativePath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getFullPath()

ilObjectTileImage::getFullPath

(

)

Get full path of the tile image file.

Returns

string

Implements ilObjectTileImageInterface.

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

getRelativeDirectory()

ilObjectTileImage::getRelativeDirectory

(

)

Returns

string

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

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

    {
        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

Returns

string

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

References getFileName(), and getRelativeDirectory().

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

    {
        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 (   $filename )

protected

Parameters

string

$filename

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

References $ext, $filename, ilContainer\_deleteContainerSettings(), and ilContainer\_writeContainerSetting().

Referenced by delete().

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

ilObjectTileImage::$ext

protected

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

Referenced by createFromImportDir(), getExtension(), and persistImageState().

$obj_id

ilObjectTileImage::$obj_id

protected

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

Referenced by __construct().

$service

ilObjectTileImage::$service

protected

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

Referenced by __construct().

$upload

ilObjectTileImage::$upload

protected

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

$web

ilObjectTileImage::$web

protected

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

---

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

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