ilAdvancedMDFieldDefinition Class Reference

AMD field abstract base class. More...

Inheritance diagram for ilAdvancedMDFieldDefinition:

Collaboration diagram for ilAdvancedMDFieldDefinition:

Public Member Functions
	__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...
	hasComplexOptions ()
	getComplexOptionsOverview ($a_parent_gui, string $parent_cmd)

Static Public Member Functions
static	getInstance ($a_field_id, $a_type=null)
	Get definition instance by type. More...
static	exists ($a_field_id)
	Check if field exists. 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
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
const	TYPE_ADDRESS = 99
const	TYPE_EXTERNAL_LINK = 9
const	TYPE_INTERNAL_LINK = 10

Protected Member Functions
	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...

Static Protected Member Functions
static	getTypeString ($a_type)
	Get type string. More...

Protected Attributes
	$field_id
	$record_id
	$import_id
	$position
	$title
	$description
	$searchable
	$required
	$adt_def
	$adt

Detailed Description

AMD field abstract base class.

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

Constructor & Destructor Documentation

__construct()

ilAdvancedMDFieldDefinition::__construct

(

$a_field_id = null

)

Constructor.

Parameters

init

$a_field_id

Returns

self

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

References init(), and read().

    {
        $this->init();
        $this->read($a_field_id);
    }

Here is the call graph for this function:

Member Function Documentation

_clone()

ilAdvancedMDFieldDefinition::_clone

(

$a_new_record_id

)

Clone field definition.

Parameters

type

$a_new_record_id

Returns

self

Definition at line 1202 of file class.ilAdvancedMDFieldDefinition.php.

References getDescription(), getFieldDefinition(), getPosition(), getTitle(), isRequired(), and isSearchable().

    {
        $class = get_class($this);
        $obj = new $class();
        $obj->setRecordId($a_new_record_id);
        $obj->setTitle($this->getTitle());
        $obj->setDescription($this->getDescription());
        $obj->setRequired($this->isRequired());
        $obj->setPosition($this->getPosition());
        $obj->setSearchable($this->isSearchable());
        $obj->importFieldDefinition((array) $this->getFieldDefinition());
        $obj->save(true);

        return $obj;
    }

Here is the call graph for this function:

addCustomFieldToDefinitionForm()

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

protected

Add custom input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled

Definition at line 633 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by addToFieldDefinitionForm().

    {
        // type-specific
    }

Here is the caller graph for this function:

addPropertiesToXML()

ilAdvancedMDFieldDefinition::addPropertiesToXML ( ilXmlWriter  $a_writer )

protected

Add (type-specific) properties to xml export.

Parameters

ilXmlWriter

$a_writer

Definition at line 992 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by toXML().

    {
        // type-specific properties
    }

Here is the caller graph for this function:

addToFieldDefinitionForm()

ilAdvancedMDFieldDefinition::addToFieldDefinitionForm	(	ilPropertyFormGUI	$a_form,
		ilAdvancedMDPermissionHelper	$a_permissions
	)

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
ilAdvancedMDPermissionHelper	$a_form

Definition at line 644 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $lng, $title, ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, addCustomFieldToDefinitionForm(), ilPropertyFormGUI\addItem(), ilAdvancedMDPermissionHelper\CONTEXT_FIELD, getDescription(), getFieldId(), getTitle(), ilClaimingPermissionHelper\hasPermissions(), isSearchable(), isSearchSupported(), ilCheckboxInputGUI\setChecked(), ilTextAreaInputGUI\setValue(), ilAdvancedMDPermissionHelper\SUBACTION_FIELD_DESCRIPTION, ilAdvancedMDPermissionHelper\SUBACTION_FIELD_PROPERTIES, ilAdvancedMDPermissionHelper\SUBACTION_FIELD_SEARCHABLE, and ilAdvancedMDPermissionHelper\SUBACTION_FIELD_TITLE.

