AMD field type text. More...

Inheritance diagram for ilAdvancedMDFieldDefinitionText:

Collaboration diagram for ilAdvancedMDFieldDefinitionText:

Public Member Functions
	getType ()
	Get type. More...

	setMaxLength ($a_value)
	Set max length. More...

	getMaxLength ()
	Get max length. More...

	setMulti ($a_value)
	Set multi-line. More...

	isMulti ()
	Is multi-line? More...

	getFieldDefinitionForTableGUI ()
	Parse properties for table gui. More...

	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)
	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 (ilADTTextFormBridge $a_text)

	getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
	Get value for search query parser. More...

	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $a_search_type)
	Search. More...

Public Member Functions inherited from ilAdvancedMDFieldDefinition
	__construct ($a_field_id=null)
	Constructor. More...

	getType ()
	Get type. More...

	getTypeTitle ()
	Get type title (lang id) More...

	getADTDefinition ()
	Get ADT definition instance. More...

	getADT ()
	Get ADT instance. More...

	getFieldId ()
	Get field_id. More...

	setRecordId ($a_id)
	Set record id. More...

	getRecordId ()
	Get record id. More...

	setImportId ($a_id_string)
	Set import id. More...

	getImportId ()
	Get import id. More...

	setPosition ($a_pos)
	Set position. More...

	getPosition ()
	Get position. More...

	setTitle ($a_title)
	Get title. More...

	getTitle ()
	Get title. More...

	setDescription ($a_desc)
	Set description. More...

	getDescription ()
	Get description. More...

	isSearchSupported ()
	Is search supported at all. More...

	isFilterSupported ()
	Is search by filter supported. More...

	setSearchable ($a_status)
	Toggle searchable. More...

	isSearchable ()
	Is searchable. More...

	setRequired ($a_status)
	Toggle required. More...

	isRequired ()
	Is required field. More...

	getFieldDefinitionForTableGUI ()
	Parse properties for table gui. More...

	addToFieldDefinitionForm (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
	Add input elements to definition form. More...

	importCustomDefinitionFormPostValues (ilPropertyFormGUI $a_form)
	Import custom post values from definition form. More...

	importDefinitionFormPostValues (ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
	Import post values from definition form. More...

	importDefinitionFormPostValuesNeedsConfirmation ()

	prepareCustomDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	prepareDefinitionFormConfirmation (ilPropertyFormGUI $a_form)

	generateImportId ($a_field_id)
	Generate unique record id. More...

	save ()
	Create new field entry. More...

	update ()
	Update field entry. More...

	delete ()
	Delete field entry. More...

	toXML (ilXmlWriter $a_writer)
	To Xml. More...

	importXMLProperty ($a_key, $a_value)
	Import property from XML. More...

	getValueForXML (ilADT $element)
	Parse ADT value for xml (export) More...

	importValueFromXML ($a_cdata)
	Import value from xml. More...

	importFromECS ($a_ecs_type, $a_value, $a_sub_id)
	Import meta data from ECS. More...

	prepareElementForEditor (ilADTFormBridge $a_bridge)
	Prepare editor form elements. More...

	getSearchQueryParserValue (ilADTSearchBridge $a_adt_search)
	Get value for search query parser. More...

	getSearchValueSerialized (ilADTSearchBridge $a_adt_search)
	Get value for search persistence. More...

	setSearchValueSerialized (ilADTSearchBridge $a_adt_search, $a_value)
	Set value from search persistence. More...

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

	searchObjects (ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $a_search_type)
	Search objects. More...

	getLuceneSearchString ($a_value)
	Get search string in lucene syntax. More...

	prepareElementForSearch (ilADTSearchBridge $a_bridge)
	Prepare search form elements. More...

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

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

	getFieldDefinition ()
	Get (type-specific) 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 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
	$max_length

	$multi

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 text.

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

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

ilAdvancedMDFieldDefinitionText::addCustomFieldToDefinitionForm	(	ilPropertyFormGUI	$a_form,
			$a_disabled = `false`
	)

Add input elements to definition form.

Parameters

ilPropertyFormGUI	$a_form
bool	$a_disabled

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 141 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                global $lng;
                
                $max = new ilNumberInputGUI($lng->txt("md_adv_text_max_length"), "max");
                $max->setValue($this->getMaxLength());
                $max->setSize(10);              
                $max->setMinValue(1);
                $max->setMaxValue(4000); // DB limit
                $a_form->addItem($max);
                
                $multi = new ilCheckboxInputGUI($lng->txt("md_adv_text_multi"), "multi");
                $multi->setValue(1);
                $multi->setChecked($this->isMulti());
                $a_form->addItem($multi);               
                                
                if($a_disabled)
                {                       
                        $max->setDisabled(true);
                        $multi->setDisabled(true);
                }                                               
        }

References $lng, $multi, ilPropertyFormGUI\addItem(), getMaxLength(), and isMulti().

Here is the call graph for this function:

◆ addPropertiesToXML()

ilAdvancedMDFieldDefinitionText::addPropertiesToXML ( ilXmlWriter $a_writer )

protected

Add (type-specific) properties to xml export.

Parameters

ilXmlWriter $a_writer

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 181 of file class.ilAdvancedMDFieldDefinitionText.php.

        {                                                               
                $a_writer->xmlElement('FieldValue',array("id"=>"max"),$this->getMaxLength());                                   
                $a_writer->xmlElement('FieldValue',array("id"=>"multi"),$this->isMulti());                                      
        }       

References getMaxLength(), isMulti(), and ilXmlWriter\xmlElement().

Here is the call graph for this function:

◆ getFieldDefinition()

ilAdvancedMDFieldDefinitionText::getFieldDefinition ( )

protected

Get (type-specific) field definition.

Returns: array

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 109 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                return array(                   
                        "max" => $this->getMaxLength(),
                        "multi" => $this->isMulti()
                );
        }

