ilFSWebStorageExercise Class Reference

Inheritance diagram for ilFSWebStorageExercise:

Collaboration diagram for ilFSWebStorageExercise:

Public Member Functions
	__construct ($a_container_id=0, $a_ass_id=0)
	Constructor. More...
	init ()
	Append ass_<ass_id> to path (assignment id) More...
	create ()
	Create directory. More...
	deleteUserSubmissionDirectory (int $user_id)
	getFiles ()
	Get assignment files. More...
	getAssignmentFilePath ($a_file)
	Get path for assignment file. More...
	uploadAssignmentFiles ($a_files)
	Upload assignment files (e.g. More...
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 ()
	Implementation of abstract method. More...
	getPathPrefix ()
	Implementation of abstract method. 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...

Protected Attributes
	$log
	$ass_id
	$submissions_path
Protected Attributes inherited from ilFileSystemStorage
	$path

Additional Inherited Members
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 ilFileSystemStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
const	FACTOR = 100
const	MAX_EXPONENT = 3
const	SECURED_DIRECTORY = "sec"

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	assingment id

Definition at line 21 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

create()

ilFSWebStorageExercise::create

(

)

Create directory.

public

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

Referenced by ilExAssignment\cloneAssignmentsOfExercise(), ilExAssignmentEditorGUI\executeCommand(), and ilExerciseDataSet\importRecord().

    {
        $this->log->debug("parent create");

        parent::create();

        return true;
    }

Here is the caller graph for this function:

deleteUserSubmissionDirectory()

ilFSWebStorageExercise::deleteUserSubmissionDirectory

(

int

$user_id

)

Definition at line 86 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

(

$a_file

)

Get path for assignment file.

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

References ilFileSystemStorage\getAbsolutePath().

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

Here is the call graph for this function:

getFiles()

ilFSWebStorageExercise::getFiles

(

)

Get assignment files.

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

References ilUtil\sortArray().

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

        $files = array();
        if (!is_dir($this->path)) {
            return $files;
        }

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

Here is the call graph for this function:

getPathPostfix()

ilFSWebStorageExercise::getPathPostfix ( )

protected

Implementation of abstract method.

protected

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

    {
        return 'exc';
    }

getPathPrefix()

ilFSWebStorageExercise::getPathPrefix ( )

protected

Implementation of abstract method.

protected

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

    {
        return 'ilExercise';
    }

init()

ilFSWebStorageExercise::init

(

)

Append ass_<ass_id> to path (assignment id)

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

References $ass_id.

    {
        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

(

$a_files

)

Upload assignment files (e.g.

from assignment creation form)

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

References $name, $size, $type, and ilUtil\moveUploadedFile().

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

Here is the call graph for this function:

Field Documentation

$ass_id

ilFSWebStorageExercise::$ass_id

protected

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

Referenced by init().

$log

ilFSWebStorageExercise::$log

protected

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

$submissions_path

ilFSWebStorageExercise::$submissions_path

protected

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

---

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

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