ilAdvancedMDFieldDefinitionInteger Class Reference

AMD field type integer. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionInteger:

Collaboration diagram for ilAdvancedMDFieldDefinitionInteger:

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

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

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

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

Detailed Description

AMD field type integer.

Author

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

Version

$Id$

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

Member Function Documentation

addCustomFieldToDefinitionForm()

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

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled

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

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

        {
                global $lng;
                
                $min = new ilNumberInputGUI($lng->txt("md_adv_number_min"), "min");             
                $min->setValue($this->getMin());
                $min->setSize(10);
                $a_form->addItem($min);
                
                $max = new ilNumberInputGUI($lng->txt("md_adv_number_max"), "max");
                $max->setValue($this->getMax());
                $max->setSize(10);
                $a_form->addItem($max);
                
                $suffix = new ilTextInputGUI($lng->txt("md_adv_number_suffix"), "suffix");
                $suffix->setValue($this->getSuffix());          
                $suffix->setSize(10);
                $a_form->addItem($suffix);
                                
                if($a_disabled)
                {
                        $min->setDisabled(true);
                        $max->setDisabled(true);
                        $suffix->setDisabled(true);
                }                                               
        }

Here is the call graph for this function:

addPropertiesToXML()

ilAdvancedMDFieldDefinitionInteger::addPropertiesToXML ( ilXmlWriter  $a_writer )

protected

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

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

        {                               
                $a_writer->xmlElement('FieldValue',array("id"=>"min"),$this->getMin());                                 
                $a_writer->xmlElement('FieldValue',array("id"=>"max"),$this->getMax());                                 
                $a_writer->xmlElement('FieldValue',array("id"=>"suffix"),$this->getSuffix());                                   
        }       

Here is the call graph for this function:

getFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinition ( )

protected

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

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

        {
                return array(
                        "min" => $this->getMin(),
                        "max" => $this->getMax(),
                        "suffix" => $this->getSuffix()
                );
        }

Here is the call graph for this function:

getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionInteger::getFieldDefinitionForTableGUI

(

)

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

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

        {
                global $lng;
        
                $res = array();
                
                if($this->getMin() !== null)
                {
                        $res[$lng->txt("md_adv_number_min")] = $this->getMin();
                }
                if($this->getMax() !== null)
                {
                        $res[$lng->txt("md_adv_number_max")] = $this->getMax();
                }
                if($this->getSuffix())
                {
                        $res[$lng->txt("md_adv_number_suffix")] = $this->getSuffix();
                }
                
                return $res;
        }

Here is the call graph for this function:

getMax()

ilAdvancedMDFieldDefinitionInteger::getMax

(

)

Get max.

Returns

int

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

References $max.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinition(), getFieldDefinitionForTableGUI(), initADTDefinition(), and ilAdvancedMDFieldDefinitionFloat\initADTDefinition().

        {
                return $this->max;
        }

Here is the caller graph for this function:

getMin()

ilAdvancedMDFieldDefinitionInteger::getMin

(

)

Get min.

Returns

int

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

References $min.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinition(), getFieldDefinitionForTableGUI(), initADTDefinition(), and ilAdvancedMDFieldDefinitionFloat\initADTDefinition().

        {
                return $this->min;
        }

Here is the caller graph for this function:

getSuffix()

ilAdvancedMDFieldDefinitionInteger::getSuffix

(

)

Get suffix.

Returns

string

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

References $suffix.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinition(), getFieldDefinitionForTableGUI(), initADTDefinition(), and ilAdvancedMDFieldDefinitionFloat\initADTDefinition().

        {
                return $this->suffix;
        }

Here is the caller graph for this function:

getType()

ilAdvancedMDFieldDefinitionInteger::getType

(

)

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

        {
                return self::TYPE_INTEGER;
        }

getValueForXML()

ilAdvancedMDFieldDefinitionInteger::getValueForXML

