ilExcCriteriaFile 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 ilExcCriteriaFile:

Collaboration diagram for ilExcCriteriaFile:

Public Member Functions
	getType ()
	getFiles ()
	resetReview ()
	addToPeerReviewForm ($a_value=null)
	importFromPeerReviewForm ()
	hasValue ($a_value)
	validate ($a_value)
	getFileByHash ()
	getHTML ($a_value)
Public Member Functions inherited from ilExcCriteria
	__construct ()
	getTranslatedType ()
	getId ()
	getType ()
	setParent (?int $a_value)
	getParent ()
	setTitle (?string $a_value)
	getTitle ()
	setDescription (?string $a_value)
	getDescription ()
	setRequired (bool $a_value)
	isRequired ()
	setPosition (int $a_value)
	getPosition ()
	importDefinition (string $a_def, string $a_def_json)
	save ()
	update ()
	delete ()
	cloneObject (int $a_target_parent_id)
	initCustomForm (ilPropertyFormGUI $a_form)
	exportCustomForm (ilPropertyFormGUI $a_form)
	importCustomForm (ilPropertyFormGUI $a_form)
	setPeerReviewContext (ilExAssignment $a_ass, int $a_giver_id, int $a_peer_id, ilPropertyFormGUI $a_form=null)
	addToPeerReviewForm ($a_value=null)
	importFromPeerReviewForm ()
	updateFromAjax ()
	validate ($a_value)
	hasValue ($a_value)
	getHTML ($a_value)
	resetReview ()

Protected Member Functions
	initStorage ()
Protected Member Functions inherited from ilExcCriteria
	setId (?int $a_id)
	setDefinition (?array $a_value=null)
	getDefinition ()
	importFromDB (array $a_row)
	getDBProperties ()
	getLastPosition ()

Protected Attributes
string	$requested_file_hash = ""
Protected Attributes inherited from ilExcCriteria
ilLanguage	$lng
ilCtrl	$ctrl
ilDBInterface	$db
int	$id = null
int	$parent = null
string	$title = ""
string	$desc = ""
bool	$required = false
int	$pos = 0
array	$def = null
ilPropertyFormGUI	$form = null
ilExAssignment	$ass
int	$giver_id = 0
int	$peer_id = 0

Additional Inherited Members
Static Public Member Functions inherited from ilExcCriteria
static	getInstanceById (int $a_id)
static	getInstancesByParentId (int $a_parent_id)
static	getTypesMap ()
static	getInstanceByType (string $a_type)
static	deleteByParent (int $a_parent_id)

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 Class ilExcCriteriaFile

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.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 25 of file class.ilExcCriteriaFile.php.

Member Function Documentation

addToPeerReviewForm()

ilExcCriteriaFile::addToPeerReviewForm

(

$a_value = null

)

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

References ILIAS\Repository\form(), ilExcCriteria\getDescription(), getFiles(), ilExcCriteria\getId(), ilExcCriteria\getTitle(), and ilExcCriteria\isRequired().

                                                        : void
    {
        $existing = array();
        foreach ($this->getFiles() as $file) {
            $existing[] = basename($file);
        }

        $files = new ilFileInputGUI($this->getTitle(), "prccc_file_" . $this->getId());
        $files->setInfo($this->getDescription());
        $files->setRequired($this->isRequired());
        $files->setValue(implode("<br />", $existing));
        $files->setAllowDeletion(true);
        $this->form->addItem($files);
    }

Here is the call graph for this function:

getFileByHash()

ilExcCriteriaFile::getFileByHash

(

)

Returns

false|mixed

Definition at line 130 of file class.ilExcCriteriaFile.php.

