ilDclBooleanFieldRepresentation Class Reference

Inheritance diagram for ilDclBooleanFieldRepresentation:

Collaboration diagram for ilDclBooleanFieldRepresentation:

Public Member Functions
	getInputField (ilPropertyFormGUI $form, ?int $record_id=null)
	addFilterInputFieldToTable (ilTable2GUI $table)
	passThroughFilter (ilDclBaseRecordModel $record, $filter)
Public Member Functions inherited from ilDclBaseFieldRepresentation
	__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...

Additional Inherited Members
Protected Member Functions inherited from ilDclBaseFieldRepresentation
	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 inherited from ilDclBaseFieldRepresentation
ilDclBaseFieldModel	$field
ilLanguage	$lng
ilCtrl	$ctrl
ILIAS HTTP Services	$http
ILIAS Refinery Factory	$refinery
ilComponentRepository	$component_repository
ilComponentFactory	$component_factory

Detailed Description

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

Member Function Documentation

addFilterInputFieldToTable()

ilDclBooleanFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

Parameters

ilTable2GUI

$table

Returns

array|string|null

Exceptions

Exception

Definition at line 36 of file class.ilDclBooleanFieldRepresentation.php.

References ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_SELECT, ilDclBaseFieldRepresentation\getField(), ilDclBaseFieldRepresentation\getFilterInputFieldValue(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\lng(), and ilDclBaseFieldRepresentation\setupFilterInputField().

    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_SELECT,
            false,
            $this->getField()->getId()
        );
        $input->setOptions(
            [
                "" => $this->lng->txt("dcl_any"),
                "not_checked" => $this->lng->txt("dcl_not_checked"),
                "checked" => $this->lng->txt("dcl_checked"),
            ]
        );

        $this->setupFilterInputField($input);

        return $this->getFilterInputFieldValue($input);
    }

Here is the call graph for this function:

getInputField()

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

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

References ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ilDclBaseFieldRepresentation\setupInputField().

                                                                                  : ilDclCheckboxInputGUI
    {
        $input = new ilDclCheckboxInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        $this->setupInputField($input, $this->getField());

        return $input;
    }

Here is the call graph for this function:

passThroughFilter()

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

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

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

                                                                            : bool
    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
        if ((($filter == "checked" && $value == 1) || ($filter == "not_checked" && $value == 0)) || $filter == '' || !$filter) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

---

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

• components/ILIAS/DataCollection/classes/Fields/Boolean/class.ilDclBooleanFieldRepresentation.php