ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilAdvancedMDFieldDefinitionInteger Class Reference

AMD field type integer. More...

+ Inheritance diagram for ilAdvancedMDFieldDefinitionInteger:
+ Collaboration diagram for ilAdvancedMDFieldDefinitionInteger:

Public Member Functions

 getType ()
 
 isFilterSupported ()
 
 setMin ($a_value)
 Set min. More...
 
 getMin ()
 Get min. More...
 
 setMax ($a_value)
 Set max. More...
 
 getMax ()
 Get max. More...
 
 setSuffix ($a_value)
 Set suffix. More...
 
 getSuffix ()
 Get suffix. More...
 
 getFieldDefinitionForTableGUI ()
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
 Import custom post values from definition form. More...
 
 importXMLProperty ($a_key, $a_value)
 
 getValueForXML (ilADT $element)
 
 importValueFromXML ($a_cdata)
 
- Public Member Functions inherited from ilAdvancedMDFieldDefinition
 __construct ($a_field_id=null)
 Constructor. More...
 
 getType ()
 Get type. More...
 
 getTypeTitle ()
 Get type title (lang id) More...
 
 getADTDefinition ()
 Get ADT definition instance. More...
 
 getADT ()
 Get ADT instance. More...
 
 getFieldId ()
 Get field_id. More...
 
 setRecordId ($a_id)
 Set record id. More...
 
 getRecordId ()
 Get record id. More...
 
 setImportId ($a_id_string)
 Set import id. More...
 
 getImportId ()
 Get import id. More...
 
 setPosition ($a_pos)
 Set position. More...
 
 getPosition ()
 Get position. More...
 
 setTitle ($a_title)
 Get title. More...
 
 getTitle ()
 Get title. More...
 
 setDescription ($a_desc)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 isSearchSupported ()
 Is search supported at all. More...
 
 isFilterSupported ()
 Is search by filter supported. More...
 
 setSearchable ($a_status)
 Toggle searchable. More...
 
 isSearchable ()
 Is searchable. More...
 
 setRequired ($a_status)
 Toggle required. More...
 
 isRequired ()
 Is required field. More...
 
 getFieldDefinitionForTableGUI ()
 Parse properties for table gui. More...
 
 addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
 Add input elements to definition form. More...
 
 importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
 Import custom post values from definition form. More...
 
 importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
 Import post values from definition form. More...
 
 importDefinitionFormPostValuesNeedsConfirmation ()
 
 prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)
 
 generateImportId ($a_field_id)
 Generate unique record id. More...
 
 save ($a_keep_pos=false)
 Create new field entry. More...
 
 update ()
 Update field entry. More...
 
 delete ()
 Delete field entry. More...
 
 toXML (ilXmlWriter $a_writer)
 To Xml. More...
 
 importXMLProperty ($a_key, $a_value)
 Import property from XML. More...
 
 getValueForXML (ilADT $element)
 Parse ADT value for xml (export) More...
 
 importValueFromXML ($a_cdata)
 Import value from xml. More...
 
 importFromECS ($a_ecs_type, $a_value, $a_sub_id)
 Import meta data from ECS. More...
 
 prepareElementForEditor (ilADTFormBridge $a_bridge)
 Prepare editor form elements. More...
 
 getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
 Get value for search query parser. More...
 
 getSearchValueSerialized (ilADTSearchBridge $a_adt_search)
 Get value for search persistence. More...
 
 setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
 Set value from search persistence. More...
 
 searchSubObjects (ilADTSearchBridge $a_adt_search, $a_obj_id, $sub_obj_type)
 
 searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $a_search_type)
 Search objects. More...
 
 getLuceneSearchString ($a_value)
 Get search string in lucene syntax. More...
 
 prepareElementForSearch (ilADTSearchBridge $a_bridge)
 Prepare search form elements. More...
 
 _clone ($a_new_record_id)
 Clone field definition. More...
 

Protected Member Functions

 initADTDefinition ()
 
 importFieldDefinition (array $a_def)
 
 getFieldDefinition ()
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 
- Protected Member Functions inherited from ilAdvancedMDFieldDefinition
 init ()
 Init properties. More...
 
 initADTDefinition ()
 Init adt instance. More...
 
 setADT (ilADT $a_adt)
 Set ADT instance. More...
 
 setFieldId ($a_id)
 Set field_id. More...
 
 importFieldDefinition (array $a_def)
 Import (type-specific) field definition from DB. More...
 
 getFieldDefinition ()
 Get (type-specific) field definition. More...
 
 addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, $a_disabled=false)
 Add custom input elements to definition form. More...
 
 getLastPosition ()
 Get last position of record. More...
 
 getDBProperties ()
 Get all definition properties for DB. More...
 
 import (array $a_data)
 Import from DB. More...
 
 read ($a_field_id)
 Read field definition. More...
 
 addPropertiesToXML (ilXmlWriter $a_writer)
 Add (type-specific) properties to xml export. More...
 
 parseSearchObjects (array $a_records, array $a_object_types)
 Add object-data needed for global search to AMD search results. More...
 

