ilExcCriteriaFile Class Reference

Class ilExcCriteriaFile. More...

Inheritance diagram for ilExcCriteriaFile:

Collaboration diagram for ilExcCriteriaFile:

Public Member Functions
	__construct ()
	Constructor. More...
	getType ()
	getFiles ()
	resetReview ()
	addToPeerReviewForm ($a_value=null)
	importFromPeerReviewForm ()
	hasValue ($a_value)
	validate ($a_value)
	getFileByHash ()
	getHTML ($a_value)
Public Member Functions inherited from ilExcCriteria
	getTranslatedType ()
	getId ()
	getType ()
	setParent ($a_value)
	getParent ()
	setTitle ($a_value)
	getTitle ()
	setDescription ($a_value)
	getDescription ()
	setRequired ($a_value)
	isRequired ()
	setPosition ($a_value)
	getPosition ()
	importDefinition ($a_def, $a_def_json)
	save ()
	update ()
	delete ()
	cloneObject ($a_target_parent_id)
	initCustomForm (ilPropertyFormGUI $a_form)
	exportCustomForm (ilPropertyFormGUI $a_form)
	importCustomForm (ilPropertyFormGUI $a_form)
	setPeerReviewContext (ilExAssignment $a_ass, $a_giver_id, $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
	__construct ()
	setId ($a_id)
	setDefinition (array $a_value=null)
	getDefinition ()
	importFromDB (array $a_row)
	getDBProperties ()
	getLastPosition ()

Protected Attributes
	$lng
	$ctrl
Protected Attributes inherited from ilExcCriteria
	$db
	$id
	$parent
	$title
	$desc
	$required
	$pos
	$def
	$form
	$ass
	$giver_id
	$peer_id

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

Detailed Description

Class ilExcCriteriaFile.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilExcCriteriaFile::__construct

(

)

Constructor.

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC;
        parent::__construct();

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
    }

Here is the call graph for this function:

Member Function Documentation

addToPeerReviewForm()

ilExcCriteriaFile::addToPeerReviewForm

(

$a_value = null

)

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

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

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

(

)

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

References $_GET, and getFiles().

    {
        $hash = trim($_GET["fuf"]);
        if ($hash) {
            foreach ($this->getFiles() as $file) {
                if (md5($file) == $hash) {
                    return $file;
                }
            }
        }
    }

Here is the call graph for this function:

getFiles()

ilExcCriteriaFile::getFiles

(

)

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

References initStorage().

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

    {
        $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 132 of file class.ilExcCriteriaFile.php.

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

    {
        $ilCtrl = $this->ctrl;
        
        $crit_id = $this->getId()
            ? $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 36 of file class.ilExcCriteriaFile.php.

    {
        return "file";
    }

hasValue()

ilExcCriteriaFile::hasValue

(

$a_value

)

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

References getFiles().

Referenced by validate().

    {
        return (bool) sizeof($this->getFiles());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importFromPeerReviewForm()

ilExcCriteriaFile::importFromPeerReviewForm

(

)

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

References ilUtil\delDir(), ilExcCriteria\getId(), initStorage(), and ilUtil\moveUploadedFile().

    {
        $path = $this->initStorage();
        
        if ($this->form->getItemByPostVar("prccc_file_" . $this->getId())->getDeletionFlag()) {
            ilUtil::delDir($path);
            $this->form->getItemByPostVar("prccc_file_" . $this->getId())->setValue(null);
        }
        
        $incoming = $_FILES["prccc_file_" . $this->getId()];
        if ($incoming["tmp_name"]) {
            $org_name = basename($incoming["name"]);
            
            ilUtil::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 41 of file class.ilExcCriteriaFile.php.

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

Referenced by getFiles(), and importFromPeerReviewForm().

    {
        $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 53 of file class.ilExcCriteriaFile.php.

References ilFileSystemStorage\deleteDirectory().

    {
        $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 104 of file class.ilExcCriteriaFile.php.

References $lng, ilExcCriteria\getId(), hasValue(), and ilExcCriteria\isRequired().

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

$ctrl

ilExcCriteriaFile::$ctrl

protected

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

Referenced by getHTML().

$lng

ilExcCriteriaFile::$lng

protected

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

Referenced by validate().

---

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

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