This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDclBaseFieldRepresentation:

Collaboration diagram for ilDclBaseFieldRepresentation:

Public Member Functions
	__construct (ilDclBaseFieldModel $field)

	addFilterInputFieldToTable (ilTable2GUI $table)
	Add filter input to TableGUI. More...

	passThroughFilter (ilDclBaseRecordModel $record, $filter)
	Checks if a filter affects a record. More...

	parseSortingValue (string $value, bool $link=true)

	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	Returns field-input. More...

	addFieldCreationForm (ilSubEnabledFormPropertyGUI $form, ilObjDataCollection $dcl, string $mode="create")
	Adds the options for the field-types to the field-creation form. More...

	getPropertyInputFieldId (string $property)
	Return post-var for property-fields. More...

	getField ()
	Return BaseFieldModel. More...

Protected Member Functions
	setupFilterInputField (?ilTableFilterItem $input)
	Set basic settings for filter-input-gui. More...

	setupInputField (ilFormPropertyGUI $input, ilDclBaseFieldModel $field)
	Sets basic settings on field-input. More...

	getFilterInputFieldValue (ilTableFilterItem $input)

	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
	Build the creation-input-field. More...

Protected Attributes
ilDclBaseFieldModel	$field

ilLanguage	$lng

ilCtrl	$ctrl

ILIAS HTTP Services	$http

ILIAS Refinery Factory	$refinery

ilComponentRepository	$component_repository

ilComponentFactory	$component_factory

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

Definition at line 19 of file class.ilDclBaseFieldRepresentation.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclBaseFieldRepresentation::__construct ( ilDclBaseFieldModel $field )

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

    {
        global $DIC;
 
        $this->field = $field;
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->component_repository = $DIC["component.repository"];
        $this->component_factory = $DIC["component.factory"];
    }

References $DIC, $field, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ addFieldCreationForm()

ilDclBaseFieldRepresentation::addFieldCreationForm	(	ilSubEnabledFormPropertyGUI	$form,
		ilObjDataCollection	$dcl,
		string	$mode = `"create"`
	)

Adds the options for the field-types to the field-creation form.

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

     : void {
        $opt = $this->buildFieldCreationInput($dcl, $mode);
        if ($opt !== null) {
            $form->addOption($opt);
        }
    }

◆ addFilterInputFieldToTable()

ilDclBaseFieldRepresentation::addFilterInputFieldToTable ( ilTable2GUI $table )

Add filter input to TableGUI.

Parameters

ilTable2GUI $table

Returns: null

Reimplemented in ilDclBooleanFieldRepresentation, ilDclCopyFieldRepresentation, ilDclDatetimeFieldRepresentation, ilDclFileuploadFieldRepresentation, ilDclIliasReferenceFieldRepresentation, ilDclMobFieldRepresentation, ilDclNumberFieldRepresentation, ilDclRatingFieldRepresentation, ilDclReferenceFieldRepresentation, ilDclSelectionFieldRepresentation, and ilDclTextFieldRepresentation.

Definition at line 48 of file class.ilDclBaseFieldRepresentation.php.

    {
        return null;
    }

◆ buildFieldCreationInput()

ilDclBaseFieldRepresentation::buildFieldCreationInput	(	ilObjDataCollection	$dcl,
		string	$mode = `'create'`
	)

protected

Build the creation-input-field.

Reimplemented in ilDclCopyFieldRepresentation, ilDclFileuploadFieldRepresentation, ilDclFormulaFieldRepresentation, ilDclIliasReferenceFieldRepresentation, ilDclMobFieldRepresentation, ilDclNumberFieldRepresentation, ilDclPluginFieldRepresentation, ilDclReferenceFieldRepresentation, ilDclSelectionFieldRepresentation, and ilDclTextFieldRepresentation.

Definition at line 147 of file class.ilDclBaseFieldRepresentation.php.

                                                                                                 : ?ilRadioOption
    {
        $opt = null;
        if ($this->getField()->getDatatypeId() !== null) {
            $title = $this->field->getPresentationTitle();
            $info = $this->field->getPresentationDescription();
            $opt = new ilRadioOption($title, (string) $this->getField()->getDatatypeId());
            $opt->setInfo($info);
        }
 
        return $opt;
    }

◆ getField()