Protected Attributes

 $min
 
 $max
 
 $suffix
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinition
 $field_id
 
 $record_id
 
 $import_id
 
 $position
 
 $title
 
 $description
 
 $searchable
 
 $required
 
 $adt_def
 
 $adt
 

Additional Inherited Members

- Static Public Member Functions inherited from ilAdvancedMDFieldDefinition
static getInstance ($a_field_id, $a_type=null)
 Get definition instance by type. More...
 
static getInstanceByTypeString ($a_type)
 Get instance by type string (used by import) More...
 
static getInstancesByRecordId ($a_record_id, $a_only_searchable=false)
 Get definitions by record id. More...
 
static getInstancesByObjType ($a_obj_type, $a_active_only=true)
 
static getInstanceByImportId ($a_import_id)
 Get definition instance by import id. More...
 
static getSearchableDefinitionIds ()
 Get searchable definition ids (performance is key) More...
 
static getADTGroupForDefinitions (array $a_defs)
 Init ADTGroup for definitions. More...
 
static getValidTypes ()
 Get all valid types. More...
 
static isValidType ($a_type)
 Is given type valid. More...
 
- Data Fields inherited from ilAdvancedMDFieldDefinition
const TYPE_SELECT = 1
 
const TYPE_TEXT = 2
 
const TYPE_DATE = 3
 
const TYPE_DATETIME = 4
 
const TYPE_INTEGER = 5
 
const TYPE_FLOAT = 6
 
const TYPE_LOCATION = 7
 
const TYPE_SELECT_MULTI = 8
 
- Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static getTypeString ($a_type)
 Get type string. More...
 

Detailed Description

AMD field type integer.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

Definition at line 14 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionInteger::addCustomFieldToDefinitionForm ( ilPropertyFormGUI  $a_form,
  $a_disabled = false 
)

Add input elements to definition form.

Parameters
ilPropertyFormGUI$a_form
bool$a_disabled

Definition at line 176 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $lng, $max, $min, $suffix, ilPropertyFormGUI\addItem(), getMax(), getMin(), and getSuffix().

177  {
178  global $lng;
179 
180  $min = new ilNumberInputGUI($lng->txt("md_adv_number_min"), "min");
181  $min->setValue($this->getMin());
182  $min->setSize(10);
183  $a_form->addItem($min);
184 
185  $max = new ilNumberInputGUI($lng->txt("md_adv_number_max"), "max");
186  $max->setValue($this->getMax());
187  $max->setSize(10);
188  $a_form->addItem($max);
189 
190  $suffix = new ilTextInputGUI($lng->txt("md_adv_number_suffix"), "suffix");
191  $suffix->setValue($this->getSuffix());
192  $suffix->setSize(10);
193  $a_form->addItem($suffix);
194 
195  if($a_disabled)
196  {
197  $min->setDisabled(true);
198  $max->setDisabled(true);
199  $suffix->setDisabled(true);
200  }
201  }
addItem($a_item)
Add Item (Property, SectionHeader).
This class represents a number property in a property form.
This class represents a text property in a property form.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionInteger::addPropertiesToXML ( ilXmlWriter  $a_writer)
protected

Definition at line 225 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References array, getMax(), getMin(), getSuffix(), and ilXmlWriter\xmlElement().

226  {
227  $a_writer->xmlElement('FieldValue',array("id"=>"min"),$this->getMin());
228  $a_writer->xmlElement('FieldValue',array("id"=>"max"),$this->getMax());
229  $a_writer->xmlElement('FieldValue',array("id"=>"suffix"),$this->getSuffix());
230  }
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)
Create styles array
The data for the language used.
+ Here is the call graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinition ( )
protected

Definition at line 139 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References array, getMax(), getMin(), and getSuffix().

140  {
141  return array(
142  "min" => $this->getMin(),
143  "max" => $this->getMax(),
144  "suffix" => $this->getSuffix()
145  );
146  }
Create styles array
The data for the language used.
+ Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinitionForTableGUI ( )

Definition at line 148 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $lng, $res, array, getMax(), getMin(), and getSuffix().

149  {
150  global $lng;
151 
152  $res = array();
153 
154  if($this->getMin() !== null)
155  {
156  $res[$lng->txt("md_adv_number_min")] = $this->getMin();
157  }
158  if($this->getMax() !== null)
159  {
160  $res[$lng->txt("md_adv_number_max")] = $this->getMax();
161  }
162  if($this->getSuffix())
163  {
164  $res[$lng->txt("md_adv_number_suffix")] = $this->getSuffix();
165  }
166 
167  return $res;
168  }
Create styles array
The data for the language used.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ getMax()

ilAdvancedMDFieldDefinitionInteger::getMax ( )

◆ getMin()

