Inheritance diagram for ilFSStorageExercise:

Collaboration diagram for ilFSStorageExercise:

Public Member Functions
	__construct ($a_container_id=0, $a_ass_id=0)
	Constructor. More...

	init ()
	Append ass_<ass_id> to path (assignment id) More...

	getAbsoluteSubmissionPath ()
	Get submission path. More...

	getTempPath ()
	Get submission path. More...

	getFeedbackPath ($a_user_id)
	Get feedback path. More...

	getGlobalFeedbackPath ()

	getMultiFeedbackUploadPath ($a_user_id)
	Get multi feedback upload path (each uploader handled in a separate path) More...

	getPeerReviewUploadPath ($a_peer_id, $a_giver_id, $a_crit_id)
	Get pear review upload path (each peer handled in a separate path) More...

	create ()
	Create directory. More...

	getFiles ()
	Get assignment files. More...

	uploadFile ($a_http_post_file, $user_id, $is_unziped=false)
	store delivered file in filesystem More...

	getFeedbackFiles ($a_user_id)
	Get number of feedback files. More...

	countFeedbackFiles ($a_user_id)
	Count number of feedback files for a user. More...

	getAssignmentFilePath ($a_file)
	Get path for assignment file. More...

	getFeedbackFilePath ($a_user_id, $a_file)
	Get path for feedback 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...

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"

Protected Attributes inherited from ilFileSystemStorage
	$path

Detailed Description

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilFSStorageExercise::__construct	(	$a_container_id = `0`,
		$a_ass_id = `0`
	)

Constructor.

Parameters

int	exercise id

Definition at line 37 of file class.ilFSStorageExercise.php.

