Inheritance diagram for ilFileSystemStorage:

Collaboration diagram for ilFileSystemStorage:

Public Member Functions
	__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)

Static Public Member Functions
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...

	_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
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	FACTOR = 100

const	MAX_EXPONENT = 3

Protected Member Functions
	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...

Protected Attributes
	$path

Private Member Functions
	init ()
	Read path info. More...

Private Attributes
	$container_id

	$storage_type

	$path_conversion = false

	$short_path

Detailed Description

Definition at line 34 of file class.ilFileSystemStorage.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

ilFileSystemStorage::__construct	(	$a_storage_type,
		$a_path_conversion,
		$a_container_id
	)

Constructor.

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 58 of file class.ilFileSystemStorage.php.

References init().

         {
                 $this->storage_type = $a_storage_type;
                 $this->path_conversion = $a_path_conversion;
                 $this->container_id = $a_container_id;
 
                 // Get path info
                 $this->init();
         }

Here is the call graph for this function:

◆ __construct() [2/2]

ilFileSystemStorage::__construct	(	$a_storage_type,
		$a_path_conversion,
		$a_container_id
	)

Constructor.

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 50 of file class.ilFileSystemStorage.php.

References init().

         {
                 $this->storage_type = $a_storage_type;
                 $this->path_conversion = $a_path_conversion;
                 $this->container_id = $a_container_id;
                 
                 // Get path info
                 $this->init();
         }

Here is the call graph for this function:

Member Function Documentation

◆ _copyDirectory()

ilFileSystemStorage::_copyDirectory	(	$a_source,
		$a_target
	)

static

Copy directory and all contents.

public

Parameters

string	absolute source path
string	absolute target path

Definition at line 286 of file class.ilFileSystemStorage.php.

References ilUtil\rCopy().