ilAdvancedMDFieldDefinitionInteger::getMin ( )

◆ getSuffix()

ilAdvancedMDFieldDefinitionInteger::getSuffix ( )

◆ getType()

ilAdvancedMDFieldDefinitionInteger::getType ( )

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

25  {
26  return self::TYPE_INTEGER;
27  }

◆ getValueForXML()

ilAdvancedMDFieldDefinitionInteger::getValueForXML ( ilADT  $element)

Definition at line 248 of file class.ilAdvancedMDFieldDefinitionInteger.php.

249  {
250  return $element->getNumber();
251  }

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionInteger::importCustomDefinitionFormPostValues ( ilPropertyFormGUI  $a_form)

Import custom post values from definition form.

Parameters
ilPropertyFormGUI$a_form

Definition at line 208 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References $max, $min, $suffix, ilPropertyFormGUI\getInput(), setMax(), setMin(), and setSuffix().

209  {
210  $min = $a_form->getInput("min");
211  $this->setMin(($min !== "") ? $min : null);
212 
213  $max = $a_form->getInput("max");
214  $this->setMax(($max !== "") ? $max : null);
215 
216  $suffix = $a_form->getInput("suffix");
217  $this->setSuffix(($suffix !== "") ? $suffix : null);
218  }
getInput($a_post_var, $ensureValidation=true)
Returns the value of a HTTP-POST variable, identified by the passed id.
+ Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::importFieldDefinition ( array  $a_def)
protected

Definition at line 132 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References setMax(), setMin(), and setSuffix().

133  {
134  $this->setMin($a_def["min"]);
135  $this->setMax($a_def["max"]);
136  $this->setSuffix($a_def["suffix"]);
137  }
+ Here is the call graph for this function:

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionInteger::importValueFromXML (   $a_cdata)

Definition at line 253 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References ilAdvancedMDFieldDefinition\getADT().

254  {
255  $this->getADT()->setNumber($a_cdata);
256  }
+ Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionInteger::importXMLProperty (   $a_key,
  $a_value 
)

Definition at line 232 of file class.ilAdvancedMDFieldDefinitionInteger.php.

References setMax(), setMin(), and setSuffix().

233  {
234  if($a_key == "min")
235  {
236  $this->setMin($a_value != "" ? $a_value : null);
237  }
238  if($a_key == "max")
239  {
240  $this->setMax($a_value != "" ? $a_value : null);
241  }
242  if($a_key == "suffix")
243  {
244  $this->setSuffix($a_value != "" ? $a_value : null);
245  }
246  }
+ Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionInteger::initADTDefinition ( )
protected

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

References ilADTFactory\getInstance(), getMax(), getMin(), and getSuffix().

40  {
41  $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Integer");
42 
43  $def->setMin($this->getMin());
44  $def->setMax($this->getMax());
45  $def->setSuffix($this->getSuffix());
46 
47  return $def;
48  }
static getInstance()
Get singleton.
+ Here is the call graph for this function:

◆ isFilterSupported()

ilAdvancedMDFieldDefinitionInteger::isFilterSupported ( )

Definition at line 29 of file class.ilAdvancedMDFieldDefinitionInteger.php.

30  {
31  return false;
32  }

◆ setMax()

ilAdvancedMDFieldDefinitionInteger::setMax (   $a_value)

Set max.

Parameters
int$a_value

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

Referenced by importCustomDefinitionFormPostValues(), importFieldDefinition(), and importXMLProperty().

85  {
86  if($a_value !== null)
87  {
88  $a_value = (int)$a_value;
89  }
90  $this->max = $a_value;
91  }
+ Here is the caller graph for this function:

◆ setMin()

ilAdvancedMDFieldDefinitionInteger::setMin (   $a_value)

Set min.

Parameters
int$a_value

Definition at line 60 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Referenced by importCustomDefinitionFormPostValues(), importFieldDefinition(), and importXMLProperty().

61  {
62  if($a_value !== null)
63  {
64  $a_value = (int)$a_value;
65  }
66  $this->min = $a_value;
67  }
+ Here is the caller graph for this function:

◆ setSuffix()

ilAdvancedMDFieldDefinitionInteger::setSuffix (   $a_value)

Set suffix.

Parameters
string$a_value

Definition at line 108 of file class.ilAdvancedMDFieldDefinitionInteger.php.

Referenced by importCustomDefinitionFormPostValues(), importFieldDefinition(), and importXMLProperty().

109  {
110  if($a_value !== null)
111  {
112  $a_value = trim($a_value);
113  }
114  $this->suffix = $a_value;
115  }
+ Here is the caller graph for this function:

Field Documentation

◆ $max

ilAdvancedMDFieldDefinitionInteger::$max
protected

◆ $min

ilAdvancedMDFieldDefinitionInteger::$min
protected

◆ $suffix

ilAdvancedMDFieldDefinitionInteger::$suffix
protected

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