References getMaxLength(), and isMulti().

Here is the call graph for this function:

◆ getFieldDefinitionForTableGUI()

ilAdvancedMDFieldDefinitionText::getFieldDefinitionForTableGUI ( )

Parse properties for table gui.

Returns: array

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 117 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                global $lng;
        
                $res = array();
                
                if($this->getMaxLength() !== null)
                {
                        $res[$lng->txt("md_adv_text_max_length")] = $this->getMaxLength();
                }
                if($this->isMulti())
                {
                        $res[$lng->txt("md_adv_text_multi")] = $lng->txt("yes");
                }
                
                return $res;
        }

References $lng, $res, getMaxLength(), and isMulti().

Here is the call graph for this function:

◆ getMaxLength()

ilAdvancedMDFieldDefinitionText::getMaxLength ( )

Get max length.

Returns: int

Definition at line 73 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                return $this->max_length;
        }

References $max_length.

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

Here is the caller graph for this function:

◆ getSearchQueryParserValue()

ilAdvancedMDFieldDefinitionText::getSearchQueryParserValue ( ilADTSearchBridge $a_adt_search )

Get value for search query parser.

Parameters

ilADTSearchBridge $a_adt_search

Returns: mixed

Reimplemented from ilAdvancedMDFieldDefinition.

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

        {
                return $a_adt_search->getADT()->getText();
        }

◆ getType()

ilAdvancedMDFieldDefinitionText::getType ( )

Get type.

Returns: int

Reimplemented from ilAdvancedMDFieldDefinition.

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

        {
                return self::TYPE_TEXT;
        }

References ilAdvancedMDFieldDefinition\TYPE_TEXT.

◆ getValueForXML()

ilAdvancedMDFieldDefinitionText::getValueForXML ( ilADT $element )

Parse ADT value for xml (export)

Parameters

ilADT $element

Returns: string

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 199 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                return $element->getText();
        }

◆ importCustomDefinitionFormPostValues()