Referenced by ilFSStorageCourse\_clone(), and ilObjPortfolioBase\cloneBasics().

         {
                 return ilUtil::rCopy($a_source,$a_target);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _createPathFromId() [1/2]

static ilFileSystemStorage::_createPathFromId	(	$a_container_id,
		$a_name
	)

static

Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5.

public

Parameters

int	container id
string	name

Definition at line 69 of file class.ilFileSystemStorage.php.

References $path, getPathPostfix(), and getPathPrefix().

         {
                 $path = array();
                 $found = false;
                 $num = $a_container_id;
                 for($i = self::MAX_EXPONENT; $i > 0;$i--)
                 {
                         $factor = pow(self::FACTOR,$i);
                         if(($tmp = (int) ($num / $factor)) or $found)
                         {
                                 $path[] = $tmp;
                                 $num = $num % $factor;
                                 $found = true;
                         }       
                 }
 
                 if(count($path))
                 {
                         $path_string = (implode('/',$path));
                 }
                 return $path_string;
         }

Here is the call graph for this function:

◆ _createPathFromId() [2/2]

static ilFileSystemStorage::_createPathFromId	(	$a_container_id,
		$a_name
	)

static

Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5.

public

Parameters

int	container id
string	name

Definition at line 82 of file class.ilFileSystemStorage.php.

References $path, getPathPostfix(), and getPathPrefix().

Referenced by ilExport\_getExportDirectory().

         {
                 $path = array();
                 $found = false;
                 $num = $a_container_id;
                 for($i = self::MAX_EXPONENT; $i > 0;$i--)
                 {
                         $factor = pow(self::FACTOR,$i);
                         if(($tmp = (int) ($num / $factor)) or $found)
                         {
                                 $path[] = $tmp;
                                 $num = $num % $factor;
                                 $found = true;
                         }       
                 }
 
                 if(count($path))
                 {
                         $path_string = (implode('/',$path).'/');
                 }
                 return $path_string.$a_name.'_'.$a_container_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendToPath()

ilFileSystemStorage::appendToPath ( $a_appendix )

Definition at line 291 of file class.ilFileSystemStorage.php.

Referenced by ilFSStorageMail\__construct().

         {
                 $this->path .= $a_appendix;
         }

Here is the caller graph for this function:

◆ copyFile()

ilFileSystemStorage::copyFile	(	$a_from,
		$a_to
	)

Copy files.

public

Parameters

string	absolute source
string	absolute target

Definition at line 267 of file class.ilFileSystemStorage.php.

         {
                 if(@file_exists($a_from))
                 {
                         @copy($a_from,$a_to);
                         return true;
                 }
                 return false;
         }

◆ create() [1/2]

ilFileSystemStorage::create ( )

Create directory.

public

Definition at line 121 of file class.ilFileSystemStorage.php.

References ilUpdateUtils\makeDirParents(), and ilUpdateUtils\removeTrailingPathSeparators().

         {
                 if(!file_exists($this->short_path))
                 {
                         ilUpdateUtils::makeDirParents(ilUpdateUtils::removeTrailingPathSeparators($this->short_path));
                 }
                 return true;
         }

Here is the call graph for this function:

◆ create() [2/2]

ilFileSystemStorage::create ( )

Create directory.

public

Definition at line 134 of file class.ilFileSystemStorage.php.

References ilUtil\makeDirParents().

Referenced by ilRestFileStorage\init().

         {
                 if(!file_exists($this->path))
                 {
                         ilUtil::makeDirParents($this->path);
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileSystemStorage::delete ( )

Delete complete directory.

public

Parameters

Definition at line 253 of file class.ilFileSystemStorage.php.

References ilUtil\delDir(), and getAbsolutePath().

         {
                 return ilUtil::delDir($this->getAbsolutePath());
         }

Here is the call graph for this function:

◆ deleteDirectory()

ilFileSystemStorage::deleteDirectory ( $a_abs_name )

Delete directory.

public

Parameters

string absolute name

Definition at line 235 of file class.ilFileSystemStorage.php.

References ilUtil\delDir().

Referenced by ilFSStorageCourse\deleteArchive().

         {
                 if(@file_exists($a_abs_name))
                 {
                         ilUtil::delDir($a_abs_name);
                         return true;
                 }
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteFile()

ilFileSystemStorage::deleteFile ( $a_abs_name )

Delete file.

public

Parameters

string absolute name

Definition at line 218 of file class.ilFileSystemStorage.php.

Referenced by ilFSStorageCourse\deleteArchive(), ilFSStorageGroup\deleteMemberExportFile(), and ilFSStorageCourse\deleteMemberExportFile().

         {
                 if(@file_exists($a_abs_name))
                 {
                         @unlink($a_abs_name);
                         return true;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ getAbsolutePath() [1/2]

ilFileSystemStorage::getAbsolutePath ( )

Get absolute path of storage directory.

public

Definition at line 137 of file class.ilFileSystemStorage.php.

References $path.

         {
                 return $this->path;
         }

◆ getAbsolutePath() [2/2]

ilFileSystemStorage::getAbsolutePath ( )

Get absolute path of storage directory.

public

Definition at line 150 of file class.ilFileSystemStorage.php.

References $path.

Referenced by ilFSStorageSession\createDirectory(), ilFSStorageEvent\createDirectory(), delete(), ilFSStorageCourse\getArchiveDirectory(), ilFSStorageExercise\getAssignmentFilePath(), ilFSStorageCourse\getInfoDirectory(), ilFSStorageGroup\getMemberExportDirectory(), ilFSStorageCourse\getMemberExportDirectory(), and ilFSStorageMail\getRelativePathExMailDirectory().

         {
                 return $this->path;
         }

Here is the caller graph for this function:

◆ getContainerId()

ilFileSystemStorage::getContainerId ( )

Definition at line 68 of file class.ilFileSystemStorage.php.

References $container_id.

Referenced by ilFSStorageGroup\getMemberExportFiles(), and ilFSStorageCourse\getMemberExportFiles().

         {
                 return $this->container_id;
         }

Here is the caller graph for this function:

◆ getPath()

ilFileSystemStorage::getPath ( )

Get path.

Definition at line 304 of file class.ilFileSystemStorage.php.

References $path.

Referenced by ilTestProcessLockFileStorage\create(), ilRestFileStorage\createFile(), ilRestFileStorage\deleteDeprecated(), ilRestFileStorage\getFile(), ilRestFileStorage\getStoredFilePath(), and ilRestFileStorage\storeFileForRest().

         {
                 return $this->path;
         }

Here is the caller graph for this function:

◆ getPathPostfix() [1/2]

ilFileSystemStorage::getPathPostfix ( )

abstractprotected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

protected

Returns: string directory name

◆ getPathPostfix() [2/2]

ilFileSystemStorage::getPathPostfix ( )

abstractprotected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

protected

Returns: string directory name

Referenced by _createPathFromId(), and init().

Here is the caller graph for this function:

◆ getPathPrefix() [1/2]

ilFileSystemStorage::getPathPrefix ( )

abstractprotected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

protected

Returns: string path prefix e.g files

◆ getPathPrefix() [2/2]

ilFileSystemStorage::getPathPrefix ( )

abstractprotected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

protected

Returns: string path prefix e.g files

Referenced by _createPathFromId(), and init().

Here is the caller graph for this function:

◆ getShortPath()

ilFileSystemStorage::getShortPath ( )

Definition at line 142 of file class.ilFileSystemStorage.php.

References $short_path.

         {
                 return $this->short_path;
         }

◆ getStorageType()

ilFileSystemStorage::getStorageType ( )

Definition at line 296 of file class.ilFileSystemStorage.php.

References $storage_type.

Referenced by ilFSStorageMail\getRelativePathExMailDirectory().

         {
                 return $this->storage_type;
         }

Here is the caller graph for this function:

◆ init() [1/2]

ilFileSystemStorage::init ( )

private

Read path info.

private

Definition at line 157 of file class.ilFileSystemStorage.php.

References $container_id, $path, ilUpdateUtils\getDataDir(), getPathPostfix(), getPathPrefix(), ilUpdateUtils\getWebspaceDir(), and ilUpdateUtils\removeTrailingPathSeparators().

         {
                 switch($this->storage_type)
                 {
                         case self::STORAGE_DATA:
                                 $this->path = ilUpdateUtils::getDataDir();
                                 break;
                                 
                         case self::STORAGE_WEB:
                                 $this->path = ilUpdateUtils::getWebspaceDir();
                                 break;
                 }
                 $this->path = ilUpdateUtils::removeTrailingPathSeparators($this->path);
                 $this->path .= '/';
                 
                 // Append path prefix
                 $this->path .= ($this->getPathPrefix().'/');
                 
                 if($this->path_conversion)
                 {
                         if($path_id = self::_createPathFromId($this->container_id,$this->getPathPostfix()))
                         {
                                 $this->path = $this->path.'/'.$path_id;
                                 $this->path .= '/';
                                 $this->short_path = $this->path;
                         }
                         else
                         {
                                 $this->short_path = $this->path;
                         }
                         $this->path .= ($this->getPathPostfix().'_'.$this->container_id);
                 }
                 else
                 {
                         $this->short_path = $this->path;
                         $this->path .= ($this->getPathPostfix().'_'.$this->container_id);
                 }
                 return true;
         }

Here is the call graph for this function:

◆ init() [2/2]

ilFileSystemStorage::init ( )

protected

Read path info.

private

Definition at line 160 of file class.ilFileSystemStorage.php.

References $container_id, ilUtil\getDataDir(), getPathPostfix(), getPathPrefix(), ilUtil\getWebspaceDir(), and ilUtil\removeTrailingPathSeparators().

Referenced by __construct().

         {
                 switch($this->storage_type)
                 {
                         case self::STORAGE_DATA:
                                 $this->path = ilUtil::getDataDir();
                                 break;
                                 
                         case self::STORAGE_WEB:
                                 $this->path = ilUtil::getWebspaceDir();
                                 break;
                 }
                 $this->path = ilUtil::removeTrailingPathSeparators($this->path);
                 $this->path .= '/';
                 
                 // Append path prefix
                 $this->path .= ($this->getPathPrefix().'/');
                 
                 if($this->path_conversion)
                 {
                         $this->path .= self::_createPathFromId($this->container_id,$this->getPathPostfix());
                 }
                 else
                 {
                         $this->path .= ($this->getPathPostfix().'_'.$this->container_id);
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rename()

ilFileSystemStorage::rename	(	$from,
		$to
	)

Definition at line 147 of file class.ilFileSystemStorage.php.

Referenced by ilFSStorageExercise\deliverFile().

         {
                 return @rename($from,$to);
         }

Here is the caller graph for this function:

◆ writeToFile()

ilFileSystemStorage::writeToFile	(	$a_data,
		$a_absolute_path
	)

Write data to file.

public

Parameters

Definition at line 196 of file class.ilFileSystemStorage.php.

Referenced by ilFSStorageGroup\addMemberExportFile(), ilFSStorageCourse\addMemberExportFile(), ilRestFileStorage\createFile(), ilRestFileStorage\storeFileForRest(), and ilFSStorageCourse\writeArchiveFile().

         {
                 if(!$fp = @fopen($a_absolute_path,'w+'))
                 {
                         return false;
                 }
                 if(@fwrite($fp,$a_data) === false)
                 {
                         @fclose($fp);
                         return false;
                 }
                 @fclose($fp);
                 return true;            
         }