ilAdvancedMDFieldDefinition Class Reference

Collaboration diagram for ilAdvancedMDFieldDefinition:

Public Member Functions
	__construct ($a_field_id=0)
	public
	isDeleted ()
	is deleted
	setRecordId ($a_id)
	set record id
	getRecordId ()
	get record id
	getFieldId ()
	get field_id
	setImportId ($a_id_string)
	set import id
	getImportId ()
	get import_id
	setPosition ($a_pos)
	set position
	getPosition ()
	get position
	setFieldType ($a_type_id)
	set field type
	getFieldType ()
	get field type
	setFieldValues ($a_values)
	set field values
	appendFieldValue ($a_value)
	Append field value.
	getFieldValues ()
	get field values
	getFieldValuesForSelect ()
	get field values for select
	getFieldValuesForSearch ()
	get field values for select
	setTitle ($a_title)
	set title
	getTitle ()
	get title
	setDescription ($a_desc)
	set description
	getDescription ()
	get description
	enableSearchable ($a_status)
	enable searchable
	isSearchable ()
	is searchable
	isRequired ()
	is required field
	delete ()
	delete field
	add ()
	add new field
	validate ()
	validate
	update ()
	update
	toXML (ilXmlWriter $writer)
	To Xml.

Static Public Member Functions
static	_lookupImportId ($a_field_id)
	Lookup import id.
static	_lookupFieldId ($a_import_id)
	Lookup field id.
static	_lookupFieldType ($a_field_id)
	Lookup field type.
static	_lookupDateTimeFields ()
	Lookup datetime fields.
static	_lookupDateFields ()
	Lookup date fields.
static	_getInstanceByFieldId ($a_field_id)
	Get instance by field_id.
static	_getDefinitionsByRecordId ($a_record_id)
	get definitions
static	_getActiveDefinitionsByObjType ($a_type)
	get active definitions by obj type
static	_getSearchableDefinitionIds ()
	Get searchable definition ids.
static	_deleteByRecordId ($a_record_id)
	Delete all fields by record_id.

Data Fields
const	TYPE_SELECT = 1
const	TYPE_TEXT = 2
const	TYPE_DATE = 3
const	TYPE_DATETIME = 4

Protected Member Functions
	generateImportId ()
	generate unique record id

Protected Attributes
	$db = null
	$record_id
	$field_id
	$import_id
	$position
	$field_type
	$field_values = array()
	$title
	$description
	$searchable
	$required = false

Private Member Functions
	read ()
	read field definition
	getLastPosition ()
	get last position of record

Static Private Attributes
static	$instances = array()

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

ilAdvancedMDFieldDefinition::__construct

(

$a_field_id = 0

)

public

Parameters

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

References read().

        {
                global $ilDB;
                
                $this->db = $ilDB;
                
                $this->field_id = $a_field_id;
                $this->read();
        }

Here is the call graph for this function:

Member Function Documentation

static ilAdvancedMDFieldDefinition::_deleteByRecordId (   $a_record_id )

static

Delete all fields by record_id.

public

Parameters

int

record_id

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

References $query, $res, $row, ilAdvancedMDValues\_deleteByFieldId(), and DB_FETCHMODE_OBJECT.

Referenced by ilAdvancedMDRecord\_delete().

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_mdf_definition ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id ,'integer');
                $res = $ilDB->query($query);    
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        // Delete values
                        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                        ilAdvancedMDValues::_deleteByFieldId($row->field_id);
                }               

                // Delete definitions
                $query = "DELETE FROM adv_mdf_definition ".
                        "WHERE record_id  = ".$ilDB->quote($a_record_id,'integer')." ";
                $res = $ilDB->manipulate($query);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_getActiveDefinitionsByObjType (   $a_type )

static

get active definitions by obj type

public

Parameters

string

obj_type

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

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilAdvancedMDValues\_cloneValues(), ilECSSettingsGUI\exportMappings(), ilECSSettingsGUI\importMappings(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), and ilECSSettingsGUI\initMappingsForm().

        {
                global $ilDB;
                
                $query = "SELECT field_id 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 active = 1 ".
                        "AND obj_type = ".$ilDB->quote($a_type,'text')." ".
                        "ORDER BY aro.record_id,position ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $field_ids[] = $row->field_id;
                }
                return $field_ids ? $field_ids : array();
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_getDefinitionsByRecordId (   $a_record_id )

static

get definitions

public

Parameters

int

record_id

Returns

array array(object) field definition objects

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

References $query, $res, $row, _getInstanceByFieldId(), and DB_FETCHMODE_OBJECT.

