ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
Public Member Functions | Protected Member Functions | Protected Attributes
ilDclBaseFieldRepresentation Class Reference

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.

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

25  {
26  global $DIC;
27  $lng = $DIC['lng'];
28  $ilCtrl = $DIC['ilCtrl'];
29  $this->field = $field;
30  $this->lng = $lng;
31  $this->ctrl = $ilCtrl;
32  }
$DIC
global $DIC
Definition: saml.php:7
$ilCtrl
global $ilCtrl
Definition: ilias.php:18

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

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

151  {
152  $opt = $this->buildFieldCreationInput($dcl, $mode);
153 
154  if ($mode != 'create' && $this->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
155  $new_plugin_title = $opt->getTitle();
156  $plugin_name = ilDclFieldFactory::getPluginNameFromFieldModel($this->getField());
157  if ($plugin_name !== "DclBase") {
158  $new_plugin_title .= ': ' . $plugin_name;
159  }
160  $opt->setTitle($new_plugin_title);
161  }
162 
163  $form->addOption($opt);
164  }
ilDclBaseFieldRepresentation\buildFieldCreationInput
buildFieldCreationInput(ilObjDataCollection $dcl, $mode='create')
Build the creation-input-field.
Definition: class.ilDclBaseFieldRepresentation.php:175
$form
if(isset($_POST['submit'])) $form
Definition: registry.edit.php:63
ilDclFieldFactory\getPluginNameFromFieldModel
static getPluginNameFromFieldModel(ilDclBaseFieldModel $object)
Get plugin-name from FieldModel.
Definition: class.ilDclFieldFactory.php:434
+ Here is the call graph for this function:

◆ addFilterInputFieldToTable()

ilDclBaseFieldRepresentation::addFilterInputFieldToTable ( ilTable2GUI  $table)

Add filter input to TableGUI.

Parameters
ilTable2GUI$table
Returns
null

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

42  {
43  return null;
44  }

◆ buildFieldCreationInput()

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

Build the creation-input-field.

Parameters
ilObjDataCollection$dcl
string$mode
Returns
ilPropertyFormGUI

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

References getField(), and ilRadioOption\setInfo().

Referenced by addFieldCreationForm().

176  {
177  $opt = new ilRadioOption($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle()), $this->getField()->getDatatypeId());
178  $opt->setInfo($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle() . '_desc'));
179 
180  return $opt;
181  }
ilRadioOption
This class represents an option in a radio group.
Definition: class.ilRadioOption.php:31
ilRadioOption\setInfo
setInfo($a_info)
Set Info.
Definition: class.ilRadioOption.php:71
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getField()

ilDclBaseFieldRepresentation::getField ( )

Return BaseFieldModel.

Returns
ilDclBaseFieldModel

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

References $field.

Referenced by addFieldCreationForm(), ilDclTextFieldRepresentation\addFilterInputFieldToTable(), ilDclDatetimeFieldRepresentation\addFilterInputFieldToTable(), ilDclBooleanFieldRepresentation\addFilterInputFieldToTable(), ilDclIliasReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclNumberFieldRepresentation\addFilterInputFieldToTable(), ilDclRatingFieldRepresentation\addFilterInputFieldToTable(), ilDclMobFieldRepresentation\addFilterInputFieldToTable(), ilDclFileuploadFieldRepresentation\addFilterInputFieldToTable(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), ilDclSelectionFieldRepresentation\addFilterInputFieldToTable(), ilDclSelectionFieldRepresentation\buildFieldCreationInput(), ilDclMobFieldRepresentation\buildFieldCreationInput(), buildFieldCreationInput(), ilDclDatetimeFieldRepresentation\getInputField(), ilDclMobFieldRepresentation\getInputField(), ilDclBooleanFieldRepresentation\getInputField(), ilDclNumberFieldRepresentation\getInputField(), ilDclRatingFieldRepresentation\getInputField(), ilDclFormulaFieldRepresentation\getInputField(), ilDclIliasReferenceFieldRepresentation\getInputField(), ilDclReferenceFieldRepresentation\getInputField(), ilDclFileuploadFieldRepresentation\getInputField(), ilDclTextFieldRepresentation\getInputField(), ilDclTextFieldRepresentation\passThroughFilter(), ilDclDatetimeFieldRepresentation\passThroughFilter(), ilDclIliasReferenceFieldRepresentation\passThroughFilter(), ilDclNumberFieldRepresentation\passThroughFilter(), ilDclMobFieldRepresentation\passThroughFilter(), ilDclRatingFieldRepresentation\passThroughFilter(), ilDclBooleanFieldRepresentation\passThroughFilter(), ilDclFileuploadFieldRepresentation\passThroughFilter(), passThroughFilter(), ilDclReferenceFieldRepresentation\passThroughFilter(), ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField(), and setupFilterInputField().

