4require_once 
"Services/ADT/classes/class.ilADTFactory.php";
 
   48        $this->
read($a_field_id);
 
   65            $set = 
$ilDB->query(
"SELECT field_type" .
 
   66                " FROM adv_mdf_definition" .
 
   67                " WHERE field_id = " . 
$ilDB->quote($a_field_id, 
"integer"));
 
   72        if (self::isValidType(
$a_type)) {
 
   74            require_once 
"Services/AdvancedMetaData/classes/Types/class." . $class . 
".php";
 
   75            return new $class($a_field_id);
 
   86    public static function exists($a_field_id)
 
   92        $set = 
$ilDB->query(
"SELECT field_type" .
 
   93            " FROM adv_mdf_definition" .
 
   94            " WHERE field_id = " . 
$ilDB->quote($a_field_id, 
"integer"));
 
   95        if (
$ilDB->fetchAssoc($set)) {
 
  111            self::TYPE_TEXT => 
"Text",
 
  112            self::TYPE_SELECT => 
"Select",
 
  113            self::TYPE_DATE => 
"Date",
 
  114            self::TYPE_DATETIME => 
"DateTime",
 
  115            self::TYPE_FLOAT => 
"Float",
 
  116            self::TYPE_LOCATION => 
"Location",
 
  117            self::TYPE_INTEGER => 
"Integer",
 
  118            self::TYPE_SELECT_MULTI => 
"SelectMulti"    ,
 
  119            self::TYPE_EXTERNAL_LINK => 
'ExternalLink',
 
  120            self::TYPE_INTERNAL_LINK => 
'InternalLink',
 
  121            self::TYPE_ADDRESS => 
"Address" 
  123        $map = array_flip($map);
 
  124        if (array_key_exists(
$a_type, $map)) {
 
  144        $query = 
"SELECT * FROM adv_mdf_definition" .
 
  145            " WHERE record_id = " . 
$ilDB->quote($a_record_id, 
"integer");
 
  146        if ($a_only_searchable) {
 
  147            $query .= 
" AND searchable = " . 
$ilDB->quote(1, 
"integer");
 
  149        $query .= 
" ORDER BY position";
 
  151        while ($row = 
$ilDB->fetchAssoc($set)) {
 
  153            $field->import($row);
 
  154            $defs[$row[
"field_id"]] = $field;
 
  168        $query = 
"SELECT amf.* FROM adv_md_record_objs aro" .
 
  169            " JOIN adv_md_record amr ON aro.record_id = amr.record_id" .
 
  170            " JOIN adv_mdf_definition amf ON aro.record_id = amf.record_id" .
 
  171            " WHERE obj_type = " . 
$ilDB->quote($a_obj_type, 
'text');
 
  172        if ((
bool) $a_active_only) {
 
  173            $query .= 
" AND active = " . 
$ilDB->quote(1, 
"integer");
 
  175        $query .= 
" ORDER BY aro.record_id,position";
 
  179            $field->import($row);
 
  180            $defs[$row[
"field_id"]] = $field;
 
  197        $query = 
"SELECT field_id, field_type FROM adv_mdf_definition" .
 
  198            " WHERE import_id = " . 
$ilDB->quote($a_import_id, 
'text');
 
  200        if (
$ilDB->numRows($set)) {
 
  201            $row = 
$ilDB->fetchAssoc($set);
 
  217        $field_ids = array();
 
  219        $query = 
"SELECT field_id FROM adv_md_record amr" .
 
  220            " JOIN adv_mdf_definition amfd ON (amr.record_id = amfd.record_id)" .
 
  221            " WHERE active = " . 
$ilDB->quote(1, 
"integer") .
 
  222            " AND searchable = " . 
$ilDB->quote(1, 
"integer");
 
  224        while ($row = 
$ilDB->fetchAssoc($set)) {
 
  225            $field_ids[] = $row[
"field_id"];
 
  239        $group_def = 
$factory->getDefinitionInstanceByType(
"Group");
 
  240        foreach ($a_defs as $def) {
 
  241            $group_def->addElement($def->getFieldId(), $def->getADTDefinition());
 
  243        $group = 
$factory->getInstanceByDefinition($group_def);
 
  246        foreach ($group->getElements() as $element_id => $element) {
 
  247            $a_defs[$element_id]->setADT($element);
 
  282            self::TYPE_SELECT_MULTI,
 
  283            self::TYPE_EXTERNAL_LINK,
 
  284            self::TYPE_INTERNAL_LINK,
 
  297        return in_array((
int) 
$a_type, self::getValidTypes());
 
  315        if (self::isValidType(
$a_type)) {
 
  317                self::TYPE_TEXT => 
"Text",
 
  318                self::TYPE_SELECT => 
"Select",
 
  319                self::TYPE_DATE => 
"Date",
 
  320                self::TYPE_DATETIME => 
"DateTime",
 
  321                self::TYPE_FLOAT => 
"Float",
 
  322                self::TYPE_LOCATION => 
"Location",
 
  323                self::TYPE_INTEGER => 
"Integer",
 
  324                self::TYPE_SELECT_MULTI => 
"SelectMulti"        ,
 
  325                self::TYPE_EXTERNAL_LINK => 
'ExternalLink',
 
  326                self::TYPE_INTERNAL_LINK => 
'InternalLink',
 
  327                self::TYPE_ADDRESS => 
"Address" 
  341        return "udf_type_" . strtolower(self::getTypeString($this->
getType()));
 
  377        if (!$this->adt instanceof 
ilADT) {
 
  391        if (!$this->adt instanceof 
ilADT) {
 
  407        $this->field_id = (int) $a_id;
 
  427        $this->record_id = (int) $a_id;
 
  447        if ($a_id_string !== 
null) {
 
  448            $a_id_string = trim($a_id_string);
 
  450        $this->import_id = $a_id_string;
 
  470        $this->position = (int) $a_pos;
 
  490        if ($a_title !== 
null) {
 
  491            $a_title = trim($a_title);
 
  493        $this->title = $a_title;
 
  513        if ($a_desc !== 
null) {
 
  514            $a_desc = trim($a_desc);
 
  516        $this->description = $a_desc;
 
  560        $this->searchable = (bool) $a_status;
 
  580        $this->required = (bool) $a_status;
 
  670        $title->setRequired(
true);
 
  674            $title->setDisabled(
true);
 
  685            $desc->setDisabled(
true);
 
  696            $check->setDisabled(
true);
 
  767        if ($a_form->
getInput(
"searchable")) {
 
  769            $hidden->setValue(1);
 
  792        $sql = 
"SELECT max(position) pos" .
 
  793            " FROM adv_mdf_definition" .
 
  795        $set = 
$ilDB->query($sql);
 
  796        if (
$ilDB->numRows($set)) {
 
  797            $pos = 
$ilDB->fetchAssoc($set);
 
  798            return (
int) $pos[
"pos"];
 
  812        return 'il_' . IL_INST_ID . 
'_adv_md_field_' . $a_field_id;
 
  823            "field_type" => array(
"integer", $this->
getType()),
 
  824            "record_id" => array(
"integer", $this->
getRecordId()),
 
  825            "import_id" => array(
"text", $this->
getImportId()),
 
  826            "title" => array(
"text", $this->
getTitle()),
 
  828            "position" => array(
"integer", $this->
getPosition()),
 
  829            "searchable" => array(
"integer", $this->
isSearchable()),
 
  830            "required" => array(
"integer", $this->
isRequired())
 
  834        if (is_array($def)) {
 
  835            $fields[
"field_values"] = array(
"text", serialize($def));
 
  846    protected function import(array $a_data)
 
  857        if ($a_data[
"field_values"]) {
 
  865    protected function read($a_field_id)
 
  871        if (!(
int) $a_field_id) {
 
  875        $sql = 
"SELECT * FROM adv_mdf_definition" .
 
  876            " WHERE field_id = " . 
$ilDB->quote($a_field_id, 
"integer");
 
  877        $set = 
$ilDB->query($sql);
 
  878        if (
$ilDB->numRows($set)) {
 
  879            $row = 
$ilDB->fetchAssoc($set);
 
  887    public function save($a_keep_pos = 
false)
 
  897        $next_id = 
$ilDB->nextId(
"adv_mdf_definition");
 
  910        $fields[
"field_id"] = array(
"integer", $next_id);
 
  912        $ilDB->insert(
"adv_mdf_definition", $fields);
 
  927            return $this->
save();
 
  931            "adv_mdf_definition",
 
  933            array(
"field_id" => array(
"integer", $this->
getFieldId()))
 
  940    public function delete()
 
  951        include_once(
"Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php");
 
  954        $query = 
"DELETE FROM adv_mdf_definition" .
 
  976            'fieldType' => self::getTypeString($this->
getType())));
 
 1104        foreach ($a_records as $record) {
 
 1105            if ($record[
"sub_type"] == 
"-") {
 
 1106                $obj_ids[] = $record[
"obj_id"];
 
 1110        $sql = 
"SELECT obj_id,type" .
 
 1111            " FROM object_data" .
 
 1112            " WHERE " . 
$ilDB->in(
"obj_id", $obj_ids, 
"", 
"integer") .
 
 1113            " AND " . 
$ilDB->in(
"type", $a_object_types, 
"", 
"text");
 
 1114        $set = 
$ilDB->query($sql);
 
 1115        while ($row = 
$ilDB->fetchAssoc($set)) {
 
 1124        include_once(
'Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php');
 
 1129            $element_id = 
"loc";
 
 1135            if (
sizeof($objects)) {
 
 1137                foreach ($objects as $item) {
 
 1138                    if ($item[
"obj_id"] == $a_obj_id &&
 
 1139                        $item[
"sub_type"] == $sub_obj_type) {
 
 1140                        $res[] = $item[
"sub_id"];
 
 1164        include_once(
'Services/ADT/classes/ActiveRecord/class.ilADTActiveRecordByType.php');
 
 1168            if (
sizeof($objects)) {
 
 1204        $class = get_class($this);
 
 1205        $obj = 
new $class();
 
 1206        $obj->setRecordId($a_new_record_id);
 
An exception for terminatinating execution or to throw for unit testing.
static find($a_table, $a_type, $a_field_id, $a_condition, $a_additional_fields=null)
Find entries.
ADT definition base class.
static getInstance()
Get singleton.
ADT search bridge base class.
setSerializedValue($a_value)
Set current value(s) in serialized form (for easy persisting)
getSQLCondition($a_element_id)
Get SQL condition for current value(s)
getSerializedValue()
Get current value(s) in serialized form (for easy persisting)
AMD field abstract base class.
getLuceneSearchString($a_value)
Get search string in lucene syntax.
getLastPosition()
Get last position of record.
getImportId()
Get import id.
update()
Update field entry.
importXMLProperty($a_key, $a_value)
Import property from XML.
setRecordId($a_id)
Set record id.
setImportId($a_id_string)
Set import id.
static getInstanceByTypeString($a_type)
Get instance by type string (used by import)
importFromECS($a_ecs_type, $a_value, $a_sub_id)
Import meta data from ECS.
static getInstanceByImportId($a_import_id)
Get definition instance by import id.
isRequired()
Is required field.
addPropertiesToXML(ilXmlWriter $a_writer)
Add (type-specific) properties to xml export.
static exists($a_field_id)
Check if field exists.
importFieldDefinition(array $a_def)
Import (type-specific) field definition from DB.
getSearchValueSerialized(ilADTSearchBridge $a_adt_search)
Get value for search persistence.
setTitle($a_title)
Get title.
static getInstance($a_field_id, $a_type=null)
Get definition instance by type.
static getADTGroupForDefinitions(array $a_defs)
Init ADTGroup for definitions.
setRequired($a_status)
Toggle required.
initADTDefinition()
Init adt instance.
setADT(ilADT $a_adt)
Set ADT instance.
static getInstancesByObjType($a_obj_type, $a_active_only=true)
isSearchSupported()
Is search supported at all.
parseSearchObjects(array $a_records, array $a_object_types)
Add object-data needed for global search to AMD search results.
getSearchQueryParserValue(ilADTSearchBridge $a_adt_search)
Get value for search query parser.
getFieldId()
Get field_id.
getDescription()
Get description.
getADTDefinition()
Get ADT definition instance.
getComplexOptionsOverview($a_parent_gui, string $parent_cmd)
getRecordId()
Get record id.
toXML(ilXmlWriter $a_writer)
To Xml.
importDefinitionFormPostValues(ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
Import post values from definition form.
static getValidTypes()
Get all valid types.
getFieldDefinition()
Get (type-specific) field definition.
setFieldId($a_id)
Set field_id.
read($a_field_id)
Read field definition.
addToFieldDefinitionForm(ilPropertyFormGUI $a_form, ilAdvancedMDPermissionHelper $a_permissions)
Add input elements to definition form.
getFieldDefinitionForTableGUI()
Parse properties for table gui.
setDescription($a_desc)
Set description.
getDBProperties()
Get all definition properties for DB.
searchSubObjects(ilADTSearchBridge $a_adt_search, $a_obj_id, $sub_obj_type)
setSearchValueSerialized(ilADTSearchBridge $a_adt_search, $a_value)
Set value from search persistence.
static getTypeString($a_type)
Get type string.
setSearchable($a_status)
Toggle searchable.
generateImportId($a_field_id)
Generate unique record id.
getPosition()
Get position.
_clone($a_new_record_id)
Clone field definition.
importValueFromXML($a_cdata)
Import value from xml.
prepareElementForSearch(ilADTSearchBridge $a_bridge)
Prepare search form elements.
static getSearchableDefinitionIds()
Get searchable definition ids (performance is key)
getADT()
Get ADT instance.
isFilterSupported()
Is search by filter supported.
importDefinitionFormPostValuesNeedsConfirmation()
searchObjects(ilADTSearchBridge $a_adt_search, ilQueryParser $a_parser, array $a_object_types, $a_locate, $a_search_type)
Search objects.
prepareElementForEditor(ilADTFormBridge $a_bridge)
Prepare editor form elements.
prepareDefinitionFormConfirmation(ilPropertyFormGUI $a_form)
isSearchable()
Is searchable.
static getInstancesByRecordId($a_record_id, $a_only_searchable=false)
Get definitions by record id.
prepareCustomDefinitionFormConfirmation(ilPropertyFormGUI $a_form)
setPosition($a_pos)
Set position.
__construct($a_field_id=null)
Constructor.
save($a_keep_pos=false)
Create new field entry.
getValueForXML(ilADT $element)
Parse ADT value for xml (export)
static isValidType($a_type)
Is given type valid.
getTypeTitle()
Get type title (lang id)
addCustomFieldToDefinitionForm(ilPropertyFormGUI $a_form, $a_disabled=false)
Add custom input elements to definition form.
importCustomDefinitionFormPostValues(ilPropertyFormGUI $a_form)
Import custom post values from definition form.
Advanced metadata permission helper.
const SUBACTION_FIELD_SEARCHABLE
const SUBACTION_FIELD_DESCRIPTION
const ACTION_FIELD_EDIT_PROPERTY
const SUBACTION_FIELD_PROPERTIES
const SUBACTION_FIELD_TITLE
static _deleteByFieldId($a_field_id, ilADT $a_adt)
Delete values by field_id.
hasPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id=null)
Check permission.
hasPermissions($a_context_type, $a_context_id, array $a_action_ids)
Check permissions.
Base class for ILIAS Exception handling.
This class represents a text area property in a property form.
This class represents a text property in a property form.
xmlEndTag($tag)
Writes an endtag.
xmlElement($tag, $attrs=null, $data=null, $encode=true, $escape=true)
Writes a basic element (no children, just textual content)
xmlStartTag($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
Writes a starttag.
foreach($_POST as $key=> $value) $res