ilFSStorageFile Class Reference

Class ilFSStorageFile. More...

Inheritance diagram for ilFSStorageFile:

Collaboration diagram for ilFSStorageFile:

Public Member Functions
	__construct ($a_container_id=0)
	ilFSStorageFile constructor. More...
	__construct ($a_container_id=0)
	Constructor. More...
Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	fileExists ($a_absolute_path)
	getContainerId ()
	create ()
	Create directory. More...
	getAbsolutePath ()
	Calculates the full path on the filesystem. More...
	writeToFile ($a_data, $a_absolute_path)
	deleteFile ($a_absolute_path)
	deleteDirectory ($a_absolute_path)
	delete ()
	copyFile ($a_from, $a_to)
	appendToPath ($a_appendix)
	getStorageType ()
	getPath ()
Public Member Functions inherited from ilFileSystemStorage
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	getContainerId ()
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	writeToFile ($a_data, $a_absolute_path)
	Write data to file. More...
	deleteFile ($a_abs_name)
	Delete file. More...
	deleteDirectory ($a_abs_name)
	Delete directory. More...
	delete ()
	Delete complete directory. More...
	copyFile ($a_from, $a_to)
	Copy files. More...
	appendToPath ($a_appendix)
	getStorageType ()
	getPath ()
	Get path. More...
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	getShortPath ()
	rename ($from, $to)

Protected Member Functions
	getPathPostfix ()
	getPathPrefix ()
	getPathPostfix ()
	Implementation of abstract method. More...
	getPathPrefix ()
	Implementation of abstract method. More...
Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath ($relative_path)
	getFileSystemService ()
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...
	init ()
	Read path info. More...
Protected Member Functions inherited from ilFileSystemStorage
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	init ()
	Read path info. More...
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
static	_copyDirectory ($a_sdir, $a_tdir)
Static Public Member Functions inherited from ilFileSystemStorage
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
static	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
const	FACTOR = 100
const	MAX_EXPONENT = 3
const	SECURED_DIRECTORY = "sec"
Data Fields inherited from ilFileSystemStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
const	FACTOR = 100
const	MAX_EXPONENT = 3
const	SECURED_DIRECTORY = "sec"
Protected Attributes inherited from ilFileSystemAbstractionStorage
	$path
Protected Attributes inherited from ilFileSystemStorage
	$path

Detailed Description

Class ilFSStorageFile.

Author

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

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 29 of file class.ilFSStorageFile.php.

Constructor & Destructor Documentation

__construct() [1/2]

ilFSStorageFile::__construct

(

$a_container_id = 0

)

ilFSStorageFile constructor.

Parameters

int

$a_container_id

Definition at line 37 of file class.ilFSStorageFile.php.

    {
        parent::__construct(self::STORAGE_DATA, true, $a_container_id);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

__construct() [2/2]

ilFSStorageFile::__construct

(

$a_container_id = 0

)

Constructor.

@access public

Parameters

int	storage type
bool	En/Disable automatic path conversion. If enabled files with id 123 will be stored in directory files/1/file_123
int	object id of container (e.g file_id or mob_id)

Definition at line 44 of file class.ilFSStorageFile.php.

    {
        parent::__construct(self::STORAGE_DATA, true, $a_container_id);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getPathPostfix() [1/2]

ilFSStorageFile::getPathPostfix ( )

protected

Returns

string

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 46 of file class.ilFSStorageFile.php.

    {
        return 'file';
    }

getPathPostfix() [2/2]

ilFSStorageFile::getPathPostfix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 55 of file class.ilFSStorageFile.php.

    {
        return 'file';
    }

getPathPrefix() [1/2]

ilFSStorageFile::getPathPrefix ( )

protected

Returns

string

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 55 of file class.ilFSStorageFile.php.

    {
        return 'ilFile';
    }

getPathPrefix() [2/2]

ilFSStorageFile::getPathPrefix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemAbstractionStorage.

Definition at line 66 of file class.ilFSStorageFile.php.

    {
        return 'ilFiles';
    }

---

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

• Modules/File/classes/class.ilFSStorageFile.php
• Services/Migration/DBUpdate_904/classes/class.ilFSStorageFile.php