ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilADTTextFormBridge Class Reference
+ Inheritance diagram for ilADTTextFormBridge:
+ Collaboration diagram for ilADTTextFormBridge:

Public Member Functions

 setMulti ($a_value, $a_cols=null, $a_rows=null)
 Set multi-line. More...
 
 isMulti ()
 Is multi-line? More...
 
 addToForm ()
 
 importFromPost ()
 
- Public Member Functions inherited from ilADTFormBridge
 __construct (ilADT $a_adt)
 Constructor. More...
 
 getADT ()
 Get ADT. More...
 
 setForm (ilPropertyFormGUI $a_form)
 Set form. More...
 
 getForm ()
 Get form. More...
 
 setElementId ($a_value)
 Set element id (aka form field) More...
 
 getElementId ()
 Get element id. More...
 
 setTitle ($a_value)
 Set title (aka form field caption) More...
 
 getTitle ()
 Get title. More...
 
 setInfo ($a_value)
 Set info (aka form field info text) More...
 
 getInfo ()
 Get info. More...
 
 setParentElement ($a_value)
 Set parent element. More...
 
 getParentElement ()
 Get parent element. More...
 
 setDisabled ($a_value)
 Set disabled. More...
 
 isDisabled ()
 Get disabled. More...
 
 setRequired ($a_value)
 Set required. More...
 
 isRequired ()
 Get required. More...
 
 addToForm ()
 Add ADT-specific fields to form. More...
 
 addJS (ilTemplate $a_tpl)
 Add ADT-specific JS-files to template. More...
 
 shouldBeImportedFromPost (ilADTFormBridge $a_parent_adt=null)
 Check if incoming values should be imported at all. More...
 
 importFromPost ()
 Import values from form request POST data. More...
 
 validate ()
 Validate ADT and parse error codes. More...
 
 setExternalErrors ($a_errors)
 

Protected Member Functions

 isValidADT (ilADT $a_adt)
 
- Protected Member Functions inherited from ilADTFormBridge
 isValidADT (ilADT $a_adt)
 Check if given ADT is valid. More...
 
 setADT (ilADT $a_adt)
 Set ADT. More...
 
 addBasicFieldProperties (ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
 Helper method to handle generic properties like setRequired(), setInfo() More...
 
 findParentElementInForm ()
 Try to find parent element in form (could be option) More...
 
 addToParentElement (ilFormPropertyGUI $a_field)
 Add form field to parent element. More...
 
 isActiveForSubItems ($a_parent_option=null)
 Check if element is currently active for subitem(s) More...
 

Protected Attributes

 $multi
 
 $multi_rows
 
 $multi_cols
 
- Protected Attributes inherited from ilADTFormBridge
 $adt
 
 $form
 
 $id
 
 $title
 
 $info
 
 $parent_element
 
 $required
 
 $disabled
 

Detailed Description

Definition at line 5 of file class.ilADTTextFormBridge.php.

Member Function Documentation

◆ addToForm()

ilADTTextFormBridge::addToForm ( )

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

References $size, ilADTFormBridge\addBasicFieldProperties(), ilADTFormBridge\addToParentElement(), ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), ilADTFormBridge\getTitle(), and isMulti().

50  {
51  $def = $this->getADT()->getCopyOfDefinition();
52 
53  if(!$this->isMulti())
54  {
55  $text = new ilTextInputGUI($this->getTitle(), $this->getElementId());
56 
57  if($def->getMaxLength())
58  {
59  $max = $def->getMaxLength();
60  $size = $text->getSize();
61 
62  $text->setMaxLength($max);
63 
64  if($size && $max < $size)
65  {
66  $text->setSize($max);
67  }
68  }
69 
70  }
71  else
72  {
73  $text = new ilTextAreaInputGUI($this->getTitle(), $this->getElementId());
74  if($this->multi_rows)
75  {
76  $text->setRows($this->multi_rows);
77  }
78  if($this->multi_cols)
79  {
80  $text->setCols($this->multi_cols);
81  }
82  }
83 
84  $this->addBasicFieldProperties($text, $def);
85 
86  $text->setValue($this->getADT()->getText());
87 
88  $this->addToParentElement($text);
89  }
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
$size
Definition: RandomTest.php:79
addBasicFieldProperties(ilFormPropertyGUI $a_field, ilADTDefinition $a_def)
Helper method to handle generic properties like setRequired(), setInfo()
This class represents a text property in a property form.
getElementId()
Get element id.
This class represents a text area property in a property form.
+ Here is the call graph for this function:

◆ importFromPost()

ilADTTextFormBridge::importFromPost ( )

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

References ilADTFormBridge\getADT(), ilADTFormBridge\getElementId(), and ilADTFormBridge\getForm().

92  {
93  // ilPropertyFormGUI::checkInput() is pre-requisite
94  $this->getADT()->setText($this->getForm()->getInput($this->getElementId()));
95 
96  $field = $this->getForm()->getItemByPostvar($this->getElementId());
97  $field->setValue($this->getADT()->getText());
98  }
getElementId()
Get element id.
+ Here is the call graph for this function:

◆ isMulti()

ilADTTextFormBridge::isMulti ( )

Is multi-line?

Returns
bool

Definition at line 34 of file class.ilADTTextFormBridge.php.

References $multi.

Referenced by addToForm().

35  {
36  return $this->multi;
37  }
+ Here is the caller graph for this function:

◆ isValidADT()

ilADTTextFormBridge::isValidADT ( ilADT  $a_adt)
protected

Definition at line 44 of file class.ilADTTextFormBridge.php.

45  {
46  return ($a_adt instanceof ilADTText);
47  }

◆ setMulti()

ilADTTextFormBridge::setMulti (   $a_value,
  $a_cols = null,
  $a_rows = null 
)

Set multi-line.

Parameters
string$a_value
int$a_cols
int$a_rows

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

Referenced by ilAdvancedMDFieldDefinitionText\prepareElementForEditor().

23  {
24  $this->multi = (bool)$a_value;
25  $this->multi_rows = ($a_rows === null) ? null : (int)$a_rows;
26  $this->multi_cols = ($a_cols === null) ? null : (int)$a_cols;
27  }
+ Here is the caller graph for this function:

Field Documentation

◆ $multi

ilADTTextFormBridge::$multi
protected

Definition at line 7 of file class.ilADTTextFormBridge.php.

Referenced by isMulti().

◆ $multi_cols

ilADTTextFormBridge::$multi_cols
protected

Definition at line 9 of file class.ilADTTextFormBridge.php.

◆ $multi_rows

ilADTTextFormBridge::$multi_rows
protected

Definition at line 8 of file class.ilADTTextFormBridge.php.


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