ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilAdvancedMDFieldDefinitionDate Class Reference

AMD field type date. More...

+ Inheritance diagram for ilAdvancedMDFieldDefinitionDate:
+ Collaboration diagram for ilAdvancedMDFieldDefinitionDate:

Public Member Functions

 getType ()
 Get type. 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...
 
 getLuceneSearchString ($a_value)
 Get search string in lucene syntax. More...
 
 prepareElementForSearch (ilADTSearchBridge $a_bridge)
 Prepare search form elements. More...
 
- 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 ()
 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...
 

Protected Member Functions

 initADTDefinition ()
 Init adt instance. More...
 
- 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...
 

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...
 
- Protected Attributes inherited from ilAdvancedMDFieldDefinition
 $field_id
 
 $record_id
 
 $import_id
 
 $position
 
 $title
 
 $description
 
 $searchable
 
 $required
 
 $adt_def
 
 $adt
 

Detailed Description

AMD field type date.

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

Member Function Documentation

◆ getLuceneSearchString()

ilAdvancedMDFieldDefinitionDate::getLuceneSearchString (   $a_value)

Get search string in lucene syntax.

Parameters
mixed$a_value
Returns
string

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 85 of file class.ilAdvancedMDFieldDefinitionDate.php.

86 {
87 // see ilADTDateSearchBridgeRange::importFromPost();
88
89 if($a_value["tgl"])
90 {
91 $start = $end = null;
92
93 if($a_value["lower"]["date"])
94 {
95 $start = mktime(12, 0, 0,
96 $a_value["lower"]["date"]["m"],
97 $a_value["lower"]["date"]["d"],
98 $a_value["lower"]["date"]["y"]);
99 }
100 if($a_value["upper"]["date"])
101 {
102 $end = mktime(12, 0, 0,
103 $a_value["upper"]["date"]["m"],
104 $a_value["upper"]["date"]["d"],
105 $a_value["upper"]["date"]["y"]);
106 }
107
108 if($start && $end && $start > $end)
109 {
110 $tmp = $start;
111 $start = $end;
112 $end = $tmp;
113 }
114
115 $start = new ilDate($start, IL_CAL_UNIX);
116 $end = new ilDate($end, IL_CAL_UNIX);
117
118 return "{".$start->get(IL_CAL_DATE)." TO ".$end->get(IL_CAL_DATE)."}";
119 }
120 }
const IL_CAL_DATE
const IL_CAL_UNIX
Class for single dates.

References IL_CAL_DATE, and IL_CAL_UNIX.

◆ getType()

ilAdvancedMDFieldDefinitionDate::getType ( )

Get type.

Returns
int

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 20 of file class.ilAdvancedMDFieldDefinitionDate.php.

References ilAdvancedMDFieldDefinition\TYPE_DATE.

◆ getValueForXML()

ilAdvancedMDFieldDefinitionDate::getValueForXML ( ilADT  $element)

Parse ADT value for xml (export)

Parameters
ilADT$element
Returns
string

Reimplemented from ilAdvancedMDFieldDefinition.

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

41 {
42 return $element->getDate()->get(IL_CAL_DATE);
43 }

References IL_CAL_DATE.

◆ importFromECS()

ilAdvancedMDFieldDefinitionDate::importFromECS (   $a_ecs_type,
  $a_value,
  $a_sub_id 
)

Import meta data from ECS.

Parameters
int$a_ecs_type
mixed$a_value
string$a_sub_id
Returns
bool

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 50 of file class.ilAdvancedMDFieldDefinitionDate.php.

51 {
52 switch($a_ecs_type)
53 {
55 if($a_value instanceof ilECSTimePlace)
56 {
57 $value = new ilDate($a_value->{'getUT'.ucfirst($a_sub_id)}(), IL_CAL_UNIX);
58 }
59 break;
60 }
61
62 if($value instanceof ilDate)
63 {
64 $this->getADT()->setDate($value);
65 return true;
66 }
67 return false;
68 }
Representation of ECS EContent Time Place.
const TYPE_TIMEPLACE

References IL_CAL_UNIX, and ilECSUtils\TYPE_TIMEPLACE.

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionDate::importValueFromXML (   $a_cdata)

Import value from xml.

Parameters
string$a_cdata

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 45 of file class.ilAdvancedMDFieldDefinitionDate.php.

46 {
47 $this->getADT()->setDate(new ilDate($a_cdata, IL_CAL_DATE));
48 }

References ilAdvancedMDFieldDefinition\getADT(), and IL_CAL_DATE.

+ Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionDate::initADTDefinition ( )
protected

Init adt instance.

Returns
ilADTDefinition

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 30 of file class.ilAdvancedMDFieldDefinitionDate.php.

31 {
32 return ilADTFactory::getInstance()->getDefinitionInstanceByType("Date");
33 }
static getInstance()
Get singleton.

References ilADTFactory\getInstance().

+ Here is the call graph for this function:

◆ prepareElementForEditor()

ilAdvancedMDFieldDefinitionDate::prepareElementForEditor ( ilADTFormBridge  $a_bridge)

Prepare editor form elements.

Parameters
ilADTFormBridge$a_bridge

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 75 of file class.ilAdvancedMDFieldDefinitionDate.php.

76 {
77 $a_bridge->setTextInputMode(true);
78 }

◆ prepareElementForSearch()

ilAdvancedMDFieldDefinitionDate::prepareElementForSearch ( ilADTSearchBridge  $a_bridge)

Prepare search form elements.

Parameters
ilADTSearchBridge$a_bridge

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 122 of file class.ilAdvancedMDFieldDefinitionDate.php.

123 {
124 $a_bridge->setTextInputMode(true);
125 }

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