References ILIAS\GlobalScreen\Provider\__construct().

     {
         $this->ass_id = $a_ass_id;
         parent::__construct(self::STORAGE_DATA, true, $a_container_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ countFeedbackFiles()

ilFSStorageExercise::countFeedbackFiles ( $a_user_id )

Count number of feedback files for a user.

Definition at line 300 of file class.ilFSStorageExercise.php.

References getFeedbackFiles().

Referenced by ilExAssignmentGUI\addSubmissionFeedback(), and ilExerciseSubmissionTableGUI\parseRow().

     {
         $fbf = $this->getFeedbackFiles($a_user_id);
         return count($fbf);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilFSStorageExercise::create ( )

Create directory.

public

Definition at line 159 of file class.ilFSStorageExercise.php.

References ilUtil\makeDirParents().

Referenced by ilExAssignmentPeerReviewTableGUI\__construct(), ilExerciseXMLParser\__construct(), ilExAssignment\cloneAssignmentsOfExercise(), ilExSubmission\downloadAllAssignmentFiles(), ilExPeerReviewGUI\executeCommand(), ilExerciseManagementGUI\executeCommand(), ilExerciseDataSet\importRecord(), and uploadFile().

     {
         parent::create();
         if (!file_exists($this->submission_path)) {
             ilUtil::makeDirParents($this->submission_path);
         }
         if (!file_exists($this->tmp_path)) {
             ilUtil::makeDirParents($this->tmp_path);
         }
         if (!file_exists($this->feedb_path)) {
             ilUtil::makeDirParents($this->feedb_path);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAbsoluteSubmissionPath()

ilFSStorageExercise::getAbsoluteSubmissionPath ( )

Get submission path.

Definition at line 89 of file class.ilFSStorageExercise.php.

Referenced by uploadFile().

     {
         return $this->submission_path;
     }

Here is the caller graph for this function:

◆ getAssignmentFilePath()

ilFSStorageExercise::getAssignmentFilePath ( $a_file )

Get path for assignment file.

Definition at line 309 of file class.ilFSStorageExercise.php.

References ilFileSystemStorage\getAbsolutePath().

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

Here is the call graph for this function:

◆ getFeedbackFilePath()

ilFSStorageExercise::getFeedbackFilePath	(	$a_user_id,
		$a_file
	)

Get path for feedback file.

Definition at line 317 of file class.ilFSStorageExercise.php.

References getFeedbackPath().

     {
         $dir = $this->getFeedbackPath($a_user_id);
         return $dir . "/" . $a_file;
     }

Here is the call graph for this function:

◆ getFeedbackFiles()

ilFSStorageExercise::getFeedbackFiles ( $a_user_id )

Get number of feedback files.

Definition at line 280 of file class.ilFSStorageExercise.php.

References getFeedbackPath().

Referenced by countFeedbackFiles(), and ilExSubmissionGUI\downloadFeedbackFileObject().

     {
         $files = array();
     
         $dir = $this->getFeedbackPath($a_user_id);
         if (@is_dir($dir)) {
             $dp = opendir($dir);
             while ($file = readdir($dp)) {
                 if (!is_dir($this->path . '/' . $file) && substr($file, 0, 1) != ".") {
                     $files[] = $file;
                 }
             }
         }
         
         return $files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFeedbackPath()

ilFSStorageExercise::getFeedbackPath ( $a_user_id )

Get feedback path.

Definition at line 105 of file class.ilFSStorageExercise.php.

References ilFileSystemStorage\$path, and ilUtil\makeDirParents().

Referenced by getFeedbackFilePath(), and getFeedbackFiles().

     {
         $path = $this->feedb_path . "/" . $a_user_id;
         if (!file_exists($path)) {
             ilUtil::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFiles()

ilFSStorageExercise::getFiles ( )

Get assignment files.

Definition at line 177 of file class.ilFSStorageExercise.php.

References ilUtil\sortArray().

     {
         $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);
             }
         }
         closedir($dp);
         $files = ilUtil::sortArray($files, "name", "asc");
         return $files;
     }

Here is the call graph for this function:

◆ getGlobalFeedbackPath()

ilFSStorageExercise::getGlobalFeedbackPath ( )

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

References ilFileSystemStorage\$path, and ilUtil\makeDirParents().

Referenced by ilExAssignment\cloneAssignmentsOfExercise().

     {
         $path = $this->feedb_path . "/0";
         if (!file_exists($path)) {
             ilUtil::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiFeedbackUploadPath()

ilFSStorageExercise::getMultiFeedbackUploadPath ( $a_user_id )

Get multi feedback upload path (each uploader handled in a separate path)

Definition at line 127 of file class.ilFSStorageExercise.php.

References ilFileSystemStorage\$path, and ilUtil\makeDirParents().

     {
         $path = $this->multi_feedback_upload_path . "/" . $a_user_id;
         if (!file_exists($path)) {
             ilUtil::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

◆ getPathPostfix()

ilFSStorageExercise::getPathPostfix ( )

protected

Implementation of abstract method.

protected

Definition at line 70 of file class.ilFSStorageExercise.php.

     {
         return 'exc';
     }

◆ getPathPrefix()

ilFSStorageExercise::getPathPrefix ( )

protected

Implementation of abstract method.

protected

Definition at line 81 of file class.ilFSStorageExercise.php.

     {
         return 'ilExercise';
     }

◆ getPeerReviewUploadPath()

ilFSStorageExercise::getPeerReviewUploadPath	(	$a_peer_id,
		$a_giver_id,
		$a_crit_id
	)

Get pear review upload path (each peer handled in a separate path)

Definition at line 140 of file class.ilFSStorageExercise.php.

References ilFileSystemStorage\$path, and ilUtil\makeDirParents().

Referenced by ilExcCriteriaFile\initStorage().

     {
         $path = $this->peer_review_upload_path . "/" . $a_peer_id . "/" . $a_giver_id . "/";
 
         if ((int) $a_crit_id) {
             $path .= (int) $a_crit_id . "/";
         }
         if (!file_exists($path)) {
             ilUtil::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempPath()

ilFSStorageExercise::getTempPath ( )

Get submission path.

Definition at line 97 of file class.ilFSStorageExercise.php.

     {
         return $this->tmp_path;
     }

◆ init()

ilFSStorageExercise::init ( )

Append ass_<ass_id> to path (assignment id)

Definition at line 46 of file class.ilFSStorageExercise.php.

     {
         if (parent::init()) {
             if ($this->ass_id > 0) {
                 $this->submission_path = $this->path . "/subm_" . $this->ass_id;
                 $this->tmp_path = $this->path . "/tmp_" . $this->ass_id;
                 $this->feedb_path = $this->path . "/feedb_" . $this->ass_id;
                 $this->multi_feedback_upload_path = $this->path . "/mfb_up_" . $this->ass_id;
                 $this->peer_review_upload_path = $this->path . "/peer_up_" . $this->ass_id;
                 $this->path .= "/ass_" . $this->ass_id;
             }
         } else {
             return false;
         }
         return true;
     }

◆ uploadAssignmentFiles()

ilFSStorageExercise::uploadAssignmentFiles ( $a_files )

Upload assignment files (e.g.

from assignment creation form)

Definition at line 327 of file class.ilFSStorageExercise.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:

◆ uploadFile()

ilFSStorageExercise::uploadFile	(	$a_http_post_file,
		$user_id,
		$is_unziped = `false`
	)

store delivered file in filesystem

Parameters

array	HTTP_POST_FILES
numeric	database id of the user who delivered the file public

Returns: mixed Returns a result array with filename and mime type of the saved file, otherwise false

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

References $filename, $result, create(), getAbsoluteSubmissionPath(), ilObjMediaObject\getMimeType(), ilFileUtils\getValidFilename(), ilUtil\makeDir(), ilUtil\moveUploadedFile(), and ilFileSystemStorage\rename().

     {
         $this->create();
         // TODO:
         // CHECK UPLOAD LIMIT
 
 
         //
         $result = false;
         if (isset($a_http_post_file) && $a_http_post_file['size']) {
             $filename = $a_http_post_file['name'];
 
             $filename = ilFileUtils::getValidFilename($filename);
 
             // replace whitespaces with underscores
             $filename = preg_replace("/\s/", "_", $filename);
             // remove all special characters
             $filename = preg_replace("/[^_a-zA-Z0-9\.]/", "", $filename);
 
             if (!is_dir($savepath = $this->getAbsoluteSubmissionPath())) {
                 ilUtil::makeDir($savepath);
             }
             $savepath .= '/' . $user_id;
             if (!is_dir($savepath)) {
                 ilUtil::makeDir($savepath);
             }
 
             // CHECK IF FILE PATH EXISTS
             if (!is_dir($savepath)) {
                 ilUtil::makeDir($savepath);
             }
             $now = getdate();
             $prefix = sprintf(
                 "%04d%02d%02d%02d%02d%02d",
                 $now["year"],
                 $now["mon"],
                 $now["mday"],
                 $now["hours"],
                 $now["minutes"],
                 $now["seconds"]
             );
 
             if (!$is_unziped) {
                 ilUtil::moveUploadedFile(
                     $a_http_post_file["tmp_name"],
                     $prefix . "_" . $filename,
                     $savepath . "/" . $prefix . "_" . $filename
                 );
             } else {
                 rename(
                     $a_http_post_file['tmp_name'],
                     $savepath . "/" . $prefix . "_" . $filename
                 );
             }
 
             if (is_file($savepath . "/" . $prefix . "_" . $filename)) {
                 $result = array(
                     "filename" => $prefix . "_" . $filename,
                     "fullname" => $savepath . "/" . $prefix . "_" . $filename,
                     "mimetype" => ilObjMediaObject::getMimeType($savepath . "/" . $prefix . "_" . $filename)
                 );
             }
         }
         return $result;
     }

Here is the call graph for this function:

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

Modules/Exercise/classes/class.ilFSStorageExercise.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ countFeedbackFiles()

◆ create()

◆ getAbsoluteSubmissionPath()

◆ getAssignmentFilePath()

◆ getFeedbackFilePath()

◆ getFeedbackFiles()

◆ getFeedbackPath()

◆ getFiles()

◆ getGlobalFeedbackPath()

◆ getMultiFeedbackUploadPath()

◆ getPathPostfix()

◆ getPathPrefix()

◆ getPeerReviewUploadPath()

◆ getTempPath()

◆ init()

◆ uploadAssignmentFiles()

◆ uploadFile()