References getFiles().

    {
        $hash = trim($this->requested_file_hash);
        if ($hash != "") {
            foreach ($this->getFiles() as $file) {
                if (md5($file) == $hash) {
                    return $file;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

getFiles()

ilExcCriteriaFile::getFiles

(

)

Definition at line 51 of file class.ilExcCriteriaFile.php.

References $path, and initStorage().

Referenced by addToPeerReviewForm(), getFileByHash(), getHTML(), and hasValue().

                              : array
    {
        $path = $this->initStorage();
        return (array) glob($path . "*.*");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilExcCriteriaFile::getHTML

(

$a_value

)

Definition at line 143 of file class.ilExcCriteriaFile.php.

References ilExcCriteria\$ctrl, getFiles(), and ilExcCriteria\getId().

                                     : string
    {
        $ilCtrl = $this->ctrl;

        $crit_id = $this->getId()
            ?: "file";
        $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fu", $this->giver_id . "__" . $this->peer_id . "__" . $crit_id);

        $files = array();
        foreach ($this->getFiles() as $file) {
            $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fuf", md5($file));
            $dl = $ilCtrl->getLinkTargetByClass("ilExPeerReviewGUI", "downloadPeerReview");
            $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fuf", "");

            $files[] = '<a href="' . $dl . '">' . basename($file) . '</a>';
        }

        $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fu", "");

        return implode("<br />", $files);
    }

Here is the call graph for this function:

getType()

ilExcCriteriaFile::getType

(

)

Definition at line 40 of file class.ilExcCriteriaFile.php.

                             : string
    {
        return "file";
    }

hasValue()

ilExcCriteriaFile::hasValue

(

$a_value

)

Definition at line 106 of file class.ilExcCriteriaFile.php.

References getFiles().

Referenced by validate().

                                      : bool
    {
        return count($this->getFiles()) > 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importFromPeerReviewForm()

ilExcCriteriaFile::importFromPeerReviewForm

(

)

Exceptions

ilException

Definition at line 84 of file class.ilExcCriteriaFile.php.

References $path, ilFileUtils\delDir(), ILIAS\Repository\form(), ilExcCriteria\getId(), initStorage(), and ilFileUtils\moveUploadedFile().

                                              : void
    {
        $path = $this->initStorage();

        if ($this->form->getItemByPostVar("prccc_file_" . $this->getId())->getDeletionFlag()) {
            ilFileUtils::delDir($path);
            $this->form->getItemByPostVar("prccc_file_" . $this->getId())->setValue("");
        }

        $incoming = $_FILES["prccc_file_" . $this->getId()];
        if ($incoming["tmp_name"]) {
            $org_name = basename($incoming["name"]);

            ilFileUtils::moveUploadedFile(
                $incoming["tmp_name"],
                $org_name,
                $path . $org_name,
                false
            );
        }
    }

Here is the call graph for this function:

initStorage()

ilExcCriteriaFile::initStorage ( )

protected

Definition at line 45 of file class.ilExcCriteriaFile.php.

References ilExcCriteria\getId(), and ilFSStorageExercise\getPeerReviewUploadPath().

Referenced by getFiles(), and importFromPeerReviewForm().

                                    : string
    {
        $storage = new ilFSStorageExercise($this->ass->getExerciseId(), $this->ass->getId());
        return $storage->getPeerReviewUploadPath($this->peer_id, $this->giver_id, $this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetReview()

ilExcCriteriaFile::resetReview

(

)

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

References ilFileSystemAbstractionStorage\deleteDirectory().

                                 : void
    {
        $storage = new ilFSStorageExercise($this->ass->getExerciseId(), $this->ass->getId());
        $storage->deleteDirectory($storage->getPeerReviewUploadPath($this->peer_id, $this->giver_id, $this->getId()));
    }

Here is the call graph for this function:

validate()

ilExcCriteriaFile::validate

(

$a_value

)

Definition at line 111 of file class.ilExcCriteriaFile.php.

References ilExcCriteria\$lng, ILIAS\Repository\form(), ilExcCriteria\getId(), hasValue(), ilExcCriteria\isRequired(), and ilLanguage\txt().

                                      : bool
    {
        $lng = $this->lng;

        // because of deletion flag we have to also check ourselves
        if ($this->isRequired()) {
            if (!$this->hasValue($a_value)) {
                if ($this->form) {
                    $this->form->getItemByPostVar("prccc_file_" . $this->getId())->setAlert($lng->txt("msg_input_is_required"));
                }
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$requested_file_hash

string ilExcCriteriaFile::$requested_file_hash = ""

protected

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

---

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

• Modules/Exercise/PeerReview/Criteria/class.ilExcCriteriaFile.php