200  {
201  return $this->field;
202  }
+ Here is the caller graph for this function:

◆ getFilterInputFieldValue()

ilDclBaseFieldRepresentation::getFilterInputFieldValue (   $input)
protected
Parameters
$input
Returns
null

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

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

128  {
129  $value = $input->getValue();
130  if (is_array($value)) {
131  if ($value['from'] || $value['to']) {
132  return $value;
133  }
134  } else {
135  if ($value != '') {
136  return $value;
137  }
138  }
139  return null;
140  }
+ 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

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

Referenced by ilDclSelectionFieldRepresentation\buildFieldCreationInput().

105  {
106  return null;
107  }
+ Here is the caller graph for this function:

◆ getPropertyInputFieldId()

ilDclBaseFieldRepresentation::getPropertyInputFieldId (   $property)

Return post-var for property-fields.

Parameters
$property
Returns
string

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

Referenced by ilDclTextFieldRepresentation\buildFieldCreationInput().

190  {
191  return "prop_" . $property;
192  }
+ Here is the caller graph for this function:

◆ parseSortingValue()

ilDclBaseFieldRepresentation::parseSortingValue (   $value,
  $link = true 
)
Parameters
$value
bool$link
Returns
mixed

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

92  {
93  return $value;
94  }

◆ passThroughFilter()

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

Checks if a filter affects a record.

Parameters
ilDclBaseRecordModel$record
$filter
Returns
bool

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

References $pass, getField(), and ilDclBaseRecordModel\getRecordFieldValue().

68  {
69  $value = $record->getRecordFieldValue($this->getField()->getId());
70  $pass = true;
71 
72  if (($this->getField()->getId() == "owner" || $this->getField()->getId() == "last_edit_by") && $filter) {
73  $pass = false;
74  $user = new ilObjUser($value);
75  if (strpos($user->getFullname(), $filter) !== false) {
76  $pass = true;
77  }
78  }
79 
80  return $pass;
81  }
ilDclBaseRecordModel\getRecordFieldValue
getRecordFieldValue($field_id)
Get Field Value.
Definition: class.ilDclBaseRecordModel.php:422
+ 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 51 of file class.ilDclBaseFieldRepresentation.php.

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

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

52  {
53  if ($input != null) {
54  $input->setTitle($this->getField()->getTitle());
55  }
56  }
ilFormPropertyGUI\setTitle
setTitle($a_title)
Set Title.
Definition: class.ilFormPropertyGUI.php:92
+ 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 115 of file class.ilDclBaseFieldRepresentation.php.

References ilDclBaseFieldModel\getDescription(), ilFormPropertyGUI\getInfo(), ilDclBaseFieldModel\getRequired(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by ilDclSelectionFieldRepresentation\buildFieldCreationInput(), ilDclDatetimeFieldRepresentation\getInputField(), ilDclBooleanFieldRepresentation\getInputField(), ilDclNumberFieldRepresentation\getInputField(), ilDclRatingFieldRepresentation\getInputField(), ilDclIliasReferenceFieldRepresentation\getInputField(), ilDclReferenceFieldRepresentation\getInputField(), ilDclTextFieldRepresentation\getInputField(), and ilDclFileuploadFieldRepresentation\requiredWorkaroundForInputField().

116  {
117  $input->setRequired($field->getRequired());
118  $input->setInfo($field->getDescription() . ($input->getInfo() ? '<br>' . $input->getInfo() : ''));
119  }
ilFormPropertyGUI\setInfo
setInfo($a_info)
Set Information Text.
Definition: class.ilFormPropertyGUI.php:145
ilDclBaseFieldModel\getRequired
getRequired()
Get Required Required.
Definition: class.ilDclBaseFieldModel.php:287
ilDclBaseFieldModel\getDescription
getDescription()
Get description.
Definition: class.ilDclBaseFieldModel.php:237
ilFormPropertyGUI\getInfo
getInfo()
Get Information Text.
Definition: class.ilFormPropertyGUI.php:155
ilFormPropertyGUI\setRequired
setRequired($a_required)
Set Required.
Definition: class.ilFormPropertyGUI.php:185
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilDclBaseFieldRepresentation::$ctrl
protected

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

◆ $field

ilDclBaseFieldRepresentation::$field
protected

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

Referenced by __construct(), ilDclReferenceFieldRepresentation\buildFieldCreationInput(), and getField().

◆ $lng

ilDclBaseFieldRepresentation::$lng
protected

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

Referenced by __construct().

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