ilDclBaseRecordRepresentation Class Reference

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 (ilPropertyFormGUI $form)
	Fills the form with the value of a record. More...
	getHTML (bool $link=true, array $options=[])
	Outputs html of a certain field. More...
	getSingleHTML (?array $options=null, bool $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
ILIAS UI Factory	$factory
ilDclBaseRecordFieldModel	$record_field
ilLanguage	$lng
ilAccess	$access
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ILIAS UI Renderer	$renderer
ilObjUser	$user

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDclBaseRecordRepresentation::__construct

(

ilDclBaseRecordFieldModel

$record_field

)

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

References $DIC, $record_field, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), factory(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
        $this->user = $DIC->user();

        $this->record_field = $record_field;
    }

Here is the call graph for this function:

Member Function Documentation

fillFormInput()

ilDclBaseRecordRepresentation::fillFormInput

(

ilPropertyFormGUI

$form

)

Fills the form with the value of a record.

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

References getField(), getFormInput(), ILIAS\Survey\Mode\getId(), ilPropertyFormGUI\getItemByPostVar(), and getRecordField().

                                                          : void
    {
        $input_field = $form->getItemByPostVar('field_' . $this->getRecordField()->getField()->getId());
        if ($input_field) {
            $value = $this->getFormInput();
            if (!is_null($value)) {
                $input_field->setValueByArray(["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 116 of file class.ilDclBaseRecordRepresentation.php.

                                            : void
    {
    }

getConfirmationHTML()

ilDclBaseRecordRepresentation::getConfirmationHTML

(

)

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

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

References getHTML().

                                         : string
    {
        return $this->getHTML();
    }

Here is the call graph for this function:

getField()

ilDclBaseRecordRepresentation::getField

(

)

Getter shortcut for field.

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

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

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

Here is the caller graph for this function:

getFormGUI()

ilDclBaseRecordRepresentation::getFormGUI

(

ilPropertyFormGUI

$formGUI

)

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

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

getFormInput()

ilDclBaseRecordRepresentation::getFormInput ( )

protected

Gets the value from from the record field.

Returns

int|string

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

References getRecordField(), ILIAS\UI\Implementation\Component\Input\getValue(), 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	(	bool	$link = true,
		array	$options = []
	)

Outputs html of a certain field.

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

References getRecordField().

Referenced by getConfirmationHTML(), and getSingleHTML().

                                                                   : string
    {
        return (string) $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.

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

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

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

Here is the caller graph for this function:

getRecordField()

ilDclBaseRecordRepresentation::getRecordField

(

)

Get Record Field.

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

References $record_field.

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

                                    : ilDclBaseRecordFieldModel
    {
        return $this->record_field;
    }

Here is the caller graph for this function:

getSingleHTML()

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

Returns data for single record view.

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

References getHTML().

                                                                            : string
    {
        return $this->getHTML($link, $options);
    }

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

string | int

$value

Returns

string|int

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

Referenced by getFormInput().

    {
        return $value;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccess ilDclBaseRecordRepresentation::$access

protected

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

$ctrl

ilCtrl ilDclBaseRecordRepresentation::$ctrl

protected

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

$factory

ILIAS UI Factory ilDclBaseRecordRepresentation::$factory

protected

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

$http

ILIAS HTTP Services ilDclBaseRecordRepresentation::$http

protected

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

$lng

ilLanguage ilDclBaseRecordRepresentation::$lng

protected

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

$record_field

ilDclBaseRecordFieldModel ilDclBaseRecordRepresentation::$record_field

protected

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

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

$refinery

ILIAS Refinery Factory ilDclBaseRecordRepresentation::$refinery

protected

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

$renderer

ILIAS UI Renderer ilDclBaseRecordRepresentation::$renderer

protected

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

$user

ilObjUser ilDclBaseRecordRepresentation::$user

protected

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

---

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

• components/ILIAS/DataCollection/classes/Fields/Base/class.ilDclBaseRecordRepresentation.php