ilAdvancedMDFieldDefinitionText::importCustomDefinitionFormPostValues ( ilPropertyFormGUI $a_form )

Import custom post values from definition form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 169 of file class.ilAdvancedMDFieldDefinitionText.php.

        {                                               
                $max = $a_form->getInput("max");
                $this->setMaxLength(($max !== "") ? $max : null);       
                
                $this->setMulti($a_form->getInput("multi"));
        }       

References ilPropertyFormGUI\getInput(), setMaxLength(), and setMulti().

Here is the call graph for this function:

◆ importFieldDefinition()

ilAdvancedMDFieldDefinitionText::importFieldDefinition ( array $a_def )

protected

Import (type-specific) field definition from DB.

Parameters

array $a_def

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 103 of file class.ilAdvancedMDFieldDefinitionText.php.

        {               
                $this->setMaxLength($a_def["max"]);             
                $this->setMulti($a_def["multi"]);
        }

References setMaxLength(), and setMulti().

Here is the call graph for this function:

◆ importFromECS()

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

Import meta data from ECS.

Parameters

int	$a_ecs_type
mixed	$a_value
string	$a_sub_id

Returns: bool

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 209 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                switch($a_ecs_type)
                {
                        case ilECSUtils::TYPE_ARRAY:
                                $value = implode(',', (array)$a_value);
                                break;
 
                        case ilECSUtils::TYPE_INT:
                                $value = (int)$a_value;
                                break;
 
                        case ilECSUtils::TYPE_STRING:
                                $value = (string)$a_value;
                                break;
 
                        case ilECSUtils::TYPE_TIMEPLACE:        
                                if($a_value instanceof ilECSTimePlace)                          
                                {
                                        $value = $a_value->{'get'.ucfirst($a_sub_id)}();                                                                                
                                }
                                break;
                }
                
                if(trim($value))
                {
                        $this->getADT()->setText($value);
                        return true;
                }               
                return false;
        }       

References ilECSUtils\TYPE_ARRAY, ilECSUtils\TYPE_INT, ilECSUtils\TYPE_STRING, and ilECSUtils\TYPE_TIMEPLACE.

◆ importValueFromXML()

ilAdvancedMDFieldDefinitionText::importValueFromXML ( $a_cdata )

Import value from xml.

Parameters

string $a_cdata

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 204 of file class.ilAdvancedMDFieldDefinitionText.php.

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

References ilAdvancedMDFieldDefinition\getADT().

Here is the call graph for this function:

◆ importXMLProperty()

ilAdvancedMDFieldDefinitionText::importXMLProperty	(	$a_key,
		$a_value
	)

Import property from XML.

Parameters

string	$a_key
string	$a_value

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 187 of file class.ilAdvancedMDFieldDefinitionText.php.

        {               
                if($a_key == "max")
                {
                        $this->setMaxLength($a_value != "" ? $a_value : null);
                }
                if($a_key == "multi")
                {
                        $this->setMulti($a_value != "" ? $a_value : null);
                }
        }               

References setMaxLength(), and setMulti().

Here is the call graph for this function:

◆ initADTDefinition()

ilAdvancedMDFieldDefinitionText::initADTDefinition ( )

protected

Init adt instance.

Returns: ilADTDefinition

Reimplemented from ilAdvancedMDFieldDefinition.

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

        {               
                $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("Text");
                                
                $max = $this->getMaxLength();
                if(is_numeric($max))
                {
                        $def->setMaxLength($max);
                }
                
                // multi-line is presentation property
                
                return $def;
        }                       

References ilADTFactory\getInstance(), and getMaxLength().

Here is the call graph for this function:

◆ isMulti()

ilAdvancedMDFieldDefinitionText::isMulti ( )

Is multi-line?

Returns: bool

Definition at line 93 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                return $this->multi;
        }

References $multi.

Referenced by addCustomFieldToDefinitionForm(), addPropertiesToXML(), getFieldDefinition(), and getFieldDefinitionForTableGUI().

Here is the caller graph for this function:

