Inheritance diagram for ilFileSystemStorage5069:

Collaboration diagram for ilFileSystemStorage5069:

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...

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...

static	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...

Data Fields
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

const	FACTOR = 100

const	MAX_EXPONENT = 3

const	SECURED_DIRECTORY = "sec"

Protected Member Functions
	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	init ()
	Read path info. More...

Protected Attributes
	$path

Private Attributes
	$container_id

	$storage_type

	$path_conversion = false

Detailed Description

Definition at line 30 of file class.ilFileSystemStorage5069.php.

Constructor & Destructor Documentation

◆ __construct()

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

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 55 of file class.ilFileSystemStorage5069.php.

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

References init().

Here is the call graph for this function:

Member Function Documentation

◆ _copyDirectory()

static ilFileSystemStorage5069::_copyDirectory	(	$a_source,
		$a_target
	)

static

Copy directory and all contents.

Parameters

string	$a_source	absolute source path
string	$a_target	absolute target path

Definition at line 273 of file class.ilFileSystemStorage5069.php.

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

References ilUtil\rCopy().

Here is the call graph for this function:

◆ _createPathFromId()

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

static

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

@access public

Parameters

int	container id
string	name

Definition at line 79 of file class.ilFileSystemStorage5069.php.

    {
        $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;
    }

References $i, and $path.

Referenced by init().

Here is the caller graph for this function:

◆ appendToPath()

ilFileSystemStorage5069::appendToPath ( $a_appendix )

Definition at line 278 of file class.ilFileSystemStorage5069.php.

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

◆ copyFile()

ilFileSystemStorage5069::copyFile	(	$a_from,
		$a_to
	)

Copy files.

@access public

Parameters

string	absolute source
string	absolute target

Definition at line 258 of file class.ilFileSystemStorage5069.php.

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

◆ create()

ilFileSystemStorage5069::create ( )

Create directory.

@access public

Reimplemented in ilFSStorageExercise5069.

Definition at line 128 of file class.ilFileSystemStorage5069.php.

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

References ilUtil\makeDirParents().

Here is the call graph for this function:

◆ delete()

ilFileSystemStorage5069::delete ( )

Delete complete directory.

@access public

Parameters

Definition at line 244 of file class.ilFileSystemStorage5069.php.

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

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

Here is the call graph for this function:

◆ deleteDirectory()

ilFileSystemStorage5069::deleteDirectory ( $a_abs_name )

Delete directory.

@access public

Parameters

string absolute name

Definition at line 227 of file class.ilFileSystemStorage5069.php.

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

References ilUtil\delDir().

Here is the call graph for this function:

◆ deleteFile()

ilFileSystemStorage5069::deleteFile ( $a_abs_name )

Delete file.

@access public

Parameters

string absolute name

Definition at line 211 of file class.ilFileSystemStorage5069.php.

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

◆ getAbsolutePath()

ilFileSystemStorage5069::getAbsolutePath ( )

Get absolute path of storage directory.

@access public

Definition at line 143 of file class.ilFileSystemStorage5069.php.

    {
        return $this->path;
    }

References $path.

Referenced by delete(), and ilFSStorageExercise5069\getAssignmentFilePath().

Here is the caller graph for this function:

◆ getContainerId()

ilFileSystemStorage5069::getContainerId ( )

Definition at line 65 of file class.ilFileSystemStorage5069.php.

    {
        return $this->container_id;
    }

References $container_id.

◆ getPath()

ilFileSystemStorage5069::getPath ( )

Get path.

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

    {
        return $this->path;
    }

References $path.

◆ getPathPostfix()

ilFileSystemStorage5069::getPathPostfix ( )

abstractprotected

Get directory name.

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

@abstract @access protected

Returns: string directory name

Reimplemented in ilFSStorageExercise5069.

Referenced by init().

Here is the caller graph for this function:

◆ getPathPrefix()

ilFileSystemStorage5069::getPathPrefix ( )

abstractprotected

Get path prefix.

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

@abstract @access protected

Returns: string path prefix e.g files

Reimplemented in ilFSStorageExercise5069.

Referenced by init().

Here is the caller graph for this function:

◆ getStorageType()

ilFileSystemStorage5069::getStorageType ( )

Definition at line 283 of file class.ilFileSystemStorage5069.php.

    {
        return $this->storage_type;
    }

References $storage_type.

◆ init()

ilFileSystemStorage5069::init ( )

protected

Read path info.

@access private

Reimplemented in ilFSStorageExercise5069.

Definition at line 153 of file class.ilFileSystemStorage5069.php.

    {
        switch ($this->storage_type) {
            case self::STORAGE_DATA:
                $this->path = ilUtil::getDataDir();
                break;
 
            case self::STORAGE_WEB:
                $this->path = ilUtil::getWebspaceDir();
                break;
 
            case self::STORAGE_SECURED:
                $this->path = ilUtil::getWebspaceDir();
                $this->path = ilUtil::removeTrailingPathSeparators($this->path);
                $this->path .= '/' . self::SECURED_DIRECTORY;
                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;
    }

References $container_id, _createPathFromId(), ilUtil\getDataDir(), getPathPostfix(), getPathPrefix(), ilUtil\getWebspaceDir(), ilUtil\removeTrailingPathSeparators(), SECURED_DIRECTORY, STORAGE_DATA, STORAGE_SECURED, and STORAGE_WEB.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToFile()

ilFileSystemStorage5069::writeToFile	(	$a_data,
		$a_absolute_path
	)

Write data to file.

@access public

Parameters

Definition at line 191 of file class.ilFileSystemStorage5069.php.

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