ilObjectCustomIcon Interface Reference

Interface ilObjectCustomIcon. More...

Inheritance diagram for ilObjectCustomIcon:

Collaboration diagram for ilObjectCustomIcon:

Public Member Functions
	getSupportedFileExtensions ()
	saveFromSourceFile (string $sourceFilePath)
	saveFromHttpRequest ()
	copy (int $targetObjId)
	delete ()
	Should be called if a consuming object is removed from system. 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. More...
	exists ()
	getFullPath ()

Detailed Description

Interface ilObjectCustomIcon.

Definition at line 7 of file interface.ilObjectCustomIcon.php.

Member Function Documentation

copy()

ilObjectCustomIcon::copy

(

int

$targetObjId

)

Parameters

int

$targetObjId

Implemented in ilObjectCustomIconImpl.

delete()

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

Implemented in ilObjectCustomIconImpl.

exists()

ilObjectCustomIcon::exists

(

)

Returns

bool

Implemented in ilObjectCustomIconImpl.

getFullPath()

ilObjectCustomIcon::getFullPath

(

)

Returns

string

Implemented in ilObjectCustomIconImpl.

getSupportedFileExtensions()

ilObjectCustomIcon::getSupportedFileExtensions

(

)

Returns

string[]

Implemented in ilObjectCustomIconImpl.

remove()

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

Implemented in ilObjectCustomIconImpl.

saveFromHttpRequest()

ilObjectCustomIcon::saveFromHttpRequest

(

)

Exceptions

ILIAS\FileUpload\Exception\IllegalStateException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

saveFromSourceFile()

ilObjectCustomIcon::saveFromSourceFile

(

string

$sourceFilePath

)

Parameters

string

$sourceFilePath

Exceptions

ILIAS\Filesystem\Exception\FileAlreadyExistsException

Exceptions

ILIAS\Filesystem\Exception\FileNotFoundException

Exceptions

ILIAS\Filesystem\Exception\IOException

Implemented in ilObjectCustomIconImpl.

---

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

• Services/Object/Icon/interfaces/interface.ilObjectCustomIcon.php