ilObjectCustomIcon Interface Reference

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 ()
	createFromImportDir (string $source_dir)

Detailed Description

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

Member Function Documentation

copy()

ilObjectCustomIcon::copy

(

int

$targetObjId

)

Implemented in ilObjectCustomIconImpl.

createFromImportDir()

ilObjectCustomIcon::createFromImportDir

(

string

$source_dir

)

Exceptions

DirectoryNotFoundException
FileNotFoundException
IOException

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

(

)

Implemented in ilObjectCustomIconImpl.

getFullPath()

ilObjectCustomIcon::getFullPath

(

)

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

IllegalStateException
FileNotFoundException
IOException

saveFromSourceFile()

ilObjectCustomIcon::saveFromSourceFile

(

string

$sourceFilePath

)

Exceptions

FileAlreadyExistsException
FileNotFoundException
IOException

Implemented in ilObjectCustomIconImpl.

---

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

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