ilExcCriteriaText Class Reference

Class ilExcCriteriaText. More...

Inheritance diagram for ilExcCriteriaText:

Collaboration diagram for ilExcCriteriaText:

Public Member Functions
	__construct ()
	Constructor. More...
	getType ()
	setMinChars ($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
	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 Attributes
	$lng
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)
Protected Member Functions inherited from ilExcCriteria
	__construct ()
	setId ($a_id)
	setDefinition (array $a_value=null)
	getDefinition ()
	importFromDB (array $a_row)
	getDBProperties ()
	getLastPosition ()

Detailed Description

Class ilExcCriteriaText.

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 13 of file class.ilExcCriteriaText.php.

Constructor & Destructor Documentation

__construct()

ilExcCriteriaText::__construct

(

)

Constructor.

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

References $DIC.

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

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

Member Function Documentation

addToPeerReviewForm()

ilExcCriteriaText::addToPeerReviewForm

(

$a_value = null

)

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

References $info, $lng, array, ilExcCriteria\getDescription(), ilExcCriteria\getId(), getMinChars(), ilExcCriteria\getTitle(), and ilExcCriteria\isRequired().

    {
        $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($a_value);
        
        $this->form->addItem($input);
    }

Here is the call graph for this function:

exportCustomForm()

ilExcCriteriaText::exportCustomForm

(

ilPropertyFormGUI

$a_form

)

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

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

    {
        $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 144 of file class.ilExcCriteriaText.php.

    {
        return nl2br($a_value);
    }

getMinChars()

ilExcCriteriaText::getMinChars

(

)

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getType()

ilExcCriteriaText::getType

(

)

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

    {
        return "text";
    }

hasValue()

ilExcCriteriaText::hasValue

(

$a_value

)

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

Referenced by validate().

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

Here is the caller graph for this function:

importCustomForm()

ilExcCriteriaText::importCustomForm

(

ilPropertyFormGUI

$a_form

)

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

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

    {
        $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 111 of file class.ilExcCriteriaText.php.

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

initCustomForm()

ilExcCriteriaText::initCustomForm

(

ilPropertyFormGUI

$a_form

)

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

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

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

(

$a_value

)

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

References array, and ilExcCriteria\setDefinition().

Referenced by importCustomForm().

    {
        $this->setDefinition(array("chars" => (int) $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 116 of file class.ilExcCriteriaText.php.

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

    {
        $lng = $this->lng;
        
        if (!$this->hasValue($a_value) &&
            !$this->isRequired()) {
            return true;
        }
        
        $min = $this->getMinChars();
        if ($min) {
            include_once "Services/Utilities/classes/class.ilStr.php";
            if (ilStr::strLen($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:

Field Documentation

$lng

ilExcCriteriaText::$lng

protected

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

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

---

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

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