AMD field type date time. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionDateTime:

Collaboration diagram for ilAdvancedMDFieldDefinitionDateTime:

Public Member Functions

getType ()

Get type. More...

getValueForXML (ilADT $element)

Parse ADT value for xml (export) More...

importValueFromXML (string $a_cdata)

Import value from xml. More...

importFromECS (string $a_ecs_type, $a_value, string $a_sub_id)

Import meta data from ECS. More...

getLuceneSearchString ($a_value)

Get search string in lucene syntax.

Parameters

string | array

Returns

Todo:: with php 8 support change parameter to union type

More...

Public Member Functions inherited from ilAdvancedMDFieldDefinition

__construct (GenericData $generic_data, string $language='')

getType ()

Get type. More...

useDefaultLanguageMode (string $language)

Check if default language mode has to be used: no language given or language equals default language. More...

getTypeTitle ()

getADTDefinition ()

Get ADT definition instance. More...

getADT ()

getFieldId ()

Get field_id. More...

setRecordId (int $a_id)

Set record id. More...

getRecordId ()

Get record id. More...

setImportId (string $a_id_string)

Set import id. More...

getImportId ()

Get import id. More...

setPosition (int $a_pos)

Set position. More...

getPosition ()

Get position. More...

setTitle (string $a_title)

Get title. More...

getTitle ()

Get title. More...

setDescription (string $a_desc)

Set description. More...

getDescription ()

Get description. More...

isSearchSupported ()

Is search supported at all. More...

isFilterSupported ()

Is search by filter supported. More...

setSearchable (bool $a_status)

Toggle searchable. More...

isSearchable ()

Is searchable. More...

setRequired (bool $a_status)

Toggle required. More...

isRequired ()

Is required field. More...

getFieldDefinitionForTableGUI (string $content_language)

Parse properties for table gui. More...

addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $language='')

Add input elements to definition form. More...

importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form, string $language='')

Import custom post values from definition form. More...

importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions, string $active_language)

Import post values from definition form. More...

importDefinitionFormPostValuesNeedsConfirmation ()

prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

generateImportId (int $a_field_id)

Generate unique record id. More...

save (bool $keep_pos_and_import_id=false, bool $keep_import_id=false)

Create new field entry. More...

update ()

Update field entry. More...

delete ()

Delete field entry. More...

toXML (ilXmlWriter $a_writer)

To Xml. More...

importXMLProperty (string $a_key, string $a_value)

Import property from XML. More...

getValueForXML (ilADT $element)

Parse ADT value for xml (export) More...

importValueFromXML (string $a_cdata)

Import value from xml. More...

importFromECS (string $a_ecs_type, $a_value, string $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)

setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)

Set value from search persistence. More...

searchSubObjects (ilADTSearchBridge $a_adt_search, int $a_obj_id, string $sub_obj_type)

searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, string $a_locate, string $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 (int $a_new_record_id)

Clone field definition. More...

hasComplexOptions ()

getComplexOptionsOverview (object $a_parent_gui, string $parent_cmd)

Protected Member Functions
	initADTDefinition ()
	Init adt instance. More...

Protected Member Functions inherited from ilAdvancedMDFieldDefinition
	initADTDefinition ()
	Init adt instance. More...

	setADT (ilADT $a_adt)
	Set ADT instance. More...

	importFieldDefinition (array $a_def)
	Import (type-specific) field definition from DB. More...

	getFieldDefinition ()
	Get (type-specific) field definition. More...

	addCustomFieldToDefinitionForm (ilPropertyFormGUI $a_form, bool $a_disabled=false, string $language='')
	Add custom input elements to definition form. 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 (?int $a_field_id, ?int $a_type=null, string $language='')

static	exists (int $a_field_id)

static	getInstanceByTypeString (string $a_type)
	Get instance by type string (used by import) More...

static	getInstancesByRecordId ( $a_record_id, $a_only_searchable=false, string $language='')
	Get definitions by record id. More...

static	getInstancesByObjType ($a_obj_type, $a_active_only=true)

static	getInstanceByImportId (string $a_import_id)

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 (int $a_type)

Data Fields inherited from ilAdvancedMDFieldDefinition
const	TYPE_SELECT = 1
	TODO: put this in when minimum php version is set to 8.2. More...

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

const	TYPE_ADDRESS = 99

const	TYPE_EXTERNAL_LINK = 9

const	TYPE_INTERNAL_LINK = 10

Static Protected Member Functions inherited from ilAdvancedMDFieldDefinition
static	getInstanceWithData (GenericData $generic_data, string $language='')

static	getTypeString (int $a_type)
	Get type as string. More...

Protected Attributes inherited from ilAdvancedMDFieldDefinition
GenericData	$generic_data

ilADTDefinition	$adt_def = null

ilADT	$adt = null

string	$language = ''

ilDBInterface	$db

ilLanguage	$lng

ilLogger	$logger

GlobalHttpState	$http

RefineryFactory	$refinery

Detailed Description

AMD field type date time.

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 27 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

Member Function Documentation

◆ getLuceneSearchString()

ilAdvancedMDFieldDefinitionDateTime::getLuceneSearchString ( $a_value )

Get search string in lucene syntax.

Parameters

string | array

Returns

Todo:: with php 8 support change parameter to union type

Reimplemented from ilAdvancedMDFieldDefinition.

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

                                                   : string
    {
        $start = new ilDateTime('1970-01-01 00:00:01', IL_CAL_DATETIME, ilTimeZone::UTC);
        $end = new ilDateTime('2038-01-19 00:00:01', IL_CAL_DATETIME, ilTimeZone::UTC);
 
        if (!($a_value['lower'] ?? false) || !($a_value['upper'])) {
            return '';
        }
        if ($a_value['lower'] ?? false) {
            $start = ilCalendarUtil::parseIncomingDate($a_value['lower'], true);
        }
        if ($a_value['upper'] ?? false) {
            $end = ilCalendarUtil::parseIncomingDate($a_value['upper'], true);
        }
        return '[' . $start->get(IL_CAL_FKT_DATE, 'Y-m-d\Th:m') . ' TO ' . $end->get(IL_CAL_FKT_DATE, 'Y-m-d\Th:m') . ']';
    }

References IL_CAL_DATETIME, IL_CAL_FKT_DATE, ilCalendarUtil\parseIncomingDate(), and ilTimeZone\UTC.

Here is the call graph for this function:

◆ getType()

ilAdvancedMDFieldDefinitionDateTime::getType ( )

Get type.

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 33 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

                             : int
    {
        return self::TYPE_DATETIME;
    }

References ilAdvancedMDFieldDefinition\TYPE_DATETIME.

◆ getValueForXML()

ilAdvancedMDFieldDefinitionDateTime::getValueForXML ( ilADT $element )

Parse ADT value for xml (export)

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 53 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

                                                  : string
    {
        return $element->getDate()->get(IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

◆ importFromECS()

ilAdvancedMDFieldDefinitionDateTime::importFromECS	(	string	$a_ecs_type,
			$a_value,
		string	$a_sub_id
	)

Import meta data from ECS.

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 63 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

                                                                                 : bool
    {
        $value = '';
        switch ($a_ecs_type) {
            case ilECSUtils::TYPE_TIMEPLACE:
                if ($a_value instanceof ilECSTimePlace) {
                    $value = new ilDateTime($a_value->{'getUT' . ucfirst($a_sub_id)}(), IL_CAL_UNIX);
                }
                break;
        }
 
        if ($value instanceof ilDateTime) {
            $this->getADT()->setDate($value);
            return true;
        }
        return false;
    }

References IL_CAL_UNIX, and ilECSUtils\TYPE_TIMEPLACE.

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionDateTime::importValueFromXML ( string $a_cdata )

Import value from xml.

Parameters

string $a_cdata

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 58 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

                                                       : void
    {
        $this->getADT()->setDate(new ilDate($a_cdata, IL_CAL_DATETIME));
    }

References ilAdvancedMDFieldDefinition\getADT(), and IL_CAL_DATETIME.

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionDateTime::initADTDefinition ( )

protected

Init adt instance.

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 43 of file class.ilAdvancedMDFieldDefinitionDateTime.php.

                                          : ilADTDefinition
    {
        return ilADTFactory::getInstance()->getDefinitionInstanceByType("DateTime");
    }

References ilADTFactory\getInstance().

Here is the call graph for this function:

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

components/ILIAS/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionDateTime.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getLuceneSearchString()

◆ getType()

◆ getValueForXML()

◆ importFromECS()

◆ importValueFromXML()

◆ initADTDefinition()