Class ilDclBaseFieldRepresentation. 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 ($value, $link=true)

	getInputField (ilPropertyFormGUI $form, $record_id=0)
	Returns field-input. More...

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

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

	getField ()
	Return BaseFieldModel. More...

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

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

	getFilterInputFieldValue ( $input)

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

Protected Attributes
	$field

	$lng

	$ctrl

Detailed Description

Class ilDclBaseFieldRepresentation.

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

Constructor & Destructor Documentation

◆ __construct()

ilDclBaseFieldRepresentation::__construct ( ilDclBaseFieldModel $field )

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

                                                                {
                global $DIC;
                $lng = $DIC['lng'];
                $ilCtrl = $DIC['ilCtrl'];
                $this->field = $field;
                $this->lng = $lng;
                $this->ctrl = $ilCtrl;
        }

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

Member Function Documentation

◆ addFieldCreationForm()

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

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

Parameters

	$form
ilObjDataCollection	$dcl
string	$mode

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

                                                                                                {
                $opt = $this->buildFieldCreationInput($dcl, $mode);
 
                if($mode != 'create' && $this->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
                        
                        $new_plugin_title = $opt->getTitle();
                        $plugin_name = ilDclFieldFactory::getPluginNameFromFieldModel($this->getField());
                        if($plugin_name !== "DclBase") {
                                $new_plugin_title .= ': '.$plugin_name;
                        }
                        $opt->setTitle($new_plugin_title);
                }
 
                $form->addOption($opt);
        }

References buildFieldCreationInput(), getField(), ilDclFieldFactory\getPluginNameFromFieldModel(), and ilDclDatatype\INPUTFORMAT_PLUGIN.

Here is the call graph for this function:

◆ addFilterInputFieldToTable()

ilDclBaseFieldRepresentation::addFilterInputFieldToTable ( ilTable2GUI $table )

Add filter input to TableGUI.

Parameters

ilTable2GUI $table

Returns: null

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

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

                                                                       {
                return null;
        }

◆ buildFieldCreationInput()

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

protected

Build the creation-input-field.

Parameters

ilObjDataCollection	$dcl
string	$mode

Returns: ilPropertyFormGUI

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

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

                                                                                               {
                $opt = new ilRadioOption($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle()), $this->getField()->getDatatypeId());
                $opt->setInfo($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle(). '_desc'));
 
                return $opt;
        }

Referenced by addFieldCreationForm().

Here is the caller graph for this function:

◆ getField()

ilDclBaseFieldRepresentation::getField ( )

Return BaseFieldModel.

Returns: ilDclBaseFieldModel

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

                                   {
                return $this->field;
        }

References $field.

Here is the caller graph for this function:

◆ getFilterInputFieldValue()

ilDclBaseFieldRepresentation::getFilterInputFieldValue ( $input )

protected

Parameters

$input

Returns: null

Definition at line 120 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;
        }

Referenced by ilDclBooleanFieldRepresentation\addFilterInputFieldToTable(), ilDclDatetimeFieldRepresentation\addFilterInputFieldToTable(), ilDclFileuploadFieldRepresentation\addFilterInputFieldToTable(), ilDclIliasReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclMobFieldRepresentation\addFilterInputFieldToTable(), ilDclNumberFieldRepresentation\addFilterInputFieldToTable(), ilDclRatingFieldRepresentation\addFilterInputFieldToTable(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), and ilDclTextFieldRepresentation\addFilterInputFieldToTable().

Here is the caller graph for this function:

◆ getInputField()

ilDclBaseFieldRepresentation::getInputField	(	ilPropertyFormGUI	$form,
			$record_id = `0`
	)

Returns field-input.

Parameters

ilPropertyFormGUI	$form
int	$record_id

Returns: null

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

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

                                                                               {
                return null;
        }

◆ getPropertyInputFieldId()

ilDclBaseFieldRepresentation::getPropertyInputFieldId ( $property )

Return post-var for property-fields.

Parameters

$property

Returns: string

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

                                                           {
                return "prop_".$property;
        }

◆ parseSortingValue()

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

Parameters

	$value
bool	$link

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

ilDclBaseRecordModel	$record
	$filter

Returns: bool

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

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

                                                                                 {
                $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 $pass, getField(), and ilDclBaseRecordModel\getRecordFieldValue().

Here is the call graph for this function:

◆ setupFilterInputField()

ilDclBaseFieldRepresentation::setupFilterInputField ( ilFormPropertyGUI $input )

protected

Set basic settings for filter-input-gui.

Parameters

ilFormPropertyGUI $input

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

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

References getField(), and ilFormPropertyGUI\setTitle().

Referenced by ilDclBooleanFieldRepresentation\addFilterInputFieldToTable(), ilDclDatetimeFieldRepresentation\addFilterInputFieldToTable(), ilDclFileuploadFieldRepresentation\addFilterInputFieldToTable(), ilDclIliasReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclMobFieldRepresentation\addFilterInputFieldToTable(), ilDclNumberFieldRepresentation\addFilterInputFieldToTable(), ilDclRatingFieldRepresentation\addFilterInputFieldToTable(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), and ilDclTextFieldRepresentation\addFilterInputFieldToTable().

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 109 of file class.ilDclBaseFieldRepresentation.php.

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