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

Collaboration diagram for ilExcCriteriaText:

Public Member Functions
	getType ()
	setMinChars (int $a_value)
	getMinChars ()
	initCustomForm (ilPropertyFormGUI $a_form)
	exportCustomForm (ilPropertyFormGUI $a_form)
	importCustomForm (ilPropertyFormGUI $a_form)
	addToPeerReviewForm ($a_value=null)
	importFromPeerReviewForm ()
	validate ($a_value)
	hasValue ($a_value)
	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 ()

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 ()
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

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 ilExcCriteriaText

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.ilExcCriteriaText.php.

Member Function Documentation

addToPeerReviewForm()

ilExcCriteriaText::addToPeerReviewForm

(

$a_value = null

)

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

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

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

        $info = array();
        if ($this->getDescription()) {
            $info[] = $this->getDescription();
        }
        if ($this->getMinChars()) {
            $info[] = $lng->txt("exc_peer_review_min_chars") . ": " . $this->getMinChars();
        }
        $info = implode("<br />", $info);

        $input = new ilTextAreaInputGUI($this->getTitle(), "prccc_text_" . $this->getId());
        $input->setRows(10);
        $input->setInfo($info);
        $input->setRequired($this->isRequired());
        $input->setValue((string) $a_value);

        $this->form->addItem($input);
    }

Here is the call graph for this function:

exportCustomForm()

ilExcCriteriaText::exportCustomForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 65 of file class.ilExcCriteriaText.php.

References ilPropertyFormGUI\getItemByPostVar(), and getMinChars().

                                                               : void
    {
        $min = $this->getMinChars();
        if ($min) {
            $a_form->getItemByPostVar("peer_char_tgl")->setChecked(true);
            $a_form->getItemByPostVar("peer_char")->setValue($min);
        }
    }

Here is the call graph for this function:

getHTML()

ilExcCriteriaText::getHTML

(

$a_value

)

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

                                     : string
    {
        return nl2br($a_value);
    }

getMinChars()

ilExcCriteriaText::getMinChars

(

)

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

References ilExcCriteria\$def, and ilExcCriteria\getDefinition().

Referenced by addToPeerReviewForm(), exportCustomForm(), and validate().

                                 : int
    {
        $def = $this->getDefinition();
        if (is_array($def)) {
            return (int) $def["chars"];
        }

        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

ilExcCriteriaText::getType

(

)

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

                             : string
    {
        return "text";
    }

hasValue()

ilExcCriteriaText::hasValue

(

$a_value

)

Definition at line 135 of file class.ilExcCriteriaText.php.

Referenced by validate().

                                      : bool
    {
        return (bool) strlen($a_value);
    }

Here is the caller graph for this function:

importCustomForm()

ilExcCriteriaText::importCustomForm

(

ilPropertyFormGUI

$a_form

)

Definition at line 74 of file class.ilExcCriteriaText.php.

References ilPropertyFormGUI\getInput(), ilExcCriteria\setDefinition(), and setMinChars().

                                                               : void
    {
        $this->setDefinition(null);

        if ($a_form->getInput("peer_char_tgl")) {
            $this->setMinChars($a_form->getInput("peer_char"));
        }
    }

Here is the call graph for this function:

importFromPeerReviewForm()

ilExcCriteriaText::importFromPeerReviewForm

(

)

Definition at line 108 of file class.ilExcCriteriaText.php.

References ILIAS\Repository\form().

                                              : string
    {
        return trim($this->form->getInput("prccc_text_" . $this->getId()));
    }

Here is the call graph for this function:

initCustomForm()

ilExcCriteriaText::initCustomForm

(

ilPropertyFormGUI

$a_form

)

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

References ilExcCriteria\$lng, ilPropertyFormGUI\addItem(), ilFormPropertyGUI\setInfo(), and ilLanguage\txt().

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

        $peer_char_tgl = new ilCheckboxInputGUI($lng->txt("exc_peer_review_min_chars_tgl"), "peer_char_tgl");
        $a_form->addItem($peer_char_tgl);

        $peer_char = new ilNumberInputGUI($lng->txt("exc_peer_review_min_chars"), "peer_char");
        $peer_char->setInfo($lng->txt("exc_peer_review_min_chars_info"));
        $peer_char->setRequired(true);
        $peer_char->setSize(3);
        $peer_char_tgl->addSubItem($peer_char);
    }

Here is the call graph for this function:

setMinChars()

ilExcCriteriaText::setMinChars

(

int

$a_value

)

Definition at line 32 of file class.ilExcCriteriaText.php.

References ilExcCriteria\setDefinition().

Referenced by importCustomForm().

                                             : void
    {
        $this->setDefinition(array("chars" => $a_value));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilExcCriteriaText::validate

(

$a_value

)

Definition at line 113 of file class.ilExcCriteriaText.php.

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

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

        if (!$this->hasValue($a_value) &&
            !$this->isRequired()) {
            return true;
        }

        $min = $this->getMinChars();
        if ($min) {
            if (ilStr::strLen((string) $a_value) < $min) {
                if ($this->form) {
                    $mess = sprintf($lng->txt("exc_peer_review_chars_invalid"), $min);
                    $this->form->getItemByPostVar("prccc_text_" . $this->getId())->setAlert($mess);
                }
                return false;
            }
        }
        return true;
    }

Here is the call graph for this function:

---

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

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