Referenced by ilAdvancedMDSettingsGUI\editRecord(), ilAdvancedMDRecordTableGUI\fillRow(), ilGlossaryAdvMetaDataAdapter\getAllFields(), ilLuceneAdvancedSearchFields\getFields(), ilAdvancedMetaDataExporter\getXmlRepresentation(), ilAdvancedMDRecordGUI\parseEditor(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableCells(), ilAdvancedMDRecordGUI\parseTableHead(), and ilAdvancedMDRecord\toXML().

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_mdf_definition ".
                        "WHERE record_id = ".$ilDB->quote($a_record_id ,'integer')." ".
                        "ORDER BY position ";
                $res = $ilDB->query($query);
                $defs = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $defs[] = self::_getInstanceByFieldId($row->field_id);
                }
                return $defs ? $defs : array(); 
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_getInstanceByFieldId (   $a_field_id )

static

Get instance by field_id.

public

Parameters

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

Referenced by _getDefinitionsByRecordId(), ilAdvancedMDSettingsGUI\addValue(), ilAdvancedMDSettingsGUI\confirmDeleteFields(), ilAdvancedMDSettingsGUI\createField(), ilAdvancedMDSettingsGUI\deleteFields(), ilAdvancedMDSettingsGUI\editField(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedMDSettingsGUI\initFormSubstitutions(), ilAdvancedMDRecordGUI\loadFromPost(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilECSSettingsGUI\prepareFieldSelection(), ilLuceneAdvancedSearchFields\readSections(), ilAdvancedMDSettingsGUI\saveField(), ilAdvancedSearchGUI\searchAdvancedMD(), ilAdvancedMDSettingsGUI\updateField(), and ilAdvancedMDSettingsGUI\updateFields().

        {
                if(isset(self::$instances[$a_field_id]))
                {
                        return self::$instances[$a_field_id];
                }
                return self::$instances[$a_field_id] = new ilAdvancedMDFieldDefinition($a_field_id);
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_getSearchableDefinitionIds ( )

static

Get searchable definition ids.

public

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

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilAdvancedSearchGUI\setSubTabs().

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_md_record amr ".
                        "JOIN adv_mdf_definition amfd ON amr.record_id = amfd.record_id ".
                        "WHERE active = 1 ".
                        "AND searchable = 1";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $field_ids[] = $row->field_id;
                }
                return $field_ids ? $field_ids : array();
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_lookupDateFields ( )

static

Lookup date fields.

public

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

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilAdvancedMDSubstitution\read().

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_mdf_definition ".
                        "WHERE field_type = ".$ilDB->quote(self::TYPE_DATE ,'integer')." ";
                $res = $ilDB->query($query);
                
                $date_fields = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $date_fields[] = $row->field_id; 
                }
                return $date_fields;
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_lookupDateTimeFields ( )

static

Lookup datetime fields.

public

Parameters

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

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_mdf_definition ".
                        "WHERE field_type = ".$ilDB->quote(self::TYPE_DATETIME ,'integer')." ";
                $res = $ilDB->query($query);
                
                $date_fields = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $date_fields[] = $row->field_id; 
                }
                return $date_fields;
        }

static ilAdvancedMDFieldDefinition::_lookupFieldId (   $a_import_id )

static

Lookup field id.

public

Parameters

string

import_id

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