Referenced by ilAdvancedMDSettingsGUI\initFieldForm().

    {
        global $DIC;

        $lng = $DIC['lng'];
        
        $perm = $a_permissions->hasPermissions(
            ilAdvancedMDPermissionHelper::CONTEXT_FIELD,
            $this->getFieldId(),
            array(
                array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                    ilAdvancedMDPermissionHelper::SUBACTION_FIELD_TITLE)
                ,array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                    ilAdvancedMDPermissionHelper::SUBACTION_FIELD_DESCRIPTION)
                ,array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                    ilAdvancedMDPermissionHelper::SUBACTION_FIELD_SEARCHABLE)
                ,array(ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
                    ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES)
        )
        );
                
        // title
        $title = new ilTextInputGUI($lng->txt('title'), 'title');
        $title->setValue($this->getTitle());
        $title->setSize(20);
        $title->setMaxLength(70);
        $title->setRequired(true);
        $a_form->addItem($title);
        
        if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_TITLE]) {
            $title->setDisabled(true);
        }
        
        // desc
        $desc = new ilTextAreaInputGUI($lng->txt('description'), 'description');
        $desc->setValue($this->getDescription());
        $desc->setRows(3);
        $desc->setCols(50);
        $a_form->addItem($desc);
        
        if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_DESCRIPTION]) {
            $desc->setDisabled(true);
        }
        
        // searchable
        $check = new ilCheckboxInputGUI($lng->txt('md_adv_searchable'), 'searchable');
        $check->setChecked($this->isSearchable());
        $check->setValue(1);
        $a_form->addItem($check);
        
        if (!$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_SEARCHABLE] ||
            !$this->isSearchSupported()) {
            $check->setDisabled(true);
        }
        
        /* required
        $check = new ilCheckboxInputGUI($lng->txt('md_adv_required'), 'required');
        $check->setChecked($this->isRequired());
        $check->setValue(1);
        $a_form->addItem($check);
        */
        
        $this->addCustomFieldToDefinitionForm(
            $a_form,
            !$perm[ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY][ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilAdvancedMDFieldDefinition::delete

(

)

Delete field entry.

Definition at line 940 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, $query, ilAdvancedMDValues\_deleteByFieldId(), getADT(), and getFieldId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->getFieldId()) {
            return;
        }
    
        // delete all values
        include_once("Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php");
        ilAdvancedMDValues::_deleteByFieldId($this->getFieldId(), $this->getADT());
        
        $query = "DELETE FROM adv_mdf_definition" .
            " WHERE field_id = " . $ilDB->quote($this->getFieldId(), "integer");
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

exists()

static ilAdvancedMDFieldDefinition::exists (   $a_field_id )

static

Check if field exists.

Parameters

int

$a_field_id

Returns

bool

Definition at line 86 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, and $ilDB.

Referenced by ilContainerFilterFieldData\getFilterSetForRefId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $set = $ilDB->query("SELECT field_type" .
            " FROM adv_mdf_definition" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
        if ($ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

generateImportId()

ilAdvancedMDFieldDefinition::generateImportId

(

$a_field_id

)

Generate unique record id.

Parameters

int

$a_field_id

Returns

string

Definition at line 810 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by save(), and toXML().

    {
        return 'il_' . IL_INST_ID . '_adv_md_field_' . $a_field_id;
    }

Here is the caller graph for this function:

getADT()

ilAdvancedMDFieldDefinition::getADT

(

)

Get ADT instance.

Returns

ilADT

Definition at line 375 of file class.ilAdvancedMDFieldDefinition.php.

References $adt, getADTDefinition(), and ilADTFactory\getInstance().

Referenced by delete(), ilAdvancedMDFieldDefinitionDate\importFromECS(), ilAdvancedMDFieldDefinitionDateTime\importFromECS(), ilAdvancedMDFieldDefinitionText\importFromECS(), ilAdvancedMDFieldDefinitionExternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionDate\importValueFromXML(), ilAdvancedMDFieldDefinitionDateTime\importValueFromXML(), ilAdvancedMDFieldDefinitionInternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionLocation\importValueFromXML(), ilAdvancedMDFieldDefinitionGroupBased\importValueFromXML(), ilAdvancedMDFieldDefinitionSelectMulti\importValueFromXML(), ilAdvancedMDFieldDefinitionText\importValueFromXML(), ilAdvancedMDFieldDefinitionInteger\importValueFromXML(), ilAdvancedMDFieldDefinitionSelect\importValueFromXML(), ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), ilAdvancedMDFieldDefinitionText\searchObjects(), searchObjects(), and searchSubObjects().

    {
        if (!$this->adt instanceof ilADT) {
            $this->adt = ilADTFactory::getInstance()->getInstanceByDefinition($this->getADTDefinition());
        }
        return $this->adt;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getADTDefinition()

ilAdvancedMDFieldDefinition::getADTDefinition

(

)

Get ADT definition instance.

Returns

ilADTDefinition

Definition at line 362 of file class.ilAdvancedMDFieldDefinition.php.

References $adt_def, and initADTDefinition().

Referenced by getADT(), ilAdvancedMDFieldDefinitionSelectMulti\importCustomDefinitionFormPostValues(), and ilAdvancedMDFieldDefinitionSelectMulti\update().

    {
        if (!$this->adt_def instanceof ilADTDefinition) {
            $this->adt_def = $this->initADTDefinition();
        }
        return $this->adt_def;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getADTGroupForDefinitions()

static ilAdvancedMDFieldDefinition::getADTGroupForDefinitions ( array  $a_defs )

static

Init ADTGroup for definitions.

Parameters

array

$a_defs

Returns

ilADTGroup

Definition at line 236 of file class.ilAdvancedMDFieldDefinition.php.

References $factory, and ilADTFactory\getInstance().

Referenced by ilAdvancedMDValues\getADTGroup(), and ilAdvancedMDValues\queryForRecords().

    {
        $factory = ilADTFactory::getInstance();
        $group_def = $factory->getDefinitionInstanceByType("Group");
        foreach ($a_defs as $def) {
            $group_def->addElement($def->getFieldId(), $def->getADTDefinition());
        }
        $group = $factory->getInstanceByDefinition($group_def);
        
        // bind adt instances to definition
        foreach ($group->getElements() as $element_id => $element) {
            $a_defs[$element_id]->setADT($element);
        }
        
        return $group;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getComplexOptionsOverview()

ilAdvancedMDFieldDefinition::getComplexOptionsOverview	(		$a_parent_gui,
		string	$parent_cmd
	)

Parameters

	$a_parent_gui
string	$parent_cmd

Returns

null

Definition at line 1231 of file class.ilAdvancedMDFieldDefinition.php.

                                                                                 : ?string
    {
        return null;
    }

getDBProperties()

ilAdvancedMDFieldDefinition::getDBProperties ( )

protected

Get all definition properties for DB.

Returns

array

Definition at line 820 of file class.ilAdvancedMDFieldDefinition.php.

References getDescription(), getFieldDefinition(), getImportId(), getPosition(), getRecordId(), getTitle(), getType(), isRequired(), and isSearchable().

Referenced by save(), and update().

    {
        $fields = array(
            "field_type" => array("integer", $this->getType()),
            "record_id" => array("integer", $this->getRecordId()),
            "import_id" => array("text", $this->getImportId()),
            "title" => array("text", $this->getTitle()),
            "description" => array("text", $this->getDescription()),
            "position" => array("integer", $this->getPosition()),
            "searchable" => array("integer", $this->isSearchable()),
            "required" => array("integer", $this->isRequired())
        );
        
        $def = $this->getFieldDefinition();
        if (is_array($def)) {
            $fields["field_values"] = array("text", serialize($def));
        }
        
        return $fields;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilAdvancedMDFieldDefinition::getDescription

(

)

Get description.

Returns

string

Definition at line 524 of file class.ilAdvancedMDFieldDefinition.php.

References $description.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), and toXML().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getFieldDefinition()

ilAdvancedMDFieldDefinition::getFieldDefinition ( )

protected

Get (type-specific) field definition.

Returns

array

Definition at line 612 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by _clone(), and getDBProperties().

    {
        // type-specific properties
    }

Here is the caller graph for this function:

getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinition::getFieldDefinitionForTableGUI

(

)

Parse properties for table gui.

Returns

array

Definition at line 622 of file class.ilAdvancedMDFieldDefinition.php.

    {
        // type-specific properties
    }

getFieldId()

ilAdvancedMDFieldDefinition::getFieldId

(

)

Get field_id.

Returns

int

Definition at line 415 of file class.ilAdvancedMDFieldDefinition.php.

References $field_id.

Referenced by addToFieldDefinitionForm(), ilAdvancedMDFieldDefinitionSelect\buildConfirmedObjects(), delete(), ilAdvancedMDFieldDefinitionSelectMulti\findBySingleValue(), ilAdvancedMDFieldDefinitionSelect\importCustomDefinitionFormPostValues(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation(), save(), ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), ilAdvancedMDFieldDefinitionText\searchObjects(), searchObjects(), searchSubObjects(), toXML(), ilAdvancedMDFieldDefinitionSelectMulti\update(), ilAdvancedMDFieldDefinitionSelect\update(), and update().

    {
        return $this->field_id;
    }

Here is the caller graph for this function:

getImportId()

ilAdvancedMDFieldDefinition::getImportId

(

)

Get import id.

Returns

string

Definition at line 458 of file class.ilAdvancedMDFieldDefinition.php.

References $import_id.

Referenced by getDBProperties(), and save().

    {
        return $this->import_id;
    }

Here is the caller graph for this function:

getInstance()

static ilAdvancedMDFieldDefinition::getInstance (   $a_field_id,   $a_type = null  )

static

Get definition instance by type.

Parameters

int	$a_field_id
int	$a_type

Returns

self

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

References $a_type, $DIC, and $ilDB.

Referenced by ilContainer\applyContainerUserFilter(), ilAdvancedMDSettingsGUI\confirmDeleteFields(), ilAdvancedMDSettingsGUI\createField(), ilAdvancedMDSettingsGUI\deleteFields(), ilAdvancedMDSettingsGUI\editComplexOption(), ilAdvancedMDSettingsGUI\editField(), ilAdvancedMDSettingsGUI\editFields(), ilContainerFilterAdvMDAdapter\getAdvType(), ilContainerFilterUtil\getContainerFieldTitle(), ilLuceneAdvancedSearchFields\getFormElement(), ilContainerFilterAdvMDAdapter\getOptions(), ilContainerFilterAdvMDAdapter\getTitle(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilLuceneAdvancedSearchFields\readSections(), ilAdvancedMDSettingsGUI\saveField(), ilAdvancedSearchGUI\searchAdvancedMD(), ilAdvancedMDRecordGUI\showECSStart(), ilAdvancedMDSettingsGUI\updateComplexOption(), and ilAdvancedMDSettingsGUI\updateField().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$a_type) {
            $set = $ilDB->query("SELECT field_type" .
                " FROM adv_mdf_definition" .
                " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
            $a_type = $ilDB->fetchAssoc($set);
            $a_type = $a_type["field_type"];
        }
        
        if (self::isValidType($a_type)) {
            $class = "ilAdvancedMDFieldDefinition" . self::getTypeString($a_type);
            require_once "Services/AdvancedMetaData/classes/Types/class." . $class . ".php";
            return new $class($a_field_id);
        }
        
        throw new ilException("unknown type " . $a_type);
    }

Here is the caller graph for this function:

getInstanceByImportId()

static ilAdvancedMDFieldDefinition::getInstanceByImportId (   $a_import_id )

static

Get definition instance by import id.

Parameters

string

$a_import_id

Returns

self

Definition at line 191 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and $query.

Referenced by ilAdvancedMDParser\initValue().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT field_id, field_type FROM adv_mdf_definition" .
            " WHERE import_id = " . $ilDB->quote($a_import_id, 'text');
        $set = $ilDB->query($query);
        if ($ilDB->numRows($set)) {
            $row = $ilDB->fetchAssoc($set);
            return self::getInstance($row["field_id"], $row["field_type"]);
        }
    }

Here is the caller graph for this function:

getInstanceByTypeString()

static ilAdvancedMDFieldDefinition::getInstanceByTypeString (   $a_type )

static

Get instance by type string (used by import)

Parameters

string

$a_type

Returns

self

Definition at line 107 of file class.ilAdvancedMDFieldDefinition.php.

References $a_type.

Referenced by ilAdvancedMDRecordParser\initFieldObject().

    {
        // see self::getTypeString()
        $map = array(
            self::TYPE_TEXT => "Text",
            self::TYPE_SELECT => "Select",
            self::TYPE_DATE => "Date",
            self::TYPE_DATETIME => "DateTime",
            self::TYPE_FLOAT => "Float",
            self::TYPE_LOCATION => "Location",
            self::TYPE_INTEGER => "Integer",
            self::TYPE_SELECT_MULTI => "SelectMulti"    ,
            self::TYPE_EXTERNAL_LINK => 'ExternalLink',
            self::TYPE_INTERNAL_LINK => 'InternalLink',
            self::TYPE_ADDRESS => "Address"
        );
        $map = array_flip($map);
        if (array_key_exists($a_type, $map)) {
            return self::getInstance(null, $map[$a_type]);
        }
    }

Here is the caller graph for this function:

getInstancesByObjType()

static ilAdvancedMDFieldDefinition::getInstancesByObjType (   $a_obj_type,   $a_active_only = true  )

static

Definition at line 160 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilECSSettingsGUI\exportMappings(), ilECSSettingsGUI\importMappings(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilECSSettingsGUI\initMappingsForm(), ilAdvancedMDRecordGUI\parseAppointmentPresentation(), and ilAdvancedMDSettingsGUI\updateSubstitutions().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $defs = array();
        
        $query = "SELECT amf.* FROM adv_md_record_objs aro" .
            " JOIN adv_md_record amr ON aro.record_id = amr.record_id" .
            " JOIN adv_mdf_definition amf ON aro.record_id = amf.record_id" .
            " WHERE obj_type = " . $ilDB->quote($a_obj_type, 'text');
        if ((bool) $a_active_only) {
            $query .= " AND active = " . $ilDB->quote(1, "integer");
        }
        $query .= " ORDER BY aro.record_id,position";
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $field = self::getInstance(null, $row["field_type"]);
            $field->import($row);
            $defs[$row["field_id"]] = $field;
        }
        return $defs;
    }

Here is the caller graph for this function:

getInstancesByRecordId()

static ilAdvancedMDFieldDefinition::getInstancesByRecordId (   $a_record_id,   $a_only_searchable = false  )

static

Get definitions by record id.

Parameters

int	$a_record_id
bool	$a_only_searchable

Returns

array self

Definition at line 136 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and $query.

Referenced by ilAdvancedMDRecord\_clone(), ilGlossaryTerm\_copyTerm(), ilAdvancedMDRecord\_delete(), ilAdvancedMDSettingsGUI\editFields(), ilAdvancedMDRecordTableGUI\fillRow(), ilPCAMDPageList\findPages(), ilObjBookingPool\getAdvancedMDFields(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilContainerFilterAdvMDAdapter\getAvailableRecordSets(), ilAdvancedMDValues\getDefinitions(), ilLuceneAdvancedSearchFields\getFields(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableCells(), ilAdvancedMDRecordGUI\parseTableHead(), ilAdvancedMDValues\queryForRecords(), ilAdvancedMDRecord\toXML(), and ilAdvancedMDSettingsGUI\updateFields().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $defs = array();
        
        $query = "SELECT * FROM adv_mdf_definition" .
            " WHERE record_id = " . $ilDB->quote($a_record_id, "integer");
        if ($a_only_searchable) {
            $query .= " AND searchable = " . $ilDB->quote(1, "integer");
        }
        $query .= " ORDER BY position";
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $field = self::getInstance(null, $row["field_type"]);
            $field->import($row);
            $defs[$row["field_id"]] = $field;
        }
        
        return $defs;
    }

Here is the caller graph for this function:

getLastPosition()

ilAdvancedMDFieldDefinition::getLastPosition ( )

protected

Get last position of record.

Returns

int

Definition at line 786 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and getRecordId().

Referenced by save().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $sql = "SELECT max(position) pos" .
            " FROM adv_mdf_definition" .
            " WHERE record_id = " . $ilDB->quote($this->getRecordId(), "integer");
        $set = $ilDB->query($sql);
        if ($ilDB->numRows($set)) {
            $pos = $ilDB->fetchAssoc($set);
            return (int) $pos["pos"];
        }
        
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLuceneSearchString()

ilAdvancedMDFieldDefinition::getLuceneSearchString

(

$a_value

)

Get search string in lucene syntax.

Parameters

mixed

$a_value

Returns

string

Definition at line 1181 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return $a_value;
    }

getPosition()

ilAdvancedMDFieldDefinition::getPosition

(

)

Get position.

Returns

int

Definition at line 478 of file class.ilAdvancedMDFieldDefinition.php.

References $position.

Referenced by _clone(), getDBProperties(), and toXML().

    {
        return $this->position;
    }

Here is the caller graph for this function:

getRecordId()

ilAdvancedMDFieldDefinition::getRecordId

(

)

Get record id.

Returns

int

Definition at line 435 of file class.ilAdvancedMDFieldDefinition.php.

References $record_id.

Referenced by getDBProperties(), and getLastPosition().

    {
        return $this->record_id;
    }

Here is the caller graph for this function:

getSearchableDefinitionIds()

static ilAdvancedMDFieldDefinition::getSearchableDefinitionIds ( )

static

Get searchable definition ids (performance is key)

Returns

array

Definition at line 211 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and $query.

Referenced by ilAdvancedSearchGUI\setSubTabs().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $field_ids = array();
        
        $query = "SELECT field_id FROM adv_md_record amr" .
            " JOIN adv_mdf_definition amfd ON (amr.record_id = amfd.record_id)" .
            " WHERE active = " . $ilDB->quote(1, "integer") .
            " AND searchable = " . $ilDB->quote(1, "integer");
        $set = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($set)) {
            $field_ids[] = $row["field_id"];
        }
        return $field_ids;
    }

