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 Attributes
ILIAS Exercise PeerReview DomainService	$peer_review

string	$requested_file_hash = ""

Protected Attributes inherited from ilExcCriteria
ILIAS Exercise InternalGUIService	$gui

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)

Protected Member Functions inherited from ilExcCriteria
	setId (?int $a_id)

	setDefinition (?array $a_value=null)

	getDefinition ()

	importFromDB (array $a_row)

	getDBProperties ()

	getLastPosition ()

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; Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ addToPeerReviewForm()

ilExcCriteriaFile::addToPeerReviewForm ( $a_value = null )

Reimplemented from ilExcCriteria.

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

                                                        : void
    {
        $existing = array();
        foreach ($this->getFiles() as $file) {
            $existing[] = $file->getTitle();
        }
        $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);
    }

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

Here is the call graph for this function:

◆ getFileByHash()

ilExcCriteriaFile::getFileByHash ( )

Returns: false|mixed

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

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

References getFiles().

Here is the call graph for this function:

◆ getFiles()

ilExcCriteriaFile::getFiles ( )

Returns: \ILIAS\Exercise\PeerReview\Criteria\CriteriaFile[]

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

                              : array
    {
        $file_manager = $this->peer_review->criteriaFile($this->ass->getId());
        $file = $file_manager->getFile($this->giver_id, $this->peer_id, (int) $this->getId());
        $files = $file ? [$file]
            : [];
        return $files;
    }

References ilExcCriteria\getId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilExcCriteriaFile::getHTML ( $a_value )

Reimplemented from ilExcCriteria.

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

                                     : 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->getTitle()));
            $dl = $ilCtrl->getLinkTargetByClass("ilExPeerReviewGUI", "downloadPeerReview");
            $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fuf", "");
 
            $files[] = '<a href="' . $dl . '">' . $file->getTitle() . '</a>';
        }
 
        $ilCtrl->setParameterByClass("ilExPeerReviewGUI", "fu", "");
 
        return implode("<br />", $files);
    }

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

Here is the call graph for this function:

◆ getType()

ilExcCriteriaFile::getType ( )

Reimplemented from ilExcCriteria.

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

                             : string
    {
        return "file";
    }

◆ hasValue()

ilExcCriteriaFile::hasValue ( $a_value )

Reimplemented from ilExcCriteria.

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

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

References getFiles().

Referenced by validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromPeerReviewForm()

ilExcCriteriaFile::importFromPeerReviewForm ( )

Exceptions

ilException

Reimplemented from ilExcCriteria.

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

                                              : void
    {
        $file_manager = $this->peer_review->criteriaFile($this->ass->getId());
        if ($this->form->getItemByPostVar("prccc_file_" . $this->getId())->getDeletionFlag()) {
            $file_manager->delete($this->giver_id, $this->peer_id, $this->getId());
            $this->form->getItemByPostVar("prccc_file_" . $this->getId())->setValue("");
        }
 
        $incoming = $_FILES["prccc_file_" . $this->getId()];
        if ($incoming["tmp_name"]) {
            $org_name = basename($incoming["name"]);
            $file_manager->addFromLegacyUpload(
                $incoming,
                $this->giver_id,
                $this->peer_id,
                (int) $this->getId()
            );
        }
    }

References ILIAS\Repository\form(), and ilExcCriteria\getId().

Here is the call graph for this function:

◆ resetReview()

ilExcCriteriaFile::resetReview ( )

Reimplemented from ilExcCriteria.

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

                                 : void
    {
        $this->peer_review->criteriaFile($this->ass->getId())
            ->delete($this->giver_id, $this->peer_id, $this->getId());
    }

References ilExcCriteria\getId().

Here is the call graph for this function:

◆ validate()

ilExcCriteriaFile::validate ( $a_value )

Reimplemented from ilExcCriteria.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $peer_review

ILIAS Exercise PeerReview DomainService ilExcCriteriaFile::$peer_review

protected

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

◆ $requested_file_hash

string ilExcCriteriaFile::$requested_file_hash = ""

protected

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

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

components/ILIAS/Exercise/PeerReview/Criteria/class.ilExcCriteriaFile.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToPeerReviewForm()

◆ getFileByHash()

◆ getFiles()

◆ getHTML()

◆ getType()

◆ hasValue()

◆ importFromPeerReviewForm()

◆ resetReview()

◆ validate()

Field Documentation

◆ $peer_review

◆ $requested_file_hash