ilIndividualAssessmentFileStorage Class Reference

Inheritance diagram for ilIndividualAssessmentFileStorage:

Collaboration diagram for ilIndividualAssessmentFileStorage:

Public Member Functions
	setUserId (int $user_id)
	Set the user id for an extra folder of each participant in the IA. More...
	create ()
	creates the folder structure More...
	getAbsolutePath ()
	Get the absolute path for files. More...
	readDir ()
	Read the dir. More...
	uploadFile (UploadResult $file)
	Upload the file. More...
	deleteAllFilesBut (?string $filename)
	Delete the existing file. More...
Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (private int $storage_type, private bool $path_conversion, private int $container_id)
	Constructor. More...
	fileExists (string $a_absolute_path)
	getContainerId ()
	writeToFile (string $a_data, $a_absolute_path)
	copyFile (string $a_from, string $a_to)
	create ()
	getAbsolutePath ()
	Calculates the full path on the filesystem. More...
	delete ()
	deleteDirectory (string $a_abs_name)
	deleteFile (string $a_abs_name)
	appendToPath (string $a_appendix)
	getStorageType ()
	getPath ()
Public Member Functions inherited from IndividualAssessmentFileStorage
	deleteAllFilesBut (string $file)

Static Public Member Functions
static	getInstance (int $container_id=0)
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)
static	_copyDirectory (string $a_sdir, string $a_tdir)

Data Fields
const	PATH_POSTFIX = "iass"
const	PATH_PREFIX = "IASS"
Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3

Protected Member Functions
	getPathPostfix ()
	part of the folder structure in ILIAS webdir. More...
	getPathPrefix ()
	part of the folder structure in ILIAS webdir. More...
Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath (string $relative_path)
	getFileSystemService ()
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...
	init ()

Protected Attributes
int	$user_id = null
Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null
Filesystems	$file_system_service

Detailed Description

Deprecated:

in favor of ResourceStorage.

This class is only used for migration.

Definition at line 26 of file class.ilIndividualAssessmentFileStorage.php.

Member Function Documentation

create()

ilIndividualAssessmentFileStorage::create

(

)

creates the folder structure

Implements IndividualAssessmentFileStorage.

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

References getAbsolutePath(), and ilFileUtils\makeDirParents().

Referenced by readDir().

                            : void
    {
        if (!file_exists($this->getAbsolutePath())) {
            ilFileUtils::makeDirParents($this->getAbsolutePath());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllFilesBut()

ilIndividualAssessmentFileStorage::deleteAllFilesBut

(

?string

$filename

)

Delete the existing file.

Definition at line 131 of file class.ilIndividualAssessmentFileStorage.php.

References ilFileSystemAbstractionStorage\deleteFile(), getAbsolutePath(), and readDir().

                                                        : void
    {
        $files = $this->readDir();
        foreach ($files as $file) {
            if ($file === $filename) {
                continue;
            }
            $this->deleteFile($this->getAbsolutePath() . "/" . $file);
        }
    }

Here is the call graph for this function:

getAbsolutePath()

ilIndividualAssessmentFileStorage::getAbsolutePath

(

)

Get the absolute path for files.

Definition at line 75 of file class.ilIndividualAssessmentFileStorage.php.

References ilFileSystemAbstractionStorage\$path, and $user_id.

Referenced by create(), deleteAllFilesBut(), readDir(), and uploadFile().

                                     : string
    {
        $path = parent::getAbsolutePath();

        if ($this->user_id) {
            $path .= "/user_" . $this->user_id;
        }

        return $path;
    }

Here is the caller graph for this function:

getInstance()

static ilIndividualAssessmentFileStorage::getInstance ( int  $container_id = 0 )

static

Definition at line 33 of file class.ilIndividualAssessmentFileStorage.php.

Referenced by IndAssStorageMigration\step().

                                                             : ilIndividualAssessmentFileStorage
    {
        return new self(self::STORAGE_WEB, true, $container_id);
    }

Here is the caller graph for this function:

getPathPostfix()

ilIndividualAssessmentFileStorage::getPathPostfix ( )

protected

part of the folder structure in ILIAS webdir.

Definition at line 41 of file class.ilIndividualAssessmentFileStorage.php.

                                       : string
    {
        return self::PATH_POSTFIX;
    }

getPathPrefix()

ilIndividualAssessmentFileStorage::getPathPrefix ( )

protected

part of the folder structure in ILIAS webdir.

Definition at line 49 of file class.ilIndividualAssessmentFileStorage.php.

                                      : string
    {
        return self::PATH_PREFIX;
    }

readDir()

ilIndividualAssessmentFileStorage::readDir

(

)

Read the dir.

Returns

string[]

Definition at line 91 of file class.ilIndividualAssessmentFileStorage.php.

References create(), and getAbsolutePath().

Referenced by deleteAllFilesBut().

                             : array
    {
        if (!is_dir($this->getAbsolutePath())) {
            $this->create();
        }

        $fh = opendir($this->getAbsolutePath());
        $files = array();
        while ($file = readdir($fh)) {
            if ($file != "." && $file != ".." && !is_dir($this->getAbsolutePath() . "/" . $file)) {
                $files[] = $file;
            }
        }
        closedir($fh);

        return $files;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUserId()

ilIndividualAssessmentFileStorage::setUserId

(

int

$user_id

)

Set the user id for an extra folder of each participant in the IA.

Implements IndividualAssessmentFileStorage.

Definition at line 57 of file class.ilIndividualAssessmentFileStorage.php.

References $user_id.

                                           : void
    {
        $this->user_id = $user_id;
    }

uploadFile()

ilIndividualAssessmentFileStorage::uploadFile

(

UploadResult

$file

)

Upload the file.

Implements IndividualAssessmentFileStorage.

Definition at line 112 of file class.ilIndividualAssessmentFileStorage.php.

References ilFileSystemAbstractionStorage\$path, getAbsolutePath(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getPath(), ilFileUtils\getValidFilename(), and ilFileUtils\moveUploadedFile().

                                                  : string
    {
        $path = $this->getAbsolutePath();

        $clean_name = ilFileUtils::getValidFilename($file->getName());
        $new_file = $path . "/" . $clean_name;

        ilFileUtils::moveUploadedFile(
            $file->getPath(),
            $clean_name, // This parameter does not do a thing
            $new_file
        );

        return $clean_name;
    }

Here is the call graph for this function:

Field Documentation

$user_id

int ilIndividualAssessmentFileStorage::$user_id = null

protected

Definition at line 31 of file class.ilIndividualAssessmentFileStorage.php.

Referenced by getAbsolutePath(), and setUserId().

PATH_POSTFIX

const ilIndividualAssessmentFileStorage::PATH_POSTFIX = "iass"

Definition at line 28 of file class.ilIndividualAssessmentFileStorage.php.

PATH_PREFIX

const ilIndividualAssessmentFileStorage::PATH_PREFIX = "IASS"

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

---

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

• components/ILIAS/IndividualAssessment/classes/FileStorage/class.ilIndividualAssessmentFileStorage.php