Here is the caller graph for this function:

getSearchQueryParserValue()

ilAdvancedMDFieldDefinition::getSearchQueryParserValue

(

ilADTSearchBridge

$a_adt_search

)

Get value for search query parser.

Parameters

ilADTSearchBridge

$a_adt_search

Returns

mixed

Definition at line 1061 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return '';
    }

getSearchValueSerialized()

ilAdvancedMDFieldDefinition::getSearchValueSerialized

(

ilADTSearchBridge

$a_adt_search

)

Get value for search persistence.

Parameters

ilADTSearchBridge

$a_adt_search

Returns

string

Definition at line 1072 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTSearchBridge\getSerializedValue().

    {
        return $a_adt_search->getSerializedValue();
    }

Here is the call graph for this function:

getTitle()

ilAdvancedMDFieldDefinition::getTitle

(

)

Get title.

Returns

string

Definition at line 501 of file class.ilAdvancedMDFieldDefinition.php.

References $title.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), and toXML().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getType()

ilAdvancedMDFieldDefinition::getType ( )

abstract

Get type.

Returns

int

Referenced by getDBProperties(), getTypeTitle(), isValidType(), searchObjects(), searchSubObjects(), and toXML().

Here is the caller graph for this function:

getTypeString()

static ilAdvancedMDFieldDefinition::getTypeString (   $a_type )

