ilDclBaseRecordRepresentation Class Reference

Class ilDclBaseRecordRepresentation. More...

Inheritance diagram for ilDclBaseRecordRepresentation:

Collaboration diagram for ilDclBaseRecordRepresentation:

Public Member Functions
	__construct (ilDclBaseRecordFieldModel $record_field)
	getFormGUI (ilPropertyFormGUI $formGUI)
	parseFormInput ($value)
	function parses stored value to the variable needed to fill into the form for editing. More...
	fillFormInput ($form)
	Fills the form with the value of a record. More...
	getHTML ($link=true)
	Outputs html of a certain field. More...
	getSingleHTML (array $options=null, $link=true)
	Returns data for single record view. More...
	getConfirmationHTML ()
	Returns data for confirmation list When returning false, attribute is ignored in list. More...
	fillRow (ilTemplate $tpl)
	Fills row with record data. More...
	getRecordField ()
	Get Record Field. More...
	getField ()
	Getter shortcut for field. More...
	getRecord ()
	Getter shortcut for record. More...

Protected Member Functions
	getFormInput ()
	Gets the value from from the record field. More...

Protected Attributes
	$record_field
	$lng
	$access
	$ctrl

Detailed Description

Class ilDclBaseRecordRepresentation.

Author

Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

Definition at line 10 of file class.ilDclBaseRecordRepresentation.php.

Constructor & Destructor Documentation

__construct()

ilDclBaseRecordRepresentation::__construct

(

ilDclBaseRecordFieldModel

$record_field

)

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

References $DIC, $ilCtrl, $lng, and $record_field.

    {
        global $DIC;
        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
        $ilCtrl = $DIC['ilCtrl'];

        $this->lng = $lng;
        $this->access = $ilAccess;
        $this->ctrl = $ilCtrl;

        $this->record_field = $record_field;
    }

Member Function Documentation

fillFormInput()

ilDclBaseRecordRepresentation::fillFormInput

(

$form

)

Fills the form with the value of a record.

Parameters

$form

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

References $form, getField(), getFormInput(), and getRecordField().

    {
        $input_field = $form->getItemByPostVar('field_' . $this->getRecordField()->getField()->getId());
        if ($input_field) {
            $value = $this->getFormInput();
            $input_field->setValueByArray(array("field_" . $this->getRecordField()->getField()->getId() => $value));
        }
    }

Here is the call graph for this function:

fillRow()

ilDclBaseRecordRepresentation::fillRow

(

ilTemplate

$tpl

)

Fills row with record data.

Parameters

ilTemplate

$tpl

Definition at line 123 of file class.ilDclBaseRecordRepresentation.php.

    {
    }

getConfirmationHTML()

ilDclBaseRecordRepresentation::getConfirmationHTML

(

)

Returns data for confirmation list When returning false, attribute is ignored in list.

Returns

string

Definition at line 112 of file class.ilDclBaseRecordRepresentation.php.

References getHTML().

    {
        return $this->getHTML();
    }

Here is the call graph for this function:

getField()

ilDclBaseRecordRepresentation::getField

(

)

Getter shortcut for field.

Returns

ilDclBaseFieldModel

Definition at line 144 of file class.ilDclBaseRecordRepresentation.php.

Referenced by fillFormInput(), ilDclTextRecordRepresentation\fillFormInput(), ilDclRatingRecordRepresentation\getHTML(), ilDclMobRecordRepresentation\getHTML(), ilDclFileuploadRecordRepresentation\getHTML(), ilDclTextRecordRepresentation\getHTML(), ilDclSelectionRecordRepresentation\getHTML(), and ilDclIliasReferenceRecordRepresentation\getSingleHTML().

    {
        return $this->record_field->getField();
    }

Here is the caller graph for this function:

getFormGUI()

ilDclBaseRecordRepresentation::getFormGUI

(

ilPropertyFormGUI

$formGUI

)

Definition at line 33 of file class.ilDclBaseRecordRepresentation.php.

    {
        // Apply form-elements to record-entry-gui
    }

getFormInput()

ilDclBaseRecordRepresentation::getFormInput ( )

protected