ilDclBaseFieldRepresentation::getField ( )

Return BaseFieldModel.

Definition at line 171 of file class.ilDclBaseFieldRepresentation.php.

                              : ilDclBaseFieldModel
    {
        return $this->field;
    }

Here is the caller graph for this function:

◆ getFilterInputFieldValue()

ilDclBaseFieldRepresentation::getFilterInputFieldValue ( ilTableFilterItem $input )

protected

Returns: string|array|null

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

      {
        $value = $input->getValue();
        if (is_array($value)) {
            if ($value['from'] || $value['to']) {
                return $value;
            }
        } else {
            if ($value != '') {
                return $value;
            }
        }
 
        return null;
    }

Here is the caller graph for this function:

◆ getInputField()

ilDclBaseFieldRepresentation::getInputField	(	ilPropertyFormGUI	$form,
		?int	$record_id = `null`
	)

Returns field-input.

Reimplemented in ilDclBooleanFieldRepresentation, ilDclCopyFieldRepresentation, ilDclDatetimeFieldRepresentation, ilDclFileuploadFieldRepresentation, ilDclFormulaFieldRepresentation, ilDclIliasReferenceFieldRepresentation, ilDclMobFieldRepresentation, ilDclNumberFieldRepresentation, ilDclRatingFieldRepresentation, ilDclReferenceFieldRepresentation, and ilDclTextFieldRepresentation.

Definition at line 95 of file class.ilDclBaseFieldRepresentation.php.

                                                                                  : ?ilFormPropertyGUI
    {
        return null;
    }

◆ getPropertyInputFieldId()

ilDclBaseFieldRepresentation::getPropertyInputFieldId ( string $property )

Return post-var for property-fields.

Definition at line 163 of file class.ilDclBaseFieldRepresentation.php.

                                                             : string
    {
        return "prop_" . $property;
    }

◆ parseSortingValue()

ilDclBaseFieldRepresentation::parseSortingValue	(	string	$value,
		bool	$link = `true`
	)

Parameters

mixed $value

Returns: mixed

Definition at line 87 of file class.ilDclBaseFieldRepresentation.php.

    {
        return $value;
    }

◆ passThroughFilter()

ilDclBaseFieldRepresentation::passThroughFilter	(	ilDclBaseRecordModel	$record,
			$filter
	)

Checks if a filter affects a record.

Parameters

int | string | array $filter

Reimplemented in ilDclBooleanFieldRepresentation, ilDclCopyFieldRepresentation, ilDclDatetimeFieldRepresentation, ilDclFileuploadFieldRepresentation, ilDclIliasReferenceFieldRepresentation, ilDclMobFieldRepresentation, ilDclNumberFieldRepresentation, ilDclRatingFieldRepresentation, ilDclReferenceFieldRepresentation, and ilDclTextFieldRepresentation.

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

                                                                            : bool
    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
        $pass = true;
 
        if (($this->getField()->getId() == "owner" || $this->getField()->getId() == "last_edit_by") && $filter) {
            $pass = false;
            $user = new ilObjUser($value);
            if (strpos($user->getFullname(), $filter) !== false) {
                $pass = true;
            }
        }
 
        return $pass;
    }

References getField(), ILIAS\Survey\Mode\getId(), and ilDclBaseRecordModel\getRecordFieldValue().

Here is the call graph for this function:

◆ setupFilterInputField()

ilDclBaseFieldRepresentation::setupFilterInputField ( ?ilTableFilterItem $input )

protected

Set basic settings for filter-input-gui.

Definition at line 56 of file class.ilDclBaseFieldRepresentation.php.

                                                                       : void
    {
        if ($input != null) {
            $input->setTitle($this->getField()->getTitle());
        }
    }

References getField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setupInputField()

ilDclBaseFieldRepresentation::setupInputField	(	ilFormPropertyGUI	$input,
		ilDclBaseFieldModel	$field
	)

protected

Sets basic settings on field-input.

Parameters

ilFormPropertyGUI	$input
ilDclBaseFieldModel	$field

Definition at line 105 of file class.ilDclBaseFieldRepresentation.php.

                                                                                            : void
    {
        $input->setInfo($field->getDescription() . ($input->getInfo() ? '<br>' . $input->getInfo() : ''));
    }