staticprotected

Get type string.

Parameters

string

$a_type

Returns

string

Definition at line 313 of file class.ilAdvancedMDFieldDefinition.php.

References $a_type.

    {
        if (self::isValidType($a_type)) {
            $map = array(
                self::TYPE_TEXT => "Text",
                self::TYPE_SELECT => "Select",
                self::TYPE_DATE => "Date",
                self::TYPE_DATETIME => "DateTime",
                self::TYPE_FLOAT => "Float",
                self::TYPE_LOCATION => "Location",
                self::TYPE_INTEGER => "Integer",
                self::TYPE_SELECT_MULTI => "SelectMulti"        ,
                self::TYPE_EXTERNAL_LINK => 'ExternalLink',
                self::TYPE_INTERNAL_LINK => 'InternalLink',
                self::TYPE_ADDRESS => "Address"
            );
            return $map[$a_type];
        }
    }

getTypeTitle()

ilAdvancedMDFieldDefinition::getTypeTitle

(

)

Get type title (lang id)

Returns

string

Definition at line 338 of file class.ilAdvancedMDFieldDefinition.php.

References getType(), and initADTDefinition().

Referenced by ilAdvancedMDSettingsGUI\initFieldForm().

    {
        // :TODO: reuse udf stuff here ?!
        return "udf_type_" . strtolower(self::getTypeString($this->getType()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidTypes()

static ilAdvancedMDFieldDefinition::getValidTypes ( )

static

Get all valid types.

Returns

array

Definition at line 272 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilAdvancedMDSettingsGUI\editFields().

    {
        return array(
            self::TYPE_TEXT,
            self::TYPE_DATE,
            self::TYPE_DATETIME,
            self::TYPE_SELECT,
            self::TYPE_INTEGER,
            self::TYPE_FLOAT,
            self::TYPE_LOCATION,
            self::TYPE_SELECT_MULTI,
            self::TYPE_EXTERNAL_LINK,
            self::TYPE_INTERNAL_LINK,
            self::TYPE_ADDRESS
        );
    }

Here is the caller graph for this function:

getValueForXML()

ilAdvancedMDFieldDefinition::getValueForXML ( ilADT  $element )

abstract

Parse ADT value for xml (export)

Parameters

ilADT

$element

Returns

string

Referenced by importXMLProperty().

Here is the caller graph for this function:

hasComplexOptions()

ilAdvancedMDFieldDefinition::hasComplexOptions

(

)

Definition at line 1221 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return false;
    }

import()

ilAdvancedMDFieldDefinition::import ( array  $a_data )

protected

Import from DB.

Parameters

array

$a_data

Definition at line 846 of file class.ilAdvancedMDFieldDefinition.php.

References importFieldDefinition(), setDescription(), setFieldId(), setImportId(), setPosition(), setRecordId(), setRequired(), setSearchable(), and setTitle().

    {
        $this->setFieldId($a_data["field_id"]);
        
        $this->setRecordId($a_data["record_id"]);
        $this->setImportId($a_data["import_id"]);
        $this->setTitle($a_data["title"]);
        $this->setDescription($a_data["description"]);
        $this->setPosition($a_data["position"]);
        $this->setSearchable($a_data["searchable"]);
        $this->setRequired($a_data["required"]);
        if ($a_data["field_values"]) {
            $this->importFieldDefinition(unserialize($a_data["field_values"]));
        }
    }

Here is the call graph for this function:

importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinition::importCustomDefinitionFormPostValues

(

ilPropertyFormGUI

$a_form

)

Import custom post values from definition form.

Parameters

ilPropertyFormGUI

$a_form

Definition at line 717 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by importDefinitionFormPostValues().

    {
        // type-specific
    }

Here is the caller graph for this function:

importDefinitionFormPostValues()

ilAdvancedMDFieldDefinition::importDefinitionFormPostValues	(	ilPropertyFormGUI	$a_form,
		ilAdvancedMDPermissionHelper	$a_permissions
	)

Import post values from definition form.

Parameters

ilPropertyFormGUI	$a_form
ilAdvancedMDPermissionHelper	$a_permissions

Definition at line 728 of file class.ilAdvancedMDFieldDefinition.php.

References ilAdvancedMDPermissionHelper\ACTION_FIELD_EDIT_PROPERTY, ilAdvancedMDPermissionHelper\CONTEXT_FIELD, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilClaimingPermissionHelper\hasPermission(), importCustomDefinitionFormPostValues(), setDescription(), setSearchable(), setTitle(), and ilAdvancedMDPermissionHelper\SUBACTION_FIELD_PROPERTIES.

    {
        if (!$a_form->getItemByPostVar("title")->getDisabled()) {
            $this->setTitle($a_form->getInput("title"));
        }
        if (!$a_form->getItemByPostVar("description")->getDisabled()) {
            $this->setDescription($a_form->getInput("description"));
        }
        if (!$a_form->getItemByPostVar("searchable")->getDisabled()) {
            $this->setSearchable($a_form->getInput("searchable"));
        }
        
        if ($a_permissions->hasPermission(
            ilAdvancedMDPermissionHelper::CONTEXT_FIELD,
            $this->getFieldId(),
            ilAdvancedMDPermissionHelper::ACTION_FIELD_EDIT_PROPERTY,
            ilAdvancedMDPermissionHelper::SUBACTION_FIELD_PROPERTIES
        )) {
            $this->importCustomDefinitionFormPostValues($a_form);
        }
    }

Here is the call graph for this function:

importDefinitionFormPostValuesNeedsConfirmation()

ilAdvancedMDFieldDefinition::importDefinitionFormPostValuesNeedsConfirmation

(

)

Definition at line 750 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return false;
    }

importFieldDefinition()

ilAdvancedMDFieldDefinition::importFieldDefinition ( array  $a_def )

protected

Import (type-specific) field definition from DB.

Parameters

array

$a_def

Definition at line 603 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import().

    {
    }

Here is the caller graph for this function:

importFromECS()

ilAdvancedMDFieldDefinition::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

Definition at line 1030 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return false;
    }