◆ parseSearchObjects()

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

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 261 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                global $ilDB;
                
                $res = array();
                
                $obj_ids = array();
                foreach($a_records as $record)
                {                       
                        if($record["sub_type"] == "-")
                        {
                                // keep found information
                                $obj_ids[$record["obj_id"]] = $record;
                        }
                }
                
                $sql = "SELECT obj_id,type".
                        " FROM object_data".
                        " WHERE ".$ilDB->in("obj_id", array_keys($obj_ids), "", "integer").
                        " AND ".$ilDB->in("type", $a_object_types, "", "text");         
                $set = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($set))
                {                       
                        $row["found"] = array();
                        foreach($obj_ids[$row["obj_id"]] as $field => $value)
                        {
                                if(substr($field, 0, 5) == "found")
                                {
                                        $row["found"][$field] = $value;
                                }
                        }
                        $res[] = $row;
                }
                
                return $res;
        }

References $ilDB, $res, and $row.

◆ prepareElementForEditor()

ilAdvancedMDFieldDefinitionText::prepareElementForEditor ( ilADTTextFormBridge $a_text )

Definition at line 245 of file class.ilAdvancedMDFieldDefinitionText.php.

        {
                // seems to be default in course info editor
                $a_text->setMulti($this->isMulti(), 80, 6);             
        }

References ilADTTextFormBridge\setMulti().

Here is the call graph for this function:

◆ searchObjects()

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

Search.

Parameters

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

Returns: array

Reimplemented from ilAdvancedMDFieldDefinition.

Definition at line 308 of file class.ilAdvancedMDFieldDefinitionText.php.

        {                                                                                                                               
                // :TODO: search type (like, fulltext)
                
                include_once('Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php');                                            
                $condition = $a_adt_search->getSQLCondition(
                        ilADTActiveRecordByType::SINGLE_COLUMN_NAME,                    
                        ilADTTextSearchBridgeSingle::SQL_LIKE, 
                        $a_parser->getQuotedWords());           
                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();
                }               
        }

References ilADTActiveRecordByType\find(), ilQueryParser\getQuotedWords(), ilADTSearchBridge\getSQLCondition(), ilADTActiveRecordByType\SINGLE_COLUMN_NAME, and ilADTTextSearchBridgeSingle\SQL_LIKE.

Here is the call graph for this function:

◆ setMaxLength()

ilAdvancedMDFieldDefinitionText::setMaxLength ( $a_value )

Set max length.

Parameters

int $a_value

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

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

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

Here is the caller graph for this function:

◆ setMulti()

ilAdvancedMDFieldDefinitionText::setMulti ( $a_value )

Set multi-line.

Parameters

string $a_value

Definition at line 83 of file class.ilAdvancedMDFieldDefinitionText.php.

        {               
                $this->multi = (bool)$a_value;
        }

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

Here is the caller graph for this function:

Field Documentation

◆ $max_length

ilAdvancedMDFieldDefinitionText::$max_length

protected

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

Referenced by getMaxLength().

◆ $multi

ilAdvancedMDFieldDefinitionText::$multi

protected

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

Referenced by addCustomFieldToDefinitionForm(), and isMulti().

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

Services/AdvancedMetaData/classes/Types/class.ilAdvancedMDFieldDefinitionText.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomFieldToDefinitionForm()

◆ addPropertiesToXML()

◆ getFieldDefinition()

◆ getFieldDefinitionForTableGUI()

◆ getMaxLength()

◆ getSearchQueryParserValue()

◆ getType()

◆ getValueForXML()

◆ importCustomDefinitionFormPostValues()

◆ importFieldDefinition()

◆ importFromECS()

◆ importValueFromXML()

◆ importXMLProperty()

◆ initADTDefinition()

◆ isMulti()

◆ parseSearchObjects()

◆ prepareElementForEditor()

◆ searchObjects()

◆ setMaxLength()

◆ setMulti()

Field Documentation

◆ $max_length

◆ $multi