(

ilADT

$element

)

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

        {
                return $element->getNumber();
        }

importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionInteger::importCustomDefinitionFormPostValues

(

ilPropertyFormGUI

$a_form

)

Import custom post values from definition form.

Parameters

ilPropertyFormGUI

$a_form

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

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

        {                               
                $min = $a_form->getInput("min");                
                $this->setMin(($min !== "") ? $min : null);
                
                $max = $a_form->getInput("max");
                $this->setMax(($max !== "") ? $max : null);     
                
                $suffix = $a_form->getInput("suffix");
                $this->setSuffix(($suffix !== "") ? $suffix : null);    
        }       

Here is the call graph for this function:

importFieldDefinition()

ilAdvancedMDFieldDefinitionInteger::importFieldDefinition ( array  $a_def )

protected

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

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

        {               
                $this->setMin($a_def["min"]);
                $this->setMax($a_def["max"]);
                $this->setSuffix($a_def["suffix"]);
        }

Here is the call graph for this function:

importValueFromXML()

ilAdvancedMDFieldDefinitionInteger::importValueFromXML

(

$a_cdata

)

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

References ilAdvancedMDFieldDefinition\getADT().

        {
                $this->getADT()->setNumber($a_cdata);
        }       

Here is the call graph for this function:

importXMLProperty()

ilAdvancedMDFieldDefinitionInteger::importXMLProperty	(		$a_key,
			$a_value
	)

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

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

        {
                if($a_key == "min")
                {
                        $this->setMin($a_value != "" ? $a_value : null);
                }
                if($a_key == "max")
                {
                        $this->setMax($a_value != "" ? $a_value : null);
                }
                if($a_key == "suffix")
                {
                        $this->setSuffix($a_value != "" ? $a_value : null);
                }
        }               

Here is the call graph for this function:

initADTDefinition()

ilAdvancedMDFieldDefinitionInteger::initADTDefinition ( )

protected

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

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

        {                               
                $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Integer");

                $def->setMin($this->getMin());
                $def->setMax($this->getMax());
                $def->setSuffix($this->getSuffix());
                
                return $def;
        }       

Here is the call graph for this function:

isFilterSupported()

ilAdvancedMDFieldDefinitionInteger::isFilterSupported

(

)

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

        {
                return false;
        }

setMax()

ilAdvancedMDFieldDefinitionInteger::setMax

(

$a_value

)

Set max.

Parameters

int

$a_value

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

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

        {
                if($a_value !== null)
                {
                        $a_value = (int)$a_value;
                }
                $this->max = $a_value;
        }

Here is the caller graph for this function:

setMin()

ilAdvancedMDFieldDefinitionInteger::setMin

(

$a_value

)

Set min.

Parameters

int

$a_value

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

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

        {
                if($a_value !== null)
                {
                        $a_value = (int)$a_value;
                }
                $this->min = $a_value;
        }

Here is the caller graph for this function:

setSuffix()

ilAdvancedMDFieldDefinitionInteger::setSuffix

(

$a_value

)

Set suffix.

Parameters

string

$a_value

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

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

        {
                if($a_value !== null)
                {
                        $a_value = trim($a_value);
                }
                $this->suffix = $a_value;
        }

Here is the caller graph for this function:

Field Documentation

$max

ilAdvancedMDFieldDefinitionInteger::$max

protected

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

Referenced by addCustomFieldToDefinitionForm(), getMax(), and importCustomDefinitionFormPostValues().

$min

ilAdvancedMDFieldDefinitionInteger::$min

protected

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

Referenced by addCustomFieldToDefinitionForm(), getMin(), and importCustomDefinitionFormPostValues().

$suffix

ilAdvancedMDFieldDefinitionInteger::$suffix

protected

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

Referenced by addCustomFieldToDefinitionForm(), getSuffix(), and importCustomDefinitionFormPostValues().

---

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

• Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionInteger.php