ilObjFileImplementationInterface Interface Reference

Interface ilObjFileImplementationInterface. More...

Inheritance diagram for ilObjFileImplementationInterface:

Collaboration diagram for ilObjFileImplementationInterface:

Public Member Functions
	getDirectory ($a_version=0)
	createDirectory ()
	replaceFile ($a_upload_file, $a_filename)
	clearDataDirectory ()
	deleteVersions ($a_hist_entry_ids=null)
	Deletes the specified history entries or all entries if no ids are specified. More...
	setFileType ($a_type)
	getFileType ()
	getStorageID ()
	setFileSize ($a_size)
	handleChangedObjectTitle (string $new_title)
	getFileSize ()
	getFile ($a_hist_entry_id=null)
	setVersion ($a_version)
	getVersion ()
	setMaxVersion ($a_max_version)
	getMaxVersion ()
	sendFile ($a_hist_entry_id=null)
	getFileExtension ()
	Returns the extension of the file name converted to lower-case. More...
	storeUnzipedFile ($a_upload_file, $a_filename)
	getVersions ($version_ids=null)
	Gets the file versions for this object. More...
	export (string $target_dir)

Detailed Description

Interface ilObjFileImplementationInterface.

Author

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

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

Member Function Documentation

clearDataDirectory()

ilObjFileImplementationInterface::clearDataDirectory

(

)

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationLegacy, and ilObjFileImplementationAbstract.

createDirectory()

ilObjFileImplementationInterface::createDirectory

(

)

Returns

void

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationLegacy, and ilObjFileImplementationAbstract.

deleteVersions()

ilObjFileImplementationInterface::deleteVersions

(

$a_hist_entry_ids = null

)

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

Parameters

array

$a_hist_entry_ids

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

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationLegacy.

export()

ilObjFileImplementationInterface::export

(

string

$target_dir

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationLegacy.

getDirectory()

ilObjFileImplementationInterface::getDirectory

(

$a_version = 0

)

Parameters

int

$a_version

Returns

string

Deprecated:

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationLegacy.

getFile()

ilObjFileImplementationInterface::getFile

(

$a_hist_entry_id = null

)

Parameters

null

$a_hist_entry_id

Returns

string

Deprecated:

Implemented in ilObjFileImplementationLegacy, ilObjFile, 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, ilObjFileImplementationLegacy, and ilObjFileImplementationStorage.

getFileSize()

ilObjFileImplementationInterface::getFileSize

(

)

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

getFileType()

ilObjFileImplementationInterface::getFileType

(

)

Returns

string

Implemented in ilObjFileImplementationLegacy, ilObjFile, and ilObjFileImplementationStorage.

getMaxVersion()

ilObjFileImplementationInterface::getMaxVersion

(

)

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

getStorageID()

ilObjFileImplementationInterface::getStorageID

(

)

Implemented in ilObjFileImplementationLegacy, ilObjFile, and ilObjFileImplementationStorage.

getVersion()

ilObjFileImplementationInterface::getVersion

(

)

Implemented in ilObjFileImplementationLegacy, ilObjFile, and ilObjFileImplementationAbstract.

getVersions()

ilObjFileImplementationInterface::getVersions

(

$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 ilObjFile, ilObjFileImplementationLegacy, and ilObjFileImplementationStorage.

handleChangedObjectTitle()

ilObjFileImplementationInterface::handleChangedObjectTitle

(

string

$new_title

)

Implemented in ilObjFile, ilObjFileImplementationStorage, and ilObjFileImplementationLegacy.

replaceFile()

ilObjFileImplementationInterface::replaceFile	(		$a_upload_file,
			$a_filename
	)

Parameters

$a_upload_file
$a_filename

Returns

Exceptions

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

sendFile()

ilObjFileImplementationInterface::sendFile

(

$a_hist_entry_id = null

)

Parameters

null

$a_hist_entry_id

Returns

void

Deprecated:

Implemented in ilObjFile, and ilObjFileImplementationStorage.

Referenced by ilObjFileImplementationLegacy\deleteVersions().

Here is the caller graph for this function:

setFileSize()

ilObjFileImplementationInterface::setFileSize

(

$a_size

)

Parameters

$a_size

Deprecated:

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

setFileType()

ilObjFileImplementationInterface::setFileType

(

$a_type

)

Parameters

string

$a_type

Deprecated:

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

setMaxVersion()

ilObjFileImplementationInterface::setMaxVersion

(

$a_max_version

)

Parameters

$a_max_version

Deprecated:

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

setVersion()

ilObjFileImplementationInterface::setVersion

(

$a_version

)

Parameters

$a_version

Deprecated:

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

storeUnzipedFile()

ilObjFileImplementationInterface::storeUnzipedFile	(		$a_upload_file,
			$a_filename
	)

Parameters

string	$a_upload_file
string	$a_filename

Deprecated:

storeUnzipedFile Stores Files unzipped from uploaded archive in filesystem

Implemented in ilObjFile, and ilObjFileImplementationAbstract.

---

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

• Modules/File/classes/interface.ilObjFileImplementationInterface.php