importValueFromXML()

ilAdvancedMDFieldDefinition::importValueFromXML (   $a_cdata )

abstract

Import value from xml.

Parameters

string

$a_cdata

Referenced by importXMLProperty().

Here is the caller graph for this function:

importXMLProperty()

ilAdvancedMDFieldDefinition::importXMLProperty	(		$a_key,
			$a_value
	)

Import property from XML.

Parameters

string	$a_key
string	$a_value

Definition at line 1003 of file class.ilAdvancedMDFieldDefinition.php.

References getValueForXML(), and importValueFromXML().

    {
    }

Here is the call graph for this function:

init()

ilAdvancedMDFieldDefinition::init ( )

protected

Init properties.

Definition at line 256 of file class.ilAdvancedMDFieldDefinition.php.

References setRequired(), and setSearchable().

Referenced by __construct().

    {
        $this->setRequired(false);
        $this->setSearchable(false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initADTDefinition()

ilAdvancedMDFieldDefinition::initADTDefinition ( )

abstractprotected

Init adt instance.

Returns

ilADTDefinition

Referenced by getADTDefinition(), and getTypeTitle().

Here is the caller graph for this function:

isFilterSupported()

ilAdvancedMDFieldDefinition::isFilterSupported

(

)

Is search by filter supported.

Returns

boolean

Definition at line 544 of file class.ilAdvancedMDFieldDefinition.php.

    {
        return true;
    }

isRequired()

ilAdvancedMDFieldDefinition::isRequired

(

)

Is required field.

Returns

bool

Definition at line 588 of file class.ilAdvancedMDFieldDefinition.php.

References $required.

Referenced by _clone(), and getDBProperties().

    {
        return $this->required;
    }

Here is the caller graph for this function:

isSearchable()

ilAdvancedMDFieldDefinition::isSearchable

(

)

Is searchable.

Returns

bool

Definition at line 568 of file class.ilAdvancedMDFieldDefinition.php.

References $searchable.

Referenced by _clone(), addToFieldDefinitionForm(), getDBProperties(), and toXML().

    {
        return $this->searchable;
    }

Here is the caller graph for this function:

isSearchSupported()

ilAdvancedMDFieldDefinition::isSearchSupported

(

)

Is search supported at all.

Returns

boolean

Definition at line 534 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by addToFieldDefinitionForm(), and setSearchable().

    {
        return true;
    }

Here is the caller graph for this function:

isValidType()

static ilAdvancedMDFieldDefinition::isValidType (   $a_type )

static

Is given type valid.

Parameters

int

$a_type

Returns

bool

Definition at line 295 of file class.ilAdvancedMDFieldDefinition.php.

References $a_type, and getType().

    {
        return in_array((int) $a_type, self::getValidTypes());
    }

Here is the call graph for this function:

parseSearchObjects()

ilAdvancedMDFieldDefinition::parseSearchObjects ( array  $a_records, array  $a_object_types  )

protected

Add object-data needed for global search to AMD search results.

Parameters

array	$a_records
array	$a_object_types

Returns

array

Definition at line 1095 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, and $res.

Referenced by ilAdvancedMDFieldDefinitionInternalLink\searchObjects(), and searchObjects().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $res = array();
        
        $obj_ids = array();
        foreach ($a_records as $record) {
            if ($record["sub_type"] == "-") {
                $obj_ids[] = $record["obj_id"];
            }
        }
        
        $sql = "SELECT obj_id,type" .
            " FROM object_data" .
            " WHERE " . $ilDB->in("obj_id", $obj_ids, "", "integer") .
            " AND " . $ilDB->in("type", $a_object_types, "", "text");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        
        return $res;
    }

Here is the caller graph for this function:

prepareCustomDefinitionFormConfirmation()

ilAdvancedMDFieldDefinition::prepareCustomDefinitionFormConfirmation

(

ilPropertyFormGUI

$a_form

)

Definition at line 755 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by prepareDefinitionFormConfirmation().

    {
        // type-specific
    }

Here is the caller graph for this function:

prepareDefinitionFormConfirmation()

ilAdvancedMDFieldDefinition::prepareDefinitionFormConfirmation

(

ilPropertyFormGUI

$a_form

)

Definition at line 760 of file class.ilAdvancedMDFieldDefinition.php.

References ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and prepareCustomDefinitionFormConfirmation().

    {
        $a_form->getItemByPostVar("title")->setDisabled(true);
        $a_form->getItemByPostVar("description")->setDisabled(true);
        $a_form->getItemByPostVar("searchable")->setDisabled(true);
        
        // checkboxes have no hidden on disabled
        if ($a_form->getInput("searchable")) {
            $hidden = new ilHiddenInputGUI("searchable");
            $hidden->setValue(1);
            $a_form->addItem($hidden);
        }
        
        $this->prepareCustomDefinitionFormConfirmation($a_form);
    }

Here is the call graph for this function:

prepareElementForEditor()

ilAdvancedMDFieldDefinition::prepareElementForEditor

(

ilADTFormBridge

$a_bridge

)

Prepare editor form elements.

Parameters

ilADTFormBridge

$a_bridge

Definition at line 1045 of file class.ilAdvancedMDFieldDefinition.php.

    {
        // type-specific
    }

prepareElementForSearch()

ilAdvancedMDFieldDefinition::prepareElementForSearch

(

ilADTSearchBridge

$a_bridge

)

Prepare search form elements.

Parameters

ilADTSearchBridge

$a_bridge

Definition at line 1191 of file class.ilAdvancedMDFieldDefinition.php.

    {
        // type-specific
    }

read()

ilAdvancedMDFieldDefinition::read (   $a_field_id )

protected

Read field definition.

Definition at line 865 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, and $ilDB.

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!(int) $a_field_id) {
            return;
        }
                
        $sql = "SELECT * FROM adv_mdf_definition" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer");
        $set = $ilDB->query($sql);
        if ($ilDB->numRows($set)) {
            $row = $ilDB->fetchAssoc($set);
            $this->import($row);
        }
    }