References $query, $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by ilAdvancedMDParser\initValue(), and ilAdvancedMDValueParser\initValue().

        {
                global $ilDB;
                
                $query = "SELECT field_id FROM adv_mdf_definition ".
                        "WHERE import_id = ".$ilDB->quote($a_import_id,'text')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                return $row['field_id'] ? $row['field_id'] : 0;
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_lookupFieldType (   $a_field_id )

static

Lookup field type.

public

Parameters

int

field_id

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

References $query, $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by ilRemoteObjectBase\importMetadataFromJson(), and ilAdvancedMDValues\queryForRecords().

        {
                global $ilDB;
                
                $query = "SELECT field_type FROM adv_mdf_definition ".
                        "WHERE field_id = ".$ilDB->quote($a_field_id ,'integer')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                return $row['field_type'] ? $row['field_type'] : 0;
        }

Here is the caller graph for this function:

static ilAdvancedMDFieldDefinition::_lookupImportId (   $a_field_id )

static

Lookup import id.

public

Parameters

int

field_id

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

References $query, $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by ilAdvancedMDValue\appendXML(), and ilAdvancedMetaDataExporter\getXmlRepresentation().

        {
                global $ilDB;
                
                $query = "SELECT import_id FROM adv_mdf_definition ".
                        "WHERE field_id = ".$ilDB->quote($a_field_id,'integer')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                return $row['import_id'] ? $row['import_id'] : '';
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::add

(

)

add new field

public

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

References $position, $query, $res, generateImportId(), getDescription(), getFieldType(), getFieldValues(), getImportId(), getLastPosition(), getRecordId(), getTitle(), isRequired(), and isSearchable().

        {
                global $ilDB;
                
                sort($values = $this->getFieldValues(),SORT_STRING);
                
                $position = $this->getLastPosition();
                $next_id = $ilDB->nextId('adv_mdf_definition');
                
                $query = "INSERT INTO adv_mdf_definition (field_id,record_id,import_id,position,field_type, ".
                        "field_values,title,description,searchable,required) ".
                        "VALUES( ".
                        $ilDB->quote($next_id,'integer').",".
                        $this->db->quote($this->getRecordId(),'integer').", ".
                        $this->db->quote($this->getImportId(),'text').", ".
                        $this->db->quote($position + 1 ,'integer').", ".
                        $this->db->quote($this->getFieldType() ,'integer').", ".
                        $ilDB->quote(serialize($values),'text').", ".
                        $this->db->quote($this->getTitle() ,'text').", ".
                        $this->db->quote($this->getDescription() ,'text').", ".
                        $ilDB->quote($this->isSearchable(),'integer').", ".
                        $ilDB->quote($this->isRequired(),'integer')." ".
                        ")";
                $res = $ilDB->manipulate($query);
                $this->field_id = $next_id;
                
                if(!strlen($this->getImportId()))
                {
                        $query = "UPDATE adv_mdf_definition ".
                                "SET import_id = ".$this->db->quote($this->generateImportId(),'text')." ".
                                "WHERE field_id = ".$this->db->quote($this->field_id,'integer')." ";
                        $res = $ilDB->manipulate($query);                       
                }
                return true;
        }

Here is the call graph for this function:

ilAdvancedMDFieldDefinition::appendFieldValue

(

$a_value

)

Append field value.

public

Parameters

string

value

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

        {
                if(strlen(trim($a_value)))
                {
                        $this->field_values[] = trim($a_value);
                }
        }

ilAdvancedMDFieldDefinition::delete

(

)

delete field

public

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

References $query, $res, ilAdvancedMDValues\_deleteByFieldId(), and getFieldId().

        {
                global $ilDB;
                
                $query = "DELETE FROM adv_mdf_definition ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                // Also delete all values
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                ilAdvancedMDValues::_deleteByFieldId($this->getFieldId());
                return true;    
        }

Here is the call graph for this function:

ilAdvancedMDFieldDefinition::enableSearchable

(

$a_status

)

enable searchable

public

Parameters

bool	searchable

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

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

ilAdvancedMDFieldDefinition::generateImportId ( )

protected

generate unique record id

protected

Returns

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

References getFieldId().

Referenced by add(), and toXML().

        {
                return 'il_'.IL_INST_ID.'_adv_md_field_'.$this->getFieldId();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getDescription

(

)

get description

public

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

References $description.

Referenced by add(), toXML(), and update().

        {
                return $this->description;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getFieldId

(

)

get field_id

public

Parameters

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

References $field_id.

Referenced by delete(), generateImportId(), read(), and update().

        {
                return $this->field_id;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getFieldType

(

)

get field type

public

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

References $field_type.

Referenced by add(), toXML(), update(), and validate().

        {
                return $this->field_type;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getFieldValues

(

)

get field values

public

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

References $field_values.

Referenced by add(), toXML(), and update().

        {
                return $this->field_values;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getFieldValuesForSearch

(

)

get field values for select

public

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

References $lng.

        {
                global $lng;
                
                $values = array(0 => $lng->txt('search_any'));
                foreach($this->field_values as $value)
                {
                        $values[$value] = $value;
                }
                return $values;
        }

ilAdvancedMDFieldDefinition::getFieldValuesForSelect

(

)

get field values for select

public

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

References $lng.

        {
                global $lng;
                
                $values = array(0 => $lng->txt('select_one'));
                foreach($this->field_values as $value)
                {
                        $values[$value] = $value;
                }
                return $values;
        }

ilAdvancedMDFieldDefinition::getImportId

(

)

get import_id

public

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

References $import_id.

Referenced by add(), and update().

        {
                return $this->import_id;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getLastPosition ( )

private

get last position of record

private

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

References $query, $res, $row, DB_FETCHMODE_OBJECT, and getRecordId().

Referenced by add().

        {
                $query = "SELECT max(position) pos FROM adv_mdf_definition ".
                        "WHERE record_id = ".$this->db->quote($this->getRecordId() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->pos;
                }
                return 0;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getPosition

(

)

get position

public

Parameters

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

References $position.

Referenced by toXML(), and update().

        {
                return $this->position;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getRecordId

(

)

get record id

public

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

References $record_id.

Referenced by add(), getLastPosition(), and update().

        {
                return $this->record_id;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::getTitle

(

)

get title

public

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

References $title.

Referenced by add(), toXML(), update(), and validate().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::isDeleted

(

)

is deleted

public

Parameters

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

        {
                return $this->record_id ? false : true;
        }

ilAdvancedMDFieldDefinition::isRequired

(

)

is required field

public

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

References $required.

Referenced by add(), and update().

        {
                return $this->required;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::isSearchable

(

)

is searchable

public

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

References $searchable.

Referenced by add(), toXML(), and update().

        {
                return (bool) $this->searchable;
        }

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::read ( )

private

read field definition

private

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

References $query, $res, $row, DB_FETCHMODE_OBJECT, and getFieldId().

Referenced by __construct().

        {
                global $ilDB;
                
                if(!$this->field_id)
                {
                        return false;
                }
                $query = "SELECT * FROM adv_mdf_definition ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId() ,'integer')." ";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->record_id = $row->record_id;
                        $this->import_id = $row->import_id;
                        $this->position = $row->position;
                        $this->field_type = $row->field_type;
                        $this->field_values = unserialize(stripslashes($row->field_values));
                        $this->title = $row->title;
                        $this->description = $row->description;
                        $this->searchable = $row->searchable;
                        $this->required = $row->required;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilAdvancedMDFieldDefinition::setDescription

(

$a_desc

)

set description

public

Parameters

string

description

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

        {
                $this->description = $a_desc;
        }

ilAdvancedMDFieldDefinition::setFieldType

(

$a_type_id

)

set field type

public

Parameters

int	field type

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

        {
                $this->field_type = $a_type_id;
        }

ilAdvancedMDFieldDefinition::setFieldValues

(

$a_values

)

set field values

public

Parameters

array

array(string) valid field values

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

        {
                $this->field_values = $a_values;
        }

ilAdvancedMDFieldDefinition::setImportId

(

$a_id_string

)

set import id

public

Parameters

string

import id

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

        {
                $this->import_id = $a_id_string;
        }

ilAdvancedMDFieldDefinition::setPosition

(

$a_pos

)

set position

public

Parameters

int

position

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

        {
                $this->position = $a_pos;
        }

ilAdvancedMDFieldDefinition::setRecordId

(

$a_id

)

set record id

public

Parameters

int

record id

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

        {
                $this->record_id = $a_id;
        }

ilAdvancedMDFieldDefinition::setTitle

(

$a_title

)

set title

public

Parameters

string

title

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

        {
                $this->title = $a_title;
        }

ilAdvancedMDFieldDefinition::toXML

(

ilXmlWriter

$writer

)

To Xml.

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

public

Parameters

object

ilXmlWriter

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

References generateImportId(), getDescription(), getFieldType(), getFieldValues(), getPosition(), getTitle(), isSearchable(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

         {
                switch($this->getFieldType())
                {
                        case self::TYPE_TEXT:
                                $type = 'Text';
                                break;
                                
                        case self::TYPE_SELECT:
                                $type = 'Select';
                                break;
                                
                        case self::TYPE_DATE:
                                $type = 'Date';
                                break;
                                
                        case self::TYPE_DATETIME:
                                $type = 'DateTime';
                                break;
                }
                
                
                $writer->xmlStartTag('Field',array(
                        'id' => $this->generateImportId(),
                        'searchable' => ($this->isSearchable() ? 'Yes' : 'No'),
                        'fieldType'      => $type));
                
                $writer->xmlElement('FieldTitle',null,$this->getTitle());
                $writer->xmlElement('FieldDescription',null,$this->getDescription());
                $writer->xmlElement('FieldPosition',null,$this->getPosition());
                
                foreach($this->getFieldValues() as $value)
                {
                        if(strlen($value))
                        {
                                $writer->xmlElement('FieldValue',null,$value);
                        }
                }
                
                $writer->xmlEndTag('Field');
         }

Here is the call graph for this function:

ilAdvancedMDFieldDefinition::update

(

)

update

public

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

References $query, $res, getDescription(), getFieldId(), getFieldType(), getFieldValues(), getImportId(), getPosition(), getRecordId(), getTitle(), isRequired(), and isSearchable().

        {
                global $ilDB;
                
                $query = "UPDATE adv_mdf_definition ".
                        "SET record_id = ".$this->db->quote($this->getRecordId() ,'integer').", ".
                        "import_id = ".$this->db->quote($this->getImportId() ,'text').", ".
                        "position = ".$this->db->quote($this->getPosition() ,'integer').", ".
                        "field_type = ".$this->db->quote($this->getFieldType() ,'integer').", ".
                        "field_values = ".$ilDB->quote(serialize($this->getFieldValues()),'text').", ".
                        "title = ".$this->db->quote($this->getTitle() ,'text').", ".
                        "description = ".$this->db->quote($this->getDescription() ,'text').", ".
                        "searchable = ".$ilDB->quote($this->isSearchable() ,'integer').", ".
                        "required = ".$ilDB->quote($this->isRequired(),'integer')." ".
                        "WHERE field_id = ".$this->db->quote($this->getFieldId() ,'integer')." ";
                $res = $ilDB->manipulate($query);                                               
                return true;
        }

Here is the call graph for this function:

ilAdvancedMDFieldDefinition::validate

(

)

validate

public

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

References $ilErr, $lng, getFieldType(), and getTitle().

        {
                global $ilErr,$lng;
                
                if(!strlen($this->getTitle()) or !$this->getFieldType())
                {
                        $ilErr->setMessage('fill_out_all_required_fields');
                        return false;
                }
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilAdvancedMDFieldDefinition::$db = null

protected

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

ilAdvancedMDFieldDefinition::$description

protected

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

Referenced by getDescription().

ilAdvancedMDFieldDefinition::$field_id

protected

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

Referenced by getFieldId().

ilAdvancedMDFieldDefinition::$field_type

protected

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

Referenced by getFieldType().

ilAdvancedMDFieldDefinition::$field_values = array()

protected

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

Referenced by getFieldValues().

ilAdvancedMDFieldDefinition::$import_id

protected

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

Referenced by getImportId().

ilAdvancedMDFieldDefinition::$instances = array()

staticprivate

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

ilAdvancedMDFieldDefinition::$position

protected

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

Referenced by add(), and getPosition().

ilAdvancedMDFieldDefinition::$record_id

protected

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

Referenced by getRecordId().

ilAdvancedMDFieldDefinition::$required = false

protected

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

Referenced by isRequired().

ilAdvancedMDFieldDefinition::$searchable

protected

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

Referenced by isSearchable().

ilAdvancedMDFieldDefinition::$title

protected

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

Referenced by getTitle().

const ilAdvancedMDFieldDefinition::TYPE_DATE = 3

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

Referenced by ilAdvancedMDFieldTableGUI\fillRow(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedMDRecordParser\handlerBeginTag(), ilRemoteObjectBase\importMetadataFromJson(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDRecordGUI\loadFromPost(), ilTermListTableGUI\numericOrdering(), ilPresentationListTableGUI\numericOrdering(), ilAdvancedMDRecordGUI\parseEditor(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDSearch\performSearch(), ilAdvancedMDValues\queryForRecords(), and ilAdvancedSearchGUI\searchAdvancedMD().

const ilAdvancedMDFieldDefinition::TYPE_DATETIME = 4

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

Referenced by ilAdvancedMDFieldTableGUI\fillRow(), ilPresentationListTableGUI\fillRow(), ilTermListTableGUI\fillRow(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedMDRecordParser\handlerBeginTag(), ilRemoteObjectBase\importMetadataFromJson(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDRecordGUI\loadFromPost(), ilAdvancedMDRecordGUI\parseEditor(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDSearch\performSearch(), ilAdvancedMDValues\queryForRecords(), and ilAdvancedSearchGUI\searchAdvancedMD().

const ilAdvancedMDFieldDefinition::TYPE_SELECT = 1

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

Referenced by ilAdvancedMDFieldTableGUI\fillRow(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedMDRecordParser\handlerBeginTag(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDRecordGUI\parseEditor(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDSearch\performSearch(), ilAdvancedSearchGUI\searchAdvancedMD(), and ilAdvancedMDRecordGUI\showECSStart().

const ilAdvancedMDFieldDefinition::TYPE_TEXT = 2

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

Referenced by ilAdvancedMDFieldTableGUI\fillRow(), ilLuceneAdvancedSearchFields\getFormElement(), ilAdvancedMDRecordParser\handlerBeginTag(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDRecordGUI\parseEditor(), ilLuceneAdvancedSearchFields\parseFieldQuery(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDSearch\performSearch(), and ilAdvancedMDRecordGUI\showECSStart().

---

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

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