ilFSWebStorageExercise Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilFSWebStorageExercise:

Collaboration diagram for ilFSWebStorageExercise:

Public Member Functions
	__construct (int $a_container_id=0, int $a_ass_id=0)
	deleteUserSubmissionDirectory (int $user_id)
	getFiles ()
	Get assignment files. More...
	getAssignmentFilePath (string $a_file)
	uploadAssignmentFiles (array $a_files)
Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (int $a_storage_type, bool $a_path_conversion, int $a_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 ()

Protected Member Functions
	init ()
	getPathPostfix ()
	getPathPrefix ()
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
ilLogger	$log
int	$ass_id
string	$submissions_path
Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null
ILIAS Filesystem Filesystems	$file_system_service

Additional Inherited Members
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 inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilFSWebStorageExercise.php.

Constructor & Destructor Documentation

__construct()

ilFSWebStorageExercise::__construct	(	int	$a_container_id = 0,
		int	$a_ass_id = 0
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

      {
        $this->ass_id = $a_ass_id;
        $this->log = ilLoggerFactory::getLogger("exc");
        $this->log->debug("ilFSWebStorageExercise construct with a_container_id = " . $a_container_id . " and ass_id =" . $a_ass_id);
        parent::__construct(self::STORAGE_WEB, true, $a_container_id);
    }

Here is the call graph for this function:

Member Function Documentation

deleteUserSubmissionDirectory()

ilFSWebStorageExercise::deleteUserSubmissionDirectory

(

int

$user_id

)

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

Referenced by ilExerciseManagementGUI\removeUserSubmissionFilesFromWebDir().

     : void {
        $internal_dir = $this->submissions_path . "/" . $user_id;

        //remove first dot from (./data/client/ilExercise/3/exc_318/subm_21/6)
        $internal_dir_without_dot = substr($internal_dir, 1);

        $absolute_path = ILIAS_ABSOLUTE_PATH . $internal_dir_without_dot;

        if (is_dir($absolute_path)) {
            parent::deleteDirectory($absolute_path);
            $this->log->debug("Removed = " . $absolute_path);
        }
    }

Here is the caller graph for this function:

getAssignmentFilePath()

ilFSWebStorageExercise::getAssignmentFilePath

(

string

$a_file

)

Definition at line 114 of file class.ilFSWebStorageExercise.php.

References ilFileSystemAbstractionStorage\getAbsolutePath().

     : string {
        return $this->getAbsolutePath() . "/" . $a_file;
    }

Here is the call graph for this function:

getFiles()

ilFSWebStorageExercise::getFiles

(

)

Get assignment files.

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 86 of file class.ilFSWebStorageExercise.php.

References ilFileSystemAbstractionStorage\$path, CLIENT_ID, ilFileSystemAbstractionStorage\getPath(), ILIAS_WEB_DIR, and ilArrayUtil\sortArray().

                              : array
    {
        $ass = new ilExAssignment($this->ass_id);
        $files_order = $ass->getInstructionFilesOrder();
        $files = array();

        $path = "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID . "/" . $this->getPath();

        if (!is_dir($path)) {
            return $files;
        }

        $dp = opendir($path);
        while ($file = readdir($dp)) {
            if (!is_dir($path . '/' . $file)) {
                $files[] = array(
                    'name' => $file,
                    'size' => filesize($path . '/' . $file),
                    'ctime' => filectime($path . '/' . $file),
                    'fullpath' => $path . '/' . $file,
                    'order' => $files_order[$file]["order_nr"] ?? 0
                    );
            }
        }
        closedir($dp);
        return ilArrayUtil::sortArray($files, "order", "asc", true);
    }

Here is the call graph for this function:

getPathPostfix()

ilFSWebStorageExercise::getPathPostfix ( )

protected

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

                                       : string
    {
        return 'exc';
    }

getPathPrefix()

ilFSWebStorageExercise::getPathPrefix ( )

protected

Definition at line 60 of file class.ilFSWebStorageExercise.php.

                                      : string
    {
        return 'ilExercise';
    }

init()

ilFSWebStorageExercise::init ( )

protected

Definition at line 39 of file class.ilFSWebStorageExercise.php.

References $ass_id.

                             : bool
    {
        if (parent::init()) {
            if ($this->ass_id > 0) {
                $this->submissions_path = $this->path . "/subm_" . $this->ass_id;

                $this->log->debug("parent init() with ass_id =" . $this->ass_id);
                $this->path .= "/ass_" . $this->ass_id;
            }
        } else {
            $this->log->debug("no parent init() without ass_id");
            return false;
        }
        return true;
    }

uploadAssignmentFiles()

ilFSWebStorageExercise::uploadAssignmentFiles

(

array

$a_files

)

Exceptions

ilException

Definition at line 123 of file class.ilFSWebStorageExercise.php.

References $name, ilFileSystemAbstractionStorage\getAbsolutePath(), and ilFileUtils\moveUploadedFile().

     : void {
        if (is_array($a_files["name"])) {
            foreach ($a_files["name"] as $k => $name) {
                if ($name != "") {
                    $tmp_name = $a_files["tmp_name"][$k];
                    ilFileUtils::moveUploadedFile(
                        $tmp_name,
                        basename($name),
                        $this->getAbsolutePath() . DIRECTORY_SEPARATOR . basename($name),
                        false
                    );
                }
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$ass_id

int ilFSWebStorageExercise::$ass_id

protected

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

Referenced by init().

$log

ilLogger ilFSWebStorageExercise::$log

protected

Definition at line 25 of file class.ilFSWebStorageExercise.php.

$submissions_path

string ilFSWebStorageExercise::$submissions_path

protected

Definition at line 27 of file class.ilFSWebStorageExercise.php.

---

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

• Modules/Exercise/classes/class.ilFSWebStorageExercise.php