Gets the value from from the record field.

Returns

mixed

Definition at line 72 of file class.ilDclBaseRecordRepresentation.php.

References getRecordField(), and parseFormInput().

Referenced by fillFormInput(), and ilDclTextRecordRepresentation\fillFormInput().

    {
        return $this->parseFormInput($this->getRecordField()->getValue());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilDclBaseRecordRepresentation::getHTML

(

$link = true

)

Outputs html of a certain field.

Parameters

mixed	$value
bool | true	$link

Returns

string

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

References getRecordField().

Referenced by getConfirmationHTML(), and getSingleHTML().

    {
        return $this->getRecordField()->getValue();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRecord()

ilDclBaseRecordRepresentation::getRecord

(

)

Getter shortcut for record.

Returns

ilDclBaseRecordModel

Definition at line 155 of file class.ilDclBaseRecordRepresentation.php.

Referenced by ilDclRatingRecordRepresentation\getHTML(), ilDclMobRecordRepresentation\getHTML(), ilDclFileuploadRecordRepresentation\getHTML(), and ilDclTextRecordRepresentation\getHTML().

    {
        return $this->record_field->getRecord();
    }

Here is the caller graph for this function:

getRecordField()

ilDclBaseRecordRepresentation::getRecordField

(

)

Get Record Field.

Returns

ilDclBaseRecordFieldModel

Definition at line 133 of file class.ilDclBaseRecordRepresentation.php.

References $record_field.

Referenced by fillFormInput(), ilDclTextRecordRepresentation\fillFormInput(), ilDclIliasReferenceRecordRepresentation\getActionLink(), getFormInput(), ilDclReferenceRecordRepresentation\getHTML(), ilDclRatingRecordRepresentation\getHTML(), ilDclIliasReferenceRecordRepresentation\getHTML(), ilDclBooleanRecordRepresentation\getHTML(), ilDclDatetimeRecordRepresentation\getHTML(), ilDclMobRecordRepresentation\getHTML(), ilDclFileuploadRecordRepresentation\getHTML(), ilDclSelectionRecordRepresentation\getHTML(), ilDclTextRecordRepresentation\getHTML(), getHTML(), ilDclIliasReferenceRecordRepresentation\getLinkHTML(), and ilDclIliasReferenceRecordRepresentation\getSingleHTML().

    {
        return $this->record_field;
    }

Here is the caller graph for this function:

getSingleHTML()

ilDclBaseRecordRepresentation::getSingleHTML	(	array	$options = null,
			$link = true
	)

Returns data for single record view.

Parameters

array | NULL	$options
bool	$link

Returns

string

Definition at line 100 of file class.ilDclBaseRecordRepresentation.php.

References getHTML().

    {
        return $this->getHTML($link);
    }

Here is the call graph for this function:

parseFormInput()

ilDclBaseRecordRepresentation::parseFormInput

(

$value

)

function parses stored value to the variable needed to fill into the form for editing.

Parameters

$value

Returns

mixed

Definition at line 46 of file class.ilDclBaseRecordRepresentation.php.

Referenced by getFormInput().

    {
        return $value;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilDclBaseRecordRepresentation::$access

protected

Definition at line 14 of file class.ilDclBaseRecordRepresentation.php.

Referenced by ilDclFileuploadRecordRepresentation\getHTML().

$ctrl

ilDclBaseRecordRepresentation::$ctrl

protected

Definition at line 15 of file class.ilDclBaseRecordRepresentation.php.

$lng

ilDclBaseRecordRepresentation::$lng

protected

Definition at line 13 of file class.ilDclBaseRecordRepresentation.php.

Referenced by __construct(), and ilDclIliasReferenceRecordRepresentation\getLinkHTML().

$record_field

ilDclBaseRecordRepresentation::$record_field

protected

Definition at line 12 of file class.ilDclBaseRecordRepresentation.php.

Referenced by __construct(), ilDclReferenceRecordRepresentation\getHTML(), ilDclReferenceRecordRepresentation\getLinkHTML(), and getRecordField().

---

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

• Modules/DataCollection/classes/Fields/Base/class.ilDclBaseRecordRepresentation.php