ilObjFileImplementationInterface Interface Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjFileImplementationInterface:

Collaboration diagram for ilObjFileImplementationInterface:

Public Member Functions
	getDirectory (int $a_version=0)
	deleteVersions (?array $a_hist_entry_ids=null)
	Deletes the specified history entries or all entries if no ids are specified. More...
	getFileType ()
	getStorageID ()
	getFileSize ()
	getFileName ()
	getFile (?int $a_hist_entry_id=null)
	getVersion (bool $inclduing_drafts=false)
	getMaxVersion ()
	sendFile (?int $a_hist_entry_id=null, bool $inline=true)
	handleChangedObjectTitle (string $new_title)
	getFileExtension ()
	Returns the extension of the file name converted to lower-case. More...
	getVersions (?array $version_ids=null)
	Gets the file versions for this object. More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Interface ilObjFileImplementationInterface

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 23 of file interface.ilObjFileImplementationInterface.php.

Member Function Documentation

deleteVersions()

ilObjFileImplementationInterface::deleteVersions

(

?array

$a_hist_entry_ids = null

)

Deletes the specified history entries or all entries if no ids are specified.

Parameters

array | null

$a_hist_entry_ids

The ids of the entries to delete or null to delete all entries

Deprecated:

Implemented in ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getDirectory()

ilObjFileImplementationInterface::getDirectory

(

int

$a_version = 0

)

Deprecated:

Implemented in ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getFile()

ilObjFileImplementationInterface::getFile

(

?int

$a_hist_entry_id = null

)

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationEmpty, and ilObjFileImplementationStorage.

getFileExtension()

ilObjFileImplementationInterface::getFileExtension

(

)

Returns the extension of the file name converted to lower-case.

e.g. returns 'pdf' for 'document.pdf'.

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getFileName()

ilObjFileImplementationInterface::getFileName

(

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getFileSize()

ilObjFileImplementationInterface::getFileSize

(

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getFileType()

ilObjFileImplementationInterface::getFileType

(

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getMaxVersion()

ilObjFileImplementationInterface::getMaxVersion

(

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getStorageID()

ilObjFileImplementationInterface::getStorageID

(

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getVersion()

ilObjFileImplementationInterface::getVersion

(

bool

$inclduing_drafts = false

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

getVersions()

ilObjFileImplementationInterface::getVersions

(

?array

$version_ids = null

)

Gets the file versions for this object.

Parameters

array

$version_ids

The file versions to get. If not specified all versions are returned.

Returns

array The file versions. Example: array ( 'date' => '2019-07-25 11:19:51', 'user_id' => '6', 'obj_id' => '287', 'obj_type' => 'file', 'action' => 'create', 'info_params' => 'chicken_outlined.pdf,1,1', 'user_comment' => '', 'hist_entry_id' => '3', 'title' => NULL, )

Implemented in ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

handleChangedObjectTitle()

ilObjFileImplementationInterface::handleChangedObjectTitle

(

string

$new_title

)

Implemented in ilObjFile, ilObjFileImplementationEmpty, and ilObjFileImplementationStorage.

sendFile()

ilObjFileImplementationInterface::sendFile	(	?int	$a_hist_entry_id = null,
		bool	$inline = true
	)

Parameters

bool

$inline

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationEmpty.

---

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

• components/ILIAS/File/classes/interface.ilObjFileImplementationInterface.php