ilDclTextFieldRepresentation Class Reference

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

Inheritance diagram for ilDclTextFieldRepresentation:

Collaboration diagram for ilDclTextFieldRepresentation:

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

Protected Member Functions
	buildFieldCreationInput (ilObjDataCollection $dcl, string $mode='create')
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...

Additional Inherited Members
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

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.ilDclTextFieldRepresentation.php.

Member Function Documentation

addFilterInputFieldToTable()

ilDclTextFieldRepresentation::addFilterInputFieldToTable

(

ilTable2GUI

$table

)

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

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

                                                                  : ?string
    {
        $input = $table->addFilterItemByMetaType(
            "filter_" . $this->getField()->getId(),
            ilTable2GUI::FILTER_TEXT,
            false,
            $this->getField()->getId()
        );
        $input->setSubmitFormOnEnter(true);

        $this->setupFilterInputField($input);

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

Here is the call graph for this function:

buildFieldCreationInput()

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

protected

Definition at line 84 of file class.ilDclTextFieldRepresentation.php.

References ilSubEnabledFormPropertyGUI\addSubItem(), ilDclBaseFieldRepresentation\getPropertyInputFieldId(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_LENGTH, ilDclBaseFieldModel\PROP_LINK_DETAIL_PAGE_TEXT, ilDclBaseFieldModel\PROP_REGEX, ilDclBaseFieldModel\PROP_TEXTAREA, ilDclBaseFieldModel\PROP_URL, ilFormPropertyGUI\setInfo(), and ilNumberInputGUI\setSize().

                                                                                                 : ilRadioOption
    {
        $opt = parent::buildFieldCreationInput($dcl, $mode);

        $prop_length = new ilNumberInputGUI(
            $this->lng->txt('dcl_length'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_LENGTH)
        );
        $prop_length->setSize(5);
        $prop_length->setMaxValue(4000);
        $prop_length->setInfo($this->lng->txt('dcl_length_info'));

        $opt->addSubItem($prop_length);

        $prop_regex = new ilDclTextInputGUI(
            $this->lng->txt('dcl_regex'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_REGEX)
        );
        $prop_regex->setInfo($this->lng->txt('dcl_regex_info'));

        $opt->addSubItem($prop_regex);

        $prop_url = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_url'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_URL)
        );
        $opt->addSubItem($prop_url);

        $prop_textarea = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_text_area'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_TEXTAREA)
        );
        $opt->addSubItem($prop_textarea);

        $prop_page_details = new ilDclCheckboxInputGUI(
            $this->lng->txt('dcl_link_detail_page'),
            $this->getPropertyInputFieldId(ilDclBaseFieldModel::PROP_LINK_DETAIL_PAGE_TEXT)
        );
        $opt->addSubItem($prop_page_details);

        return $opt;
    }

Here is the call graph for this function:

getInputField()

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

Definition at line 51 of file class.ilDclTextFieldRepresentation.php.

References ilDclBaseFieldRepresentation\getField(), ILIAS\Survey\Mode\getId(), ILIAS\Repository\lng(), ilDclBaseFieldModel\PROP_LENGTH, ilDclBaseFieldModel\PROP_TEXTAREA, ilDclBaseFieldModel\PROP_URL, ilFormPropertyGUI\setInfo(), and ilDclBaseFieldRepresentation\setupInputField().

                                                                                  : ilFormPropertyGUI
    {
        $input = new ilDclTextInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
        if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_TEXTAREA)) {
            $input = new ilTextAreaInputGUI($this->getField()->getTitle(), 'field_' . $this->getField()->getId());
            //varchar(4000) in Database
            $input->setMaxNumOfChars(4000);
        }

        if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_LENGTH)) {
            $input->setInfo($this->lng->txt("dcl_max_text_length") . ": " . $this->getField()->getProperty(ilDclBaseFieldModel::PROP_LENGTH));
            if (!$this->getField()->getProperty(ilDclBaseFieldModel::PROP_TEXTAREA)) {
                $input->setMaxLength($this->getField()->getProperty(ilDclBaseFieldModel::PROP_LENGTH));
            } else {
                $input->setMaxNumOfChars($this->getField()->getProperty(ilDclBaseFieldModel::PROP_LENGTH));
            }
        }

        if ($this->getField()->hasProperty(ilDclBaseFieldModel::PROP_URL)) {
            $input->setInfo($this->lng->txt('dcl_text_email_detail_desc'));
            $title_field = new ilDclTextInputGUI(
                $this->lng->txt('dcl_text_email_title'),
                'field_' . $this->getField()->getId() . '_title'
            );
            $title_field->setInfo($this->lng->txt('dcl_text_email_title_info'));
            $input->addSubItem($title_field);
        }

        $this->setupInputField($input, $this->getField());

        return $input;
    }

Here is the call graph for this function:

passThroughFilter()

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

Parameters

string

$filter

Definition at line 39 of file class.ilDclTextFieldRepresentation.php.

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

                                                                            : bool
    {
        $pass = parent::passThroughFilter($record, $filter);

        $value = $record->getRecordFieldValue($this->getField()->getId());
        if (!$filter || strpos(strtolower($value), strtolower($filter)) !== false) {
            $pass = true;
        }

        return $pass;
    }

Here is the call graph for this function:

---

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

• Modules/DataCollection/classes/Fields/Text/class.ilDclTextFieldRepresentation.php