Here is the caller graph for this function:

save()

ilAdvancedMDFieldDefinition::save

(

$a_keep_pos = false

)

Create new field entry.

Definition at line 887 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, generateImportId(), getDBProperties(), getFieldId(), getImportId(), getLastPosition(), setFieldId(), setImportId(), setPosition(), and update().

Referenced by update().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getFieldId()) {
            return $this->update();
        }
        
        $next_id = $ilDB->nextId("adv_mdf_definition");
        
        // append
        if (!$a_keep_pos) {
            $this->setPosition($this->getLastPosition() + 1);
        }
        
        // needs unique import id
        if (!$this->getImportId()) {
            $this->setImportId($this->generateImportId($next_id));
        }
        
        $fields = $this->getDBProperties();
        $fields["field_id"] = array("integer", $next_id);
        
        $ilDB->insert("adv_mdf_definition", $fields);
        
        $this->setFieldId($next_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

searchObjects()

ilAdvancedMDFieldDefinition::searchObjects	(	ilADTSearchBridge	$a_adt_search,
		ilQueryParser	$a_parser,
		array	$a_object_types,
			$a_locate,
			$a_search_type
	)

Search objects.

Parameters

ilADTSearchBridge	$a_adt_search
ilQueryParser	$a_parser
array	$a_object_types
string	$a_locate
string	$a_search_type

Returns

array

Definition at line 1160 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTActiveRecordByType\find(), getADT(), getFieldId(), ilADTSearchBridge\getSQLCondition(), getType(), parseSearchObjects(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.

    {
        // search type only supported/needed for text
        
        include_once('Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php');
        $condition = $a_adt_search->getSQLCondition(ilADTActiveRecordByType::SINGLE_COLUMN_NAME);
        if ($condition) {
            $objects = ilADTActiveRecordByType::find("adv_md_values", $this->getADT()->getType(), $this->getFieldId(), $condition, $a_locate);
            if (sizeof($objects)) {
                return $this->parseSearchObjects($objects, $a_object_types);
            }
            return array();
        }
    }

Here is the call graph for this function:

searchSubObjects()

ilAdvancedMDFieldDefinition::searchSubObjects	(	ilADTSearchBridge	$a_adt_search,
			$a_obj_id,
			$sub_obj_type
	)

Definition at line 1122 of file class.ilAdvancedMDFieldDefinition.php.

References $res, ilADTActiveRecordByType\find(), getADT(), getFieldId(), ilADTSearchBridge\getSQLCondition(), getType(), and ilADTActiveRecordByType\SINGLE_COLUMN_NAME.

    {
        include_once('Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php');
        $element_id = ilADTActiveRecordByType::SINGLE_COLUMN_NAME;
        
        // :TODO:
        if ($a_adt_search instanceof ilADTLocationSearchBridgeSingle) {
            $element_id = "loc";
        }
                                    
        $condition = $a_adt_search->getSQLCondition($element_id);
        if ($condition) {
            $objects = ilADTActiveRecordByType::find("adv_md_values", $this->getADT()->getType(), $this->getFieldId(), $condition);
            if (sizeof($objects)) {
                $res = array();
                foreach ($objects as $item) {
                    if ($item["obj_id"] == $a_obj_id &&
                        $item["sub_type"] == $sub_obj_type) {
                        $res[] = $item["sub_id"];
                    }
                }
                return $res;
            }
        }
        
        return array();
    }

Here is the call graph for this function:

setADT()

ilAdvancedMDFieldDefinition::setADT ( ilADT  $a_adt )

protected

Set ADT instance.

See also

self::getADTGroupForDefinitions()

Parameters

ilADT

$a_adt

Definition at line 389 of file class.ilAdvancedMDFieldDefinition.php.

    {
        if (!$this->adt instanceof ilADT) {
            $this->adt = $a_adt;
        }
    }

setDescription()

ilAdvancedMDFieldDefinition::setDescription

(

$a_desc

)

Set description.

Parameters

string

$a_desc

Definition at line 511 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and importDefinitionFormPostValues().

    {
        if ($a_desc !== null) {
            $a_desc = trim($a_desc);
        }
        $this->description = $a_desc;
    }

Here is the caller graph for this function:

setFieldId()

ilAdvancedMDFieldDefinition::setFieldId (   $a_id )

protected

Set field_id.

Parameters

int

$a_id

Definition at line 405 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

    {
        $this->field_id = (int) $a_id;
    }

Here is the caller graph for this function:

setImportId()

ilAdvancedMDFieldDefinition::setImportId

(

$a_id_string

)

Set import id.

Parameters

string

$a_id_string

Definition at line 445 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

    {
        if ($a_id_string !== null) {
            $a_id_string = trim($a_id_string);
        }
        $this->import_id = $a_id_string;
    }

Here is the caller graph for this function:

setPosition()

ilAdvancedMDFieldDefinition::setPosition

(

$a_pos

)

Set position.

Parameters

int

$a_pos

Definition at line 468 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and save().

    {
        $this->position = (int) $a_pos;
    }

Here is the caller graph for this function:

setRecordId()

ilAdvancedMDFieldDefinition::setRecordId

(

$a_id

)

Set record id.

Parameters

int

$a_id

Definition at line 425 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import().

    {
        $this->record_id = (int) $a_id;
    }

Here is the caller graph for this function:

setRequired()

ilAdvancedMDFieldDefinition::setRequired

(

$a_status

)

Toggle required.

Parameters

bool

$a_status

Definition at line 578 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and init().

    {
        $this->required = (bool) $a_status;
    }

Here is the caller graph for this function:

setSearchable()

ilAdvancedMDFieldDefinition::setSearchable

(

$a_status

)

Toggle searchable.

Parameters

bool	searchable

Definition at line 554 of file class.ilAdvancedMDFieldDefinition.php.

References isSearchSupported().

Referenced by import(), importDefinitionFormPostValues(), and init().

    {
        // see above
        if (!$this->isSearchSupported()) {
            $a_status = false;
        }
        $this->searchable = (bool) $a_status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSearchValueSerialized()

ilAdvancedMDFieldDefinition::setSearchValueSerialized	(	ilADTSearchBridge	$a_adt_search,
			$a_value
	)

Set value from search persistence.

Parameters

ilADTSearchBridge	$a_adt_search
string	$a_value

Definition at line 1083 of file class.ilAdvancedMDFieldDefinition.php.

References ilADTSearchBridge\setSerializedValue().

    {
        return $a_adt_search->setSerializedValue($a_value);
    }

Here is the call graph for this function:

setTitle()

ilAdvancedMDFieldDefinition::setTitle

(

$a_title

)

Get title.

Parameters

string

$a_title

Definition at line 488 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by import(), and importDefinitionFormPostValues().

    {
        if ($a_title !== null) {
            $a_title = trim($a_title);
        }
        $this->title = $a_title;
    }

Here is the caller graph for this function:

toXML()

ilAdvancedMDFieldDefinition::toXML

(

ilXmlWriter

$a_writer

)

To Xml.

This method writes only the subset Field Use class.ilAdvancedMDRecordXMLWriter to generate a complete xml presentation.

Parameters

ilXmlWriter

$a_writer

Definition at line 971 of file class.ilAdvancedMDFieldDefinition.php.

References addPropertiesToXML(), generateImportId(), getDescription(), getFieldId(), getPosition(), getTitle(), getType(), isSearchable(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

    {
        $a_writer->xmlStartTag('Field', array(
            'id' => $this->generateImportId($this->getFieldId()),
            'searchable' => ($this->isSearchable() ? 'Yes' : 'No'),
            'fieldType' => self::getTypeString($this->getType())));
        
        $a_writer->xmlElement('FieldTitle', null, $this->getTitle());
        $a_writer->xmlElement('FieldDescription', null, $this->getDescription());
        $a_writer->xmlElement('FieldPosition', null, $this->getPosition());
        
        $this->addPropertiesToXML($a_writer);
        
        $a_writer->xmlEndTag('Field');
    }

Here is the call graph for this function:

update()

ilAdvancedMDFieldDefinition::update

(

)

Update field entry.

Definition at line 920 of file class.ilAdvancedMDFieldDefinition.php.

References $DIC, $ilDB, getDBProperties(), getFieldId(), and save().

Referenced by save().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->getFieldId()) {
            return $this->save();
        }
        
        $ilDB->update(
            "adv_mdf_definition",
            $this->getDBProperties(),
            array("field_id" => array("integer", $this->getFieldId()))
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$adt

ilAdvancedMDFieldDefinition::$adt

protected

Definition at line 25 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilAdvancedMDFieldDefinitionGroupBased\exportOptionToTableGUI(), getADT(), ilAdvancedMDFieldDefinitionGroupBased\getADTForOption(), ilAdvancedMDFieldDefinitionExternalLink\importValueFromXML(), ilAdvancedMDFieldDefinitionLocation\importValueFromXML(), ilAdvancedMDFieldDefinitionGroupBased\initOptionForm(), and ilAdvancedMDFieldDefinitionGroupBased\updateComplexOption().

$adt_def

ilAdvancedMDFieldDefinition::$adt_def

protected

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

Referenced by getADTDefinition().

$description

ilAdvancedMDFieldDefinition::$description

protected

Definition at line 21 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by getDescription().

$field_id

ilAdvancedMDFieldDefinition::$field_id

protected

Definition at line 16 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by getFieldId().

$import_id

ilAdvancedMDFieldDefinition::$import_id

protected

Definition at line 18 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by getImportId().

$position

ilAdvancedMDFieldDefinition::$position

protected

Definition at line 19 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by getPosition().

$record_id

ilAdvancedMDFieldDefinition::$record_id

protected

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

Referenced by getRecordId().

$required

ilAdvancedMDFieldDefinition::$required

protected

Definition at line 23 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by isRequired().

$searchable

ilAdvancedMDFieldDefinition::$searchable

protected

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

Referenced by isSearchable().

$title

ilAdvancedMDFieldDefinition::$title

protected

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

Referenced by addToFieldDefinitionForm(), ilAdvancedMDFieldDefinitionGroupBased\exportOptionToTableGUI(), getTitle(), ilAdvancedMDFieldDefinitionGroupBased\initOptionForm(), and ilAdvancedMDFieldDefinitionSelect\prepareCustomDefinitionFormConfirmation().

TYPE_ADDRESS

const ilAdvancedMDFieldDefinition::TYPE_ADDRESS = 99

Definition at line 35 of file class.ilAdvancedMDFieldDefinition.php.

TYPE_DATE

const ilAdvancedMDFieldDefinition::TYPE_DATE = 3

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

Referenced by ilTermListTableGUI\numericOrdering(), ilPresentationListTableGUI\numericOrdering(), and ilBookingObjectsTableGUI\numericOrdering().

TYPE_DATETIME

const ilAdvancedMDFieldDefinition::TYPE_DATETIME = 4

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

TYPE_EXTERNAL_LINK

const ilAdvancedMDFieldDefinition::TYPE_EXTERNAL_LINK = 9

Definition at line 36 of file class.ilAdvancedMDFieldDefinition.php.

TYPE_FLOAT

const ilAdvancedMDFieldDefinition::TYPE_FLOAT = 6

Definition at line 32 of file class.ilAdvancedMDFieldDefinition.php.

TYPE_INTEGER

const ilAdvancedMDFieldDefinition::TYPE_INTEGER = 5

Definition at line 31 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilContainerFilterUtil\getContainerRecordTitle().

TYPE_INTERNAL_LINK

const ilAdvancedMDFieldDefinition::TYPE_INTERNAL_LINK = 10

Definition at line 37 of file class.ilAdvancedMDFieldDefinition.php.

TYPE_LOCATION

const ilAdvancedMDFieldDefinition::TYPE_LOCATION = 7

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

TYPE_SELECT

const ilAdvancedMDFieldDefinition::TYPE_SELECT = 1

Definition at line 27 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilContainerFilterUtil\getContainerRecordTitle(), and ilAdvancedMDRecordGUI\showECSStart().

TYPE_SELECT_MULTI

const ilAdvancedMDFieldDefinition::TYPE_SELECT_MULTI = 8

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

Referenced by ilContainerFilterUtil\getContainerRecordTitle().

TYPE_TEXT

const ilAdvancedMDFieldDefinition::TYPE_TEXT = 2

Definition at line 28 of file class.ilAdvancedMDFieldDefinition.php.

Referenced by ilContainerFilterUtil\getContainerRecordTitle(), and ilAdvancedMDRecordGUI\showECSStart().

---

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

• Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php