ilFSStorageExercise5069 Class Reference

Inheritance diagram for ilFSStorageExercise5069:

Collaboration diagram for ilFSStorageExercise5069:

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

Protected Member Functions
	getPathPostfix ()
	Implementation of abstract method. More...
	getPathPrefix ()
	Implementation of abstract method. More...
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	init ()
	Read path info. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemStorage5069
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 inherited from ilFileSystemStorage5069
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 ilFileSystemStorage5069
	$path

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

int	exercise id

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

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

Member Function Documentation

countFeedbackFiles()

ilFSStorageExercise5069::countFeedbackFiles

(

$a_user_id

)

Count number of feedback files for a user.

Definition at line 299 of file class.ilFSStorageExercise5069.php.

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

References getFeedbackFiles().

Here is the call graph for this function:

create()

ilFSStorageExercise5069::create

(

)

Create directory.

@access public

Reimplemented from ilFileSystemStorage5069.

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

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

References ilUtil\makeDirParents().

Referenced by uploadFile().

Here is the call graph for this function:

Here is the caller graph for this function:

getAbsoluteSubmissionPath()

ilFSStorageExercise5069::getAbsoluteSubmissionPath

(

)

Get submission path.

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

    {
        return $this->submission_path;
    }

Referenced by uploadFile().

Here is the caller graph for this function:

getAssignmentFilePath()

ilFSStorageExercise5069::getAssignmentFilePath

(

$a_file

)

Get path for assignment file.

Definition at line 308 of file class.ilFSStorageExercise5069.php.

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

References ilFileSystemStorage5069\getAbsolutePath().

Here is the call graph for this function:

getFeedbackFilePath()

ilFSStorageExercise5069::getFeedbackFilePath	(		$a_user_id,
			$a_file
	)

Get path for feedback file.

Definition at line 316 of file class.ilFSStorageExercise5069.php.

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

References getFeedbackPath().

Here is the call graph for this function:

getFeedbackFiles()

ilFSStorageExercise5069::getFeedbackFiles

(

$a_user_id

)

Get number of feedback files.

Definition at line 279 of file class.ilFSStorageExercise5069.php.

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

References $files, and getFeedbackPath().

Referenced by countFeedbackFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

getFeedbackPath()

ilFSStorageExercise5069::getFeedbackPath

(

$a_user_id

)

Get feedback path.

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

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

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

Referenced by getFeedbackFilePath(), and getFeedbackFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

getFiles()

ilFSStorageExercise5069::getFiles

(

)

Get assignment files.

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

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

References $files, and ilUtil\sortArray().

Here is the call graph for this function:

getGlobalFeedbackPath()

ilFSStorageExercise5069::getGlobalFeedbackPath

(

)

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

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

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

Here is the call graph for this function:

getMultiFeedbackUploadPath()

ilFSStorageExercise5069::getMultiFeedbackUploadPath

(

$a_user_id

)

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

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

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

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

Here is the call graph for this function:

getPathPostfix()

ilFSStorageExercise5069::getPathPostfix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemStorage5069.

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

    {
        return 'exc';
    }

getPathPrefix()

ilFSStorageExercise5069::getPathPrefix ( )

protected

Implementation of abstract method.

@access protected

Reimplemented from ilFileSystemStorage5069.

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

    {
        return 'ilExercise';
    }

getPeerReviewUploadPath()

ilFSStorageExercise5069::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.ilFSStorageExercise5069.php.

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

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

Here is the call graph for this function:

getTempPath()

ilFSStorageExercise5069::getTempPath

(

)

Get submission path.

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

    {
        return $this->tmp_path;
    }

init()

ilFSStorageExercise5069::init

(

)

Append ass_<ass_id> to path (assignment id)

Reimplemented from ilFileSystemStorage5069.

Definition at line 46 of file class.ilFSStorageExercise5069.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;
    }

References init().

Here is the call graph for this function:

uploadAssignmentFiles()

ilFSStorageExercise5069::uploadAssignmentFiles

(

$a_files

)

Upload assignment files (e.g.

from assignment creation form)

Definition at line 326 of file class.ilFSStorageExercise5069.php.

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

References $name, $size, and $type.

uploadFile()

ilFSStorageExercise5069::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 @access 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.ilFSStorageExercise5069.php.

    {
        $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'];
            // 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) {
                //move_uploaded_file($a_http_post_file["tmp_name"], $savepath . $prefix . "_" . $filename);
                ilUtil::moveUploadedFile(
                    $a_http_post_file["tmp_name"],
                    $a_http_post_file["name"],
                    $savepath . "/" . $prefix . "_" . $filename
                );
            } else {
                rename(
                    $a_http_post_file['tmp_name'],
                    $savepath . "/" . $prefix . "_" . $filename
                );
            }
 
            require_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
 
            if (is_file($savepath . "/" . $prefix . "_" . $filename)) {
                $result = array(
                    "filename" => $prefix . "_" . $filename,
                    "fullname" => $savepath . "/" . $prefix . "_" . $filename,
                    "mimetype" => ilObjMediaObject::getMimeType($savepath . "/" . $prefix . "_" . $filename)
                );
            }
        }
        return $result;
    }

References $filename, $result, create(), getAbsoluteSubmissionPath(), ilObjMediaObject\getMimeType(), and ilUtil\makeDir().

Here is the call graph for this function:

---

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

• Services/Migration/DBUpdate_5069/classes/class.ilFSStorageExercise5069.php