parses the objects.xml it handles the xml-description of all ilias objects More...

Collaboration diagram for ilObjectDefinition:

Public Member Functions
	ilObjectDefinition ()
	Constructor. More...

	readDefinitionData ()
	Read object definition data. More...

	getClassName ($a_obj_name)
	get class name by type More...

	getLocation ($a_obj_name)
	get location by type More...

	getGroup ($a_id)
	Get Group information. More...

	getGroupOfObj ($a_obj_name)
	Get Group of object type. More...

	hasCheckbox ($a_obj_name)
	should the object get a checkbox (needed for 'cut','copy' ...) More...

	getTranslationType ($a_obj_name)
	get translation type (sys, db or 0)s More...

	stopInheritance ($a_obj_name)
	Does object permits stopping inheritance? More...

	getDevMode ($a_obj_name)
	get devmode status by type More...

	getDevModeAll ()
	get all object types in devmode More...

	isRBACObject ($a_obj_name)
	get RBAC status by type returns true if object type is a RBAC object type More...

	isPlugin ($a_obj_name)
	get RBAC status by type returns true if object type is an (activated) plugin type More...

	isPluginTypeName ($a_str)
	Check if given type is a plugin type name (starts with an "x") More...

	getAllRBACObjects ()
	get all RBAC object types More...

	getAllObjects ()
	get all object types More...

	allowLink ($a_obj_name)
	checks if linking of an object type is allowed More...

	allowCopy ($a_obj_name)
	checks if copying of an object type is allowed More...

	allowExport ($a_obj_name)

	hasLocalRoles ($a_obj_type)
	Check whether the creation of local roles is allowed Currently disabled for type "root" and "adm". More...

	getSubObjects ($a_obj_type, $a_filter=true)
	get all subobjects by type More...

	getSubObjectsRecursively ($a_obj_type, $a_include_source_obj=true, $a_add_admin_objects=false)
	Get all subobjects by type. More...

	getSubobjectsToFilter ($a_obj_type="adm")
	get all subjects except (rolf) of the adm object This is neceesary for filtering these objects in role perm view. More...

	getCreatableSubObjects ($a_obj_type, $a_context=self::MODE_REPOSITORY, $a_parent_ref_id=null)
	get only creatable subobjects by type More...

	getSubObjectsAsString ($a_obj_type)
	get a string of all subobjects by type More...

	isContainer ($a_obj_name)
	Check if object type is container ('crs','fold','grp' ...) More...

	setHandlers ($a_xml_parser)
	set event handler More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	start tag handler More...

	handlerCharacterData ($a_xml_parser, $a_data)
	end tag handler More...

	handlerEndTag ($a_xml_parser, $a_name)
	end tag handler More...

	__filterObjects (&$subobjects)

	isSystemObject ($a_obj_name)
	checks if object type is a system object More...

	isSideBlock ($a_obj_name)
	Check, whether object type is a side block. More...

	isAllowedInRepository ($a_obj_name)
	checks if object type can be used in repository context More...

	getAllRepositoryTypes ($a_incl_adm=false)
	get all RBAC object types More...

	isAllowedInWorkspace ($a_obj_name)
	checks if object type can be used in workspace context More...

	isAdministrationObject ($a_obj_name)
	Check if administration object. More...

	isInactivePlugin ($a_type)
	Check whether type belongs to inactive plugin. More...

	getAdvancedMetaDataTypes ()
	Get advanced meta data objects. More...

	getPositionByType ($a_type)
	Get Position By Object Type. More...

	getPlugins ()
	Get plugin object info. More...

	getExplorerContainerTypes ()
	Get all object types which are defined as container in an explorer context. More...

Static Public Member Functions
static	getRepositoryObjectTypesForComponent ($a_component_type, $a_component_name)
	Get all repository object types of component. More...

static	getComponentForType ($a_obj_type)
	Get component for object type. More...

static	getGroupedRepositoryObjectTypes ($a_parent_obj_type)
	Get grouped repository object types. More...

Data Fields
	$obj_id

	$parent

	$obj_data

	$sub_types = array()

const	MODE_REPOSITORY = 1

const	MODE_WORKSPACE = 2

const	MODE_ADMINISTRATION = 3

Protected Member Functions
	readDefinitionDataFromCache ()

	readDefinitionDataFromDB ()

Detailed Description

parses the objects.xml it handles the xml-description of all ilias objects

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

ilObjDefReader on il_object_def, il_object_subobj, il_object_group

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

Member Function Documentation

◆ __filterObjects()

ilObjectDefinition::__filterObjects ( & $subobjects )

Definition at line 858 of file class.ilObjectDefinition.php.

References $data.

Referenced by getSubObjects().

         {
                 foreach($subobjects as $type => $data)
                 {
                         switch($type)
                         {
                                 default:
                                         // DO NOTHING
                         }
                 }
         }

Here is the caller graph for this function:

◆ allowCopy()

ilObjectDefinition::allowCopy ( $a_obj_name )

checks if copying of an object type is allowed

Parameters

string object type public

Definition at line 512 of file class.ilObjectDefinition.php.

         {
                 return (bool) $this->obj_data[$a_obj_name]["allow_copy"];
         }

◆ allowExport()

ilObjectDefinition::allowExport ( $a_obj_name )

Definition at line 517 of file class.ilObjectDefinition.php.

         {
                 return (bool) $this->obj_data[$a_obj_name]['export'];
         }

◆ allowLink()

ilObjectDefinition::allowLink ( $a_obj_name )

checks if linking of an object type is allowed

Parameters

string object type public

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

         {
                 return (bool) $this->obj_data[$a_obj_name]["allow_link"];
         }

◆ getAdvancedMetaDataTypes()

ilObjectDefinition::getAdvancedMetaDataTypes ( )

Get advanced meta data objects.

Parameters

Definition at line 1091 of file class.ilObjectDefinition.php.

References $t.

         {
                 $amet = array();
                 foreach ($this->obj_data as $k => $v)
                 {
                         if ($v["amet"])
                         {
                                 $amet[] = array("obj_type" => $k, "sub_type" => "");
                         }
                 }
 
                 foreach ($this->sub_types as $type => $sub_types)
                 {
                         foreach ($sub_types as $t)
                         {
                                 if ($t["amet"])
                                 {
                                         $amet[] = array("obj_type" => $type, "sub_type" => $t["sub_type"]);
                                 }
                         }
                 }
 
                 return $amet;
         }

◆ getAllObjects()

ilObjectDefinition::getAllObjects ( )

get all object types

public

Returns: array object types

Definition at line 490 of file class.ilObjectDefinition.php.

         {
                 return array_keys($this->obj_data);
         }

◆ getAllRBACObjects()

ilObjectDefinition::getAllRBACObjects ( )

get all RBAC object types

public

Returns: array object types set to development

Definition at line 469 of file class.ilObjectDefinition.php.

References isRBACObject().

         {
                 $types = array_keys($this->obj_data);
                 
                 foreach ($types as $type)
                 {
                         if ($this->isRBACObject($type))
                         {
                                 $rbactypes[] = $type;
                         }
                 }
 
                 return $rbactypes ? $rbactypes : array();
         }

Here is the call graph for this function:

◆ getAllRepositoryTypes()

ilObjectDefinition::getAllRepositoryTypes ( $a_incl_adm = false )

get all RBAC object types

public

Returns: array object types set to development

Definition at line 1031 of file class.ilObjectDefinition.php.

References isAdministrationObject(), and isAllowedInRepository().

         {
                 $types = array_keys($this->obj_data);
                 
                 foreach ($types as $type)
                 {
                         if ($this->isAllowedInRepository($type) &&
                                 (!$this->isAdministrationObject($type) || $a_incl_adm))
                         {
                                 $rbactypes[] = $type;
                         }
                 }
 
                 return $rbactypes ? $rbactypes : array();
         }

Here is the call graph for this function:

◆ getClassName()

ilObjectDefinition::getClassName ( $a_obj_name )

get class name by type

Parameters

string object type public

Definition at line 302 of file class.ilObjectDefinition.php.

         {
                 return $this->obj_data[$a_obj_name]["class_name"];
         }

◆ getComponentForType()

static ilObjectDefinition::getComponentForType ( $a_obj_type )

static

Get component for object type.

Definition at line 925 of file class.ilObjectDefinition.php.

References $ilDB.

         {
                 global $ilDB;
 
                 $set = $ilDB->queryF("SELECT component FROM il_object_def WHERE id = %s",
                         array("text"), array($a_obj_type));
                         
                 if ($rec = $ilDB->fetchAssoc($set))
                 {
                         return $rec["component"];
                 }
                 
                 return "";
         }

◆ getCreatableSubObjects()

ilObjectDefinition::getCreatableSubObjects	(	$a_obj_type,
		$a_context = `self::MODE_REPOSITORY`,
		$a_parent_ref_id = `null`
	)

get only creatable subobjects by type

Parameters

string	object type
integer	context
integer	parent_ref_id public

Returns: array list of createable object types

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

References ilObjStudyProgramme\getCreatableSubObjects(), getDevMode(), getSubObjects(), isAdministrationObject(), isAllowedInRepository(), isAllowedInWorkspace(), and isSystemObject().

         {
                 $subobjects = $this->getSubObjects($a_obj_type);
 
                 // remove role folder object from list 
                 unset($subobjects["rolf"]);
                 
                 $sub_types = array_keys($subobjects);
 
                 // remove object types in development from list
                 foreach ($sub_types as $type)
                 {
                         if ($this->getDevMode($type) || $this->isSystemObject($type))
                         {
                                 unset($subobjects[$type]);
                         }
                         if ($a_context == self::MODE_REPOSITORY && !$this->isAllowedInRepository($type))
                         {
                                 unset($subobjects[$type]);
                         }
                         if ($a_context == self::MODE_WORKSPACE && !$this->isAllowedInWorkspace($type))
                         {
                                 unset($subobjects[$type]);
                         }
                         if ($a_context == self::MODE_ADMINISTRATION && !$this->isAdministrationObject($type))
                         {
                                 unset($subobjects[$type]);
                         }
                 }
                 
                 if ($a_obj_type == "prg") {
                         // ask study program which objects are allowed to create on the concrete node.
                         require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
                         return ilObjStudyProgramme::getCreatableSubObjects($subobjects, $a_parent_ref_id);
                 }
 
                 return $subobjects;
         }

Here is the call graph for this function:

◆ getDevMode()

ilObjectDefinition::getDevMode ( $a_obj_name )

get devmode status by type

Parameters

string object type public

Definition at line 402 of file class.ilObjectDefinition.php.

Referenced by getCreatableSubObjects(), getDevModeAll(), and getSubObjectsRecursively().

         {
                 return (bool) $this->obj_data[$a_obj_name]["devmode"];
         }

Here is the caller graph for this function:

◆ getDevModeAll()

ilObjectDefinition::getDevModeAll ( )

get all object types in devmode

public

Returns: array object types set to development

Definition at line 413 of file class.ilObjectDefinition.php.

References getDevMode().

         {
                 $types = array_keys($this->obj_data);
                 
                 foreach ($types as $type)
                 {
                         if ($this->getDevMode($type))
                         {
                                 $devtypes[] = $type;
                         }
                 }
 
                 return $devtypes ? $devtypes : array();
         }

Here is the call graph for this function:

◆ getExplorerContainerTypes()

ilObjectDefinition::getExplorerContainerTypes ( )

Get all object types which are defined as container in an explorer context.

Returns: array

Definition at line 1153 of file class.ilObjectDefinition.php.

References $res, getGroupOfObj(), getSubObjectsRecursively(), and isContainer().

         {                                               
                 $res = $grp_map = $cnt_grp = array();           
                 
                 // all repository object types
                 foreach ($this->getSubObjectsRecursively("root") as $rtype)
                 {                               
                         $type = $rtype["name"];
                         
                         // obsolete
                         if($type == "rolf")
                         {
                                 continue;
                         }
 
                         // gather group data
                         $type_grp = $this->getGroupOfObj($type);
                         if($type_grp)
                         {
                                 $grp_map[$type_grp][] = $type;
                         }
 
                         // add basic container types
                         if($this->isContainer($type))
                         {
                                 // add to cnt_grp
                                 if($type_grp)
                                 {
                                         $cnt_grp[] = $type_grp;
                                 }
 
                                 $res[] = $type;
                         }
                 }
                 
                 // add complete groups (cat => rcat, catr; crs => rcrs, crsr; ...)
                 foreach($cnt_grp as $grp)
                 {
                         $res = array_merge($res, $grp_map[$grp]);
                 }
                 
                 // add very special case
                 $res[] = "itgr";
                 
                 return array_unique($res);              
         }

Here is the call graph for this function:

◆ getGroup()

ilObjectDefinition::getGroup ( $a_id )

Get Group information.

Definition at line 322 of file class.ilObjectDefinition.php.

         {
                 return $this->obj_group[$a_id];
         }

◆ getGroupedRepositoryObjectTypes()

static ilObjectDefinition::getGroupedRepositoryObjectTypes ( $a_parent_obj_type )

static

Get grouped repository object types.

Definition at line 943 of file class.ilObjectDefinition.php.

References $ilDB, $ret, DB_FETCHMODE_ASSOC, ilCachedComponentData\getInstance(), IL_COMP_SERVICE, ilPlugin\lookupIdForName(), and ilUtil\sortArray().

         {
                 global $ilDB, $ilPluginAdmin;
                 
                 $set = $ilDB->query("SELECT * FROM il_object_group");
                 $groups = array();
                 while ($gr_rec = $set->fetchRow(DB_FETCHMODE_ASSOC))
                 {
                         $groups[$gr_rec["id"]] = $gr_rec;
                 }
 
                 $global_cache = ilCachedComponentData::getInstance();
 
 
 //              if (!is_array($a_parent_obj_type))
 //              {
 //                      $set = $ilDB->queryF("SELECT il_object_def.* FROM il_object_def, il_object_subobj ".
 //                              " WHERE NOT (system = 1) AND NOT (sideblock = 1) AND ".
 //                              " parent = %s ".
 //                              " AND subobj = id ", array("text"), array($a_parent_obj_type));
 //              }
 //              else
 //              {
 //                      $q = "SELECT DISTINCT (id) as sid, il_object_def.* FROM il_object_def, il_object_subobj ".
 //                              " WHERE NOT (system = 1) AND NOT (sideblock = 1) AND ".
 //                              $ilDB->in("parent", $a_parent_obj_type, false, "text").
 //                              " AND subobj = id ";
 //                      $set = $ilDB->query($q);
 //              }
 
                 $recs = $global_cache->lookupGroupedRepObj($a_parent_obj_type);
                 
                 $grouped_obj = array();
 //              while($rec = $ilDB->fetchAssoc($set))
                 foreach((array)$recs as $rec)
                 {
                         if ($rec["grp"] != "")
                         {
                                 $grouped_obj[$rec["grp"]]["pos"] = (int) $groups[$rec["grp"]]["default_pres_pos"];
                                 $grouped_obj[$rec["grp"]]["objs"][] = $rec["id"];
                         }
                         else
                         {
                                 $grouped_obj[$rec["id"]]["pos"] = (int) $rec["default_pres_pos"];
                                 $grouped_obj[$rec["id"]]["objs"][] = $rec["id"];
                         }
                 }
 //var_dump($grouped_obj);
                 // now get objects from repository plugin
                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
                 foreach ($pl_names as $pl_name)
                 {
                         include_once("./Services/Component/classes/class.ilPlugin.php");
                         $pl_id = ilPlugin::lookupIdForName(IL_COMP_SERVICE, "Repository", "robj", $pl_name);
                         if (!isset($grouped_obj[$pl_id]))
                         {
                                 $grouped_obj[$pl_id] = array(
                                         "pos" => "99992000", // "unassigned" group
                                         "objs" => array(0 => $pl_id)
                                         );
                         }
                 }
 
 //var_dump($grouped_obj);
 
                 $ret = ilUtil::sortArray($grouped_obj, "pos", "asc", true, true);
 //var_dump($ret);
                 return $ret;
         }

Here is the call graph for this function:

◆ getGroupOfObj()

ilObjectDefinition::getGroupOfObj ( $a_obj_name )

Get Group of object type.

Definition at line 330 of file class.ilObjectDefinition.php.

Referenced by getExplorerContainerTypes().

         {
                 return $this->obj_data[$a_obj_name]["group"];
         }

Here is the caller graph for this function:

◆ getLocation()

ilObjectDefinition::getLocation ( $a_obj_name )

get location by type

Parameters

string object type public

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

         {
                 return $this->obj_data[$a_obj_name]["location"];
         }

◆ getPlugins()

ilObjectDefinition::getPlugins ( )

Get plugin object info.

Returns: type

Definition at line 1135 of file class.ilObjectDefinition.php.

References isPlugin().

         {
                 $plugins = array();
                 foreach((array) $this->obj_data as $type => $pl_data)
                 {
                         if($this->isPlugin($type))
                         {
                                 $plugins[$type] = $pl_data;
                         }
                 }
                 return $plugins;
         }

Here is the call graph for this function:

◆ getPositionByType()

ilObjectDefinition::getPositionByType ( $a_type )

Get Position By Object Type.

Parameters

$a_type

Returns: int

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

References $ilSetting.

         {
                 global $ilSetting;
 
                 return ($ilSetting->get("obj_add_new_pos_".$a_type) > 0)
                         ? (int) $ilSetting->get("obj_add_new_pos_".$a_type)
                         : (int) $this->obj_data[$a_type]["default_pos"];
         }

◆ getRepositoryObjectTypesForComponent()

static ilObjectDefinition::getRepositoryObjectTypesForComponent	(	$a_component_type,
		$a_component_name
	)

static

Get all repository object types of component.

Definition at line 902 of file class.ilObjectDefinition.php.

References $ilDB.

         {
                 global $ilDB;
 
                 $set = $ilDB->queryF("SELECT * FROM il_object_def WHERE component = %s",
                         array("text"), array($a_component_type."/".$a_component_name));
                         
                 $types = array();
                 while($rec = $ilDB->fetchAssoc($set))
                 {
                         if ($rec["system"] != 1)
                         {
                                 $types[] = $rec;
                         }
                 }
                 
                 return $types;
         }

◆ getSubObjects()

ilObjectDefinition::getSubObjects	(	$a_obj_type,
		$a_filter = `true`
	)

get all subobjects by type

Parameters

string	object type
boolean	filter disabled objects? (default: true) public

Returns: array list of allowed object types

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

References $data, $ilSetting, __filterObjects(), and ilUtil\sortArray().

Referenced by getCreatableSubObjects(), and getSubObjectsRecursively().

         {
                 global $ilSetting;
                 
                 $subs = array();
 
                 if ($subobjects = $this->obj_data[$a_obj_type]["subobjects"])
                 {
                         // Filter some objects e.g chat object are creatable if chat is active
                         if ($a_filter)
                         {
                                 $this->__filterObjects($subobjects);
                         }
                         foreach ($subobjects as $data => $sub)
                         {
                                 if ($sub["module"] != "n")
                                 {
                                         if (!($ilSetting->get("obj_dis_creation_".$data)))
                                         {
                                                 $subs[$data] = $sub;
                                                 
                                                 // determine position
                                                 $pos = ($ilSetting->get("obj_add_new_pos_".$data) > 0)
                                                         ? (int) $ilSetting->get("obj_add_new_pos_".$data)
                                                         : (int) $this->obj_data[$data]["default_pos"];
                                                 $subs[$data]["pos"] = $pos;
                                         }
                                 }
                         }
 
                         $subs2 = ilUtil::sortArray($subs, "pos", ASC, true, true);
 
                         return $subs2;
                 }
                 
                 return $subs;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubObjectsAsString()

ilObjectDefinition::getSubObjectsAsString ( $a_obj_type )

get a string of all subobjects by type

Parameters

string object type public

Definition at line 762 of file class.ilObjectDefinition.php.

References $data.

         {
                 $string = "";
 
                 if (is_array($this->obj_data[$a_obj_type]["subobjects"]))
                 {
                         $data = array_keys($this->obj_data[$a_obj_type]["subobjects"]);
 
                         $string = "'".implode("','", $data)."'";
                 }
                 
                 return $string;
         }

◆ getSubObjectsRecursively()

ilObjectDefinition::getSubObjectsRecursively	(	$a_obj_type,
		$a_include_source_obj = `true`,
		$a_add_admin_objects = `false`
	)

Get all subobjects by type.

This function returns all subobjects allowed by the provided object type and all its subobject types recursively.

This function is used to create local role templates. It is important, that we do not filter out any objects here!

Parameters

string object type public

Returns: array list of allowed object types

Definition at line 598 of file class.ilObjectDefinition.php.

References $data, $ilSetting, getDevMode(), getSubObjects(), isRBACObject(), and ilUtil\sortArray().

Referenced by getExplorerContainerTypes().

         {
                 global $ilSetting;
                 
                 // This associative array is used to collect all subobject types.
                 // key=>type, value=data
                 $recursivesubs = array();
 
                 // This array is used to keep track of the object types, we
                 // need to call function getSubobjects() for.
                 $to_do = array($a_obj_type);
 
                 // This array is used to keep track of the object types, we
                 // have called function getSubobjects() already. This is to
                 // prevent endless loops, for object types that support 
                 // themselves as subobject types either directly or indirectly.
                 $done = array();
 
                 while (count($to_do) > 0)
                 {
                         $type = array_pop($to_do);
                         $done[] = $type;
                         
                         // no recovery folder subitems
                         if($type == 'recf')
                         {
                                 continue;
                         }
                         
                         // Hide administration if desired
                         if(!$a_add_admin_objects and $type == 'adm')
                         {
                                 $subs = array();
                         }
                         else
                         {
                                 $subs = $this->getSubObjects($type);
                         }
                         #vd('xxxxxxxxxxxxx'.$type);
                         foreach ($subs as $subtype => $data)
                         {
                                 #vd('------------------------->'.$subtype);
                                 
                                 // Hide role templates and folder from view
                                 if($this->getDevMode($subtype) or !$this->isRBACObject($subtype))
                                 {
                                         continue;
                                 }
                                 if($subtype == 'rolt')
                                 {
                                         continue;
                                 }
                                 if(!$a_add_admin_objects and $subtype == 'adm')
                                 {
                                         continue;
                                 }
                                 
                                 $recursivesubs[$subtype] = $data;
                                 if (! in_array($subtype, $done)
                                 && ! in_array($subtype, $to_do))
                                 {
                                         $to_do[] = $subtype;
                                 }
                         }
                 }
                 
                 if($a_include_source_obj)
                 {
                         if(!isset($recursivesubs[$a_obj_type]))
                         {
                                 $recursivesubs[$a_obj_type]['name'] = $a_obj_type;
                                 $recursivesubs[$a_obj_type]['lng'] = $a_obj_type;
                                 $recursivesubs[$a_obj_type]['max'] = 0;
                                 $recursivesubs[$a_obj_type]['pos'] = -1;
                         }
                 }
                 return ilUtil::sortArray($recursivesubs, "pos", ASC, true, true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubobjectsToFilter()

ilObjectDefinition::getSubobjectsToFilter ( $a_obj_type = "adm" )

get all subjects except (rolf) of the adm object This is neceesary for filtering these objects in role perm view.

e.g It it not necessary to view/edit role permission for the usrf object since it's not possible to create a new one

Parameters

string object type public

Returns: array list of object types to filter

Definition at line 687 of file class.ilObjectDefinition.php.

         {
                 foreach($this->obj_data[$a_obj_type]["subobjects"] as $key => $value)
                 {
                         switch($key)
                         {
                                 case "rolf":
                                         // DO NOTHING
                                         break;
 
                                 default:
                                         $tmp_subs[] = $key;
                         }
                 }
                 // ADD adm and root object
                 $tmp_subs[] = "adm";
                 #$tmp_subs[] = "root";
 
                 return $tmp_subs ? $tmp_subs : array();
         }

◆ getTranslationType()

ilObjectDefinition::getTranslationType ( $a_obj_name )

get translation type (sys, db or 0)s

Parameters

string object type public

Definition at line 352 of file class.ilObjectDefinition.php.

References $ilDB, and DB_FETCHMODE_ASSOC.

         {
                 global $ilDB;
                 
                 if ($a_obj_name == "root")
                 {
                         if (!isset($this->root_trans_type))
                         {
                                 $q = "SELECT count(obj_id) cnt FROM object_translation WHERE obj_id = ".
                                         $ilDB->quote(ROOT_FOLDER_ID,'integer')." ";
                                 $set = $ilDB->query($q);
                                 $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);
                                 if($rec["cnt"] > 0)
                                 {
                                         $this->root_trans_type = "db";
                                 }
                                 else
                                 {
                                         $this->root_trans_type = $this->obj_data[$a_obj_name]["translate"];
                                 }
                         }
                         return $this->root_trans_type;
                 }
                 
                 if (isset($this->obj_data[$a_obj_name]))
                 {
                         return $this->obj_data[$a_obj_name]["translate"];
                 }
                 
                 return "";
         }

◆ handlerBeginTag()

ilObjectDefinition::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

start tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name
array	element attributes private

Definition at line 816 of file class.ilObjectDefinition.php.

         {
                 switch ($a_name)
                 {
                         case 'object':
                                 $this->parent_tag_name = $a_attribs["name"];
                                 break;
                         case 'property':
                                 $this->current_tag = "property";
                                 $this->current_tag_name = $a_attribs["name"];
 //                              $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["name"] = $a_attribs["name"];
                                 $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["module"] = $a_attribs["module"];
 //echo '<br>$this->obj_data["'.$this->parent_tag_name.'"]["properties"]["'.$this->current_tag_name.'"]["module"] = "'.$a_attribs["module"].'";';
                                 break;
                 }
         }

◆ handlerCharacterData()

ilObjectDefinition::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	data private

Definition at line 840 of file class.ilObjectDefinition.php.

841 {

842 }

◆ handlerEndTag()

ilObjectDefinition::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name private

Definition at line 851 of file class.ilObjectDefinition.php.

         {
                 $this->current_tag = '';
                 $this->current_tag_name = '';
         }

◆ hasCheckbox()

ilObjectDefinition::hasCheckbox ( $a_obj_name )

should the object get a checkbox (needed for 'cut','copy' ...)

Parameters

string object type public

Definition at line 341 of file class.ilObjectDefinition.php.

         {
                 return (bool) $this->obj_data[$a_obj_name]["checkbox"];
         }

◆ hasLocalRoles()

ilObjectDefinition::hasLocalRoles ( $a_obj_type )

Check whether the creation of local roles is allowed Currently disabled for type "root" and "adm".

Returns

Definition at line 527 of file class.ilObjectDefinition.php.

         {
                 switch($a_obj_type)
                 {
                         case 'root':
                                 return FALSE;
                                 
                         default:
                                 return TRUE;
                 }
         }

◆ ilObjectDefinition()

ilObjectDefinition::ilObjectDefinition ( )

Constructor.

setup ILIAS global object public

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

References readDefinitionData().

         {
                 global $ilias;
                 
                 $this->readDefinitionData();
                 $this->ilias = $ilias;
                 
                 //parent::ilSaxParser(ILIAS_ABSOLUTE_PATH."/objects.xml");
                 
                 // removing this line leads to segmentation faults in
                 // learning module editor with
                 // - PHP 5.2.1, libxml 2.6.22, libxslt 1.1.15 (MacOsX)
                 // - PHP 5.2.1, libxml 2.6.31, libxslt 1.1.22 (MacOsX)
                 // - PHP 5.2.5, libxml 2.6.31, libxslt 1.1.22 (MacOsX)
                 // - PHP 5.2.0-8+etch7, libxml 2.6.27, libxslt 1.1.19
                 // - PHP 5.2.0, libxml, libxml 2.6.26, libxslt 1.1.17 (OpenSuse 10.2)
                 // (needs further investigation)
                 // OK with:
                 // - PHP 5.1.2, libxml 2.6.24, libxslt 1.1.15
                 
                 //
                 // Replacing all "=&" with "=" in xml5compliance seems to solve the problem
                 //
                 
 //              $this->startParsing();
         }

Here is the call graph for this function:

◆ isAdministrationObject()

ilObjectDefinition::isAdministrationObject ( $a_obj_name )

Check if administration object.

Parameters

string $a_obj_name

Returns: bool

Definition at line 1065 of file class.ilObjectDefinition.php.

Referenced by getAllRepositoryTypes(), and getCreatableSubObjects().

         {
                 return (bool) $this->obj_data[$a_obj_name]['administration'];
         }

Here is the caller graph for this function:

◆ isAllowedInRepository()

ilObjectDefinition::isAllowedInRepository ( $a_obj_name )

checks if object type can be used in repository context

Parameters

string object type public

Returns: bool

Definition at line 1020 of file class.ilObjectDefinition.php.

Referenced by getAllRepositoryTypes(), and getCreatableSubObjects().

         {
                 return (bool) $this->obj_data[$a_obj_name]["repository"];
         }

Here is the caller graph for this function:

◆ isAllowedInWorkspace()

ilObjectDefinition::isAllowedInWorkspace ( $a_obj_name )

checks if object type can be used in workspace context

Parameters

string object type public

Returns: bool

Definition at line 1055 of file class.ilObjectDefinition.php.

Referenced by getCreatableSubObjects().

         {
                 return (bool) $this->obj_data[$a_obj_name]["workspace"];
         }

Here is the caller graph for this function:

◆ isContainer()

ilObjectDefinition::isContainer ( $a_obj_name )

Check if object type is container ('crs','fold','grp' ...)

public

Parameters

string object type

Returns: bool

Definition at line 784 of file class.ilObjectDefinition.php.

Referenced by getExplorerContainerTypes().

         {
                 if(!is_array($this->obj_data[$a_obj_name]['subobjects']))
                 {
                         return false;
                 }
                 return count($this->obj_data[$a_obj_name]['subobjects']) >= 1 ? true : false;
         }

Here is the caller graph for this function:

◆ isInactivePlugin()

ilObjectDefinition::isInactivePlugin ( $a_type )

Check whether type belongs to inactive plugin.

Parameters

Definition at line 1076 of file class.ilObjectDefinition.php.

References isPlugin().

         {
                 if (substr($a_type, 0, 1) == "x" && !$this->isPlugin($a_type))
                 {
                         return true;
                 }
                 return false;
         }

Here is the call graph for this function:

◆ isPlugin()

ilObjectDefinition::isPlugin ( $a_obj_name )

get RBAC status by type returns true if object type is an (activated) plugin type

Parameters

string object type public

Definition at line 447 of file class.ilObjectDefinition.php.

Referenced by getPlugins(), and isInactivePlugin().

         {
                 return (bool) isset($this->obj_data[$a_obj_name]["plugin"]);
         }

Here is the caller graph for this function:

◆ isPluginTypeName()

ilObjectDefinition::isPluginTypeName ( $a_str )

Check if given type is a plugin type name (starts with an "x")

Parameters

string object type public

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

         {
                 return (substr($a_str, 0, 1) == "x");
         }

◆ isRBACObject()

ilObjectDefinition::isRBACObject ( $a_obj_name )

get RBAC status by type returns true if object type is a RBAC object type

Parameters

string object type public

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

Referenced by getAllRBACObjects(), and getSubObjectsRecursively().

         {
                 return (bool) $this->obj_data[$a_obj_name]["rbac"];
         }

Here is the caller graph for this function:

◆ isSideBlock()

ilObjectDefinition::isSideBlock ( $a_obj_name )

Check, whether object type is a side block.

Parameters

string object type

Returns: boolean side block true/false

Definition at line 894 of file class.ilObjectDefinition.php.

         {
                 return (bool) $this->obj_data[$a_obj_name]["sideblock"];
         }

◆ isSystemObject()

ilObjectDefinition::isSystemObject ( $a_obj_name )

checks if object type is a system object

system objects are those object types that are only used for internal purposes and to keep the object type model consistent. Typically they are used in the administation, exist only once and may contain only specific object types. To mark an object type as a system object type, use 'system=1' in the object definition in objects.xml

Parameters

string object type public

Definition at line 883 of file class.ilObjectDefinition.php.

Referenced by getCreatableSubObjects().

         {
                 return (bool) $this->obj_data[$a_obj_name]["system"];
         }

Here is the caller graph for this function:

◆ readDefinitionData()

ilObjectDefinition::readDefinitionData ( )

Read object definition data.

Definition at line 284 of file class.ilObjectDefinition.php.

References ilGlobalCache\COMP_COMPONENT, ilGlobalCache\getInstance(), readDefinitionDataFromCache(), and readDefinitionDataFromDB().

Referenced by ilObjectDefinition().

         {
                 if(ilGlobalCache::getInstance(ilGlobalCache::COMP_COMPONENT)->isActive()) {
                         $this->readDefinitionDataFromCache();
                 } else {
                         $this->readDefinitionDataFromDB();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDefinitionDataFromCache()

ilObjectDefinition::readDefinitionDataFromCache ( )

protected

Definition at line 78 of file class.ilObjectDefinition.php.

References ilPlugin\_getDirectory(), ilCachedComponentData\getInstance(), IL_COMP_SERVICE, and ilPlugin\lookupIdForName().

Referenced by readDefinitionData().

                                                          {
                 global $ilPluginAdmin;
 
                 $this->obj_data = array();
                 $defIds = array();
                 $global_cache = ilCachedComponentData::getInstance();
                 foreach ($global_cache->getIlobjectDef() as $rec) {
                         $this->obj_data[$rec["id"]] = array(
                                 "name" => $rec["id"],
                                 "class_name" => $rec["class_name"],
                                 "location" => $rec["location"],
                                 "checkbox" => $rec["checkbox"],
                                 "inherit" => $rec["inherit"],
                                 "component" => $rec["component"],
                                 "translate" => $rec["translate"],
                                 "devmode" => $rec["devmode"],
                                 "allow_link" => $rec["allow_link"],
                                 "allow_copy" => $rec["allow_copy"],
                                 "rbac" => $rec["rbac"],
                                 "group" => $rec["grp"],
                                 "system" => $rec["system"],
                                 "default_pos" => "9999" . str_pad($rec["default_pos"], 4, "0", STR_PAD_LEFT), // "unassigned" group
                                 "sideblock" => $rec["sideblock"],
                                 'export' => $rec['export'],
                                 'repository' => $rec['repository'],
                                 'workspace' => $rec['workspace'],
                                 'administration' => $rec['administration'],
                                 'amet' => $rec['amet']
                         );
                         $this->obj_data[$rec["id"]]["subobjects"] = array();
 
                         $defIds[] = $rec["id"];
                 }
 
                 $subobj = $global_cache->lookupSubObjForParent($defIds);
 
                 foreach ($subobj as $rec2) {
 
                         $max = $rec2["mmax"];
                         if ($max <= 0) {
                                 $max = "";
                         }
                         $this->obj_data[$rec2["parent"]]["subobjects"][$rec2["subobj"]] = array(
                                 "name" => $rec2["subobj"],
                                 "max" => $max,
                                 "lng" => $rec2["subobj"]
                         );
                 }
                 $this->obj_group = $global_cache->getIlObjectGroup();
 
                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
                 foreach ($pl_names as $pl_name) {
                         include_once("./Services/Component/classes/class.ilPlugin.php");
                         $pl_id = ilPlugin::lookupIdForName(IL_COMP_SERVICE, "Repository", "robj", $pl_name);
                         if ($pl_id != "" && ! isset($this->obj_data[$pl_id])) {
                                 include_once("./Services/Repository/classes/class.ilRepositoryObjectPlugin.php");
                                 $loc = ilPlugin::_getDirectory(IL_COMP_SERVICE, "Repository", "robj", $pl_name) . "/classes";
 
                                 $this->obj_data[$pl_id] = array(
                                         "name" => $pl_id,
                                         "class_name" => $pl_name,
                                         "plugin" => "1",
                                         "location" => $loc,
                                         "checkbox" => "1",
                                         "inherit" => "0",
                                         "component" => "",
                                         "translate" => "0",
                                         "devmode" => "0",
                                         "allow_link" => "1",
                                         "allow_copy" => "0",
                                         "rbac" => "1",
                                         "group" => NULL,
                                         "system" => "0",
                                         "default_pos" => "99992000", // "unassigned" group
                                         'repository' => '1',
                                         'workspace' => '0',
                                         'administration' => '0',
                                         "sideblock" => "0"
                                 );
                                 $this->obj_data[$rec["id"]]["subobjects"] = array();
 
                                 // plugins have to be marked as such - see ilContainerGUI::showPossibleSubObjects()
                                 $this->obj_data["crs"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["fold"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["grp"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["cat"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["root"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                         }
                 }
 
                 $this->sub_types = $global_cache->getIlObjectSubType();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDefinitionDataFromDB()

ilObjectDefinition::readDefinitionDataFromDB ( )

protected

Definition at line 172 of file class.ilObjectDefinition.php.

References $ilDB, ilPlugin\_getDirectory(), IL_COMP_SERVICE, and ilPlugin\lookupIdForName().

Referenced by readDefinitionData().

                                                       {
                 global $ilDB, $ilPluginAdmin;
 
                 $this->obj_data = array();
 
                 // Select all object_definitions and collect the definition id's in
                 // this array.
                 $defIds = array();
                 $set = $ilDB->query("SELECT * FROM il_object_def");
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->obj_data[$rec["id"]] = array(
                                 "name" => $rec["id"],
                                 "class_name" => $rec["class_name"],
                                 "location" => $rec["location"],
                                 "checkbox" => $rec["checkbox"],
                                 "inherit" => $rec["inherit"],
                                 "component" => $rec["component"],
                                 "translate" => $rec["translate"],
                                 "devmode" => $rec["devmode"],
                                 "allow_link" => $rec["allow_link"],
                                 "allow_copy" => $rec["allow_copy"],
                                 "rbac" => $rec["rbac"],
                                 "group" => $rec["grp"],
                                 "system" => $rec["system"],
                                 "default_pos" => "9999" . str_pad($rec["default_pos"], 4, "0", STR_PAD_LEFT), // "unassigned" group
                                 "sideblock" => $rec["sideblock"],
                                 'export' => $rec['export'],
                                 'repository' => $rec['repository'],
                                 'workspace' => $rec['workspace'],
                                 'administration' => $rec['administration'],
                                 'amet' => $rec['amet']
                         );
                         $this->obj_data[$rec["id"]]["subobjects"] = array();
 
                         $defIds[] = $rec["id"];
                 }
 
                 // get all subobject definitions in a single query
                 $set2 = $ilDB->query("SELECT * FROM il_object_subobj WHERE " . $ilDB->in('parent', $defIds, false, 'text'));
                 while ($rec2 = $ilDB->fetchAssoc($set2)) {
                         $max = $rec2["mmax"];
                         if ($max <= 0) // for backward compliance
                         {
                                 $max = "";
                         }
                         $this->obj_data[$rec2["parent"]]["subobjects"][$rec2["subobj"]] = array(
                                 "name" => $rec2["subobj"],
                                 "max" => $max,
                                 "lng" => $rec2["subobj"]
                         );
                 }
 
                 $set = $ilDB->query("SELECT * FROM il_object_group");
                 $this->obj_group = array();
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->obj_group[$rec["id"]] = $rec;
                 }
 
                 // now get objects from repository plugin
                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "Repository", "robj");
                 foreach ($pl_names as $pl_name) {
                         include_once("./Services/Component/classes/class.ilPlugin.php");
                         $pl_id = ilPlugin::lookupIdForName(IL_COMP_SERVICE, "Repository", "robj", $pl_name);
                         if ($pl_id != "" && ! isset($this->obj_data[$pl_id])) {
                                 include_once("./Services/Repository/classes/class.ilRepositoryObjectPlugin.php");
                                 $loc = ilPlugin::_getDirectory(IL_COMP_SERVICE, "Repository", "robj", $pl_name) . "/classes";
 
                                 $this->obj_data[$pl_id] = array(
                                         "name" => $pl_id,
                                         "class_name" => $pl_name,
                                         "plugin" => "1",
                                         "location" => $loc,
                                         "checkbox" => "1",
                                         "inherit" => "0",
                                         "component" => "",
                                         "translate" => "0",
                                         "devmode" => "0",
                                         "allow_link" => "1",
                                         "allow_copy" => "0",
                                         "rbac" => "1",
                                         "group" => NULL,
                                         "system" => "0",
                                         "default_pos" => "99992000", // "unassigned" group
                                         'repository' => '1',
                                         'workspace' => '0',
                                         'administration' => '0',
                                         "sideblock" => "0"
                                 );
                                 $this->obj_data[$rec["id"]]["subobjects"] = array();
 
                                 // plugins have to be marked as such - see ilContainerGUI::showPossibleSubObjects()
                                 $this->obj_data["crs"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["fold"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["grp"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["cat"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                                 $this->obj_data["root"]["subobjects"][$pl_id] = array( "name" => $pl_id, "max" => "", "lng" => $pl_id, "plugin" => true );
                         }
                 }
                 //var_dump($this->obj_data["root"]["subobjects"]);
                 //var_dump($this->obj_data2["root"]);
 
                 $set = $ilDB->query("SELECT * FROM il_object_sub_type ");
                 $this->sub_types = array();
                 while ($rec = $ilDB->fetchAssoc($set)) {
                         $this->sub_types[$rec["obj_type"]][] = $rec;
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilObjectDefinition::setHandlers ( $a_xml_parser )

set event handler

Parameters

ressouce internal xml_parser_handler private

Definition at line 801 of file class.ilObjectDefinition.php.

         {
                 xml_set_object($a_xml_parser,$this);
                 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
                 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
         }

◆ stopInheritance()

ilObjectDefinition::stopInheritance ( $a_obj_name )

Does object permits stopping inheritance?

Parameters

string object type public

Definition at line 391 of file class.ilObjectDefinition.php.

         {
                 return (bool) $this->obj_data[$a_obj_name]["inherit"];
         }

Field Documentation

◆ $obj_data

ilObjectDefinition::$obj_data

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

◆ $obj_id

ilObjectDefinition::$obj_id

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

◆ $parent

ilObjectDefinition::$parent

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

◆ $sub_types

ilObjectDefinition::$sub_types = array()

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

◆ MODE_ADMINISTRATION

const ilObjectDefinition::MODE_ADMINISTRATION = 3

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

Referenced by ilObjOrgUnitGUI\showPossibleSubObjects().

◆ MODE_REPOSITORY

const ilObjectDefinition::MODE_REPOSITORY = 1

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

Referenced by ilObjectAddNewItemGUI\__construct(), ilTrQuery\getObjectTypeStatistics(), and ilObjectGUI\showPossibleSubObjects().

◆ MODE_WORKSPACE

const ilObjectDefinition::MODE_WORKSPACE = 2

Definition at line 41 of file class.ilObjectDefinition.php.

Referenced by ilObjectAddNewItemGUI\getHTML(), ilObjectAddNewItemGUI\parsePersonalWorkspace(), ilObjWorkspaceFolderGUI\render(), and ilObjectAddNewItemGUI\render().

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

Services/Object/classes/class.ilObjectDefinition.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Member Function Documentation

◆ __filterObjects()

◆ allowCopy()

◆ allowExport()

◆ allowLink()

◆ getAdvancedMetaDataTypes()

◆ getAllObjects()

◆ getAllRBACObjects()

◆ getAllRepositoryTypes()

◆ getClassName()

◆ getComponentForType()

◆ getCreatableSubObjects()

◆ getDevMode()

◆ getDevModeAll()

◆ getExplorerContainerTypes()

◆ getGroup()

◆ getGroupedRepositoryObjectTypes()

◆ getGroupOfObj()

◆ getLocation()

◆ getPlugins()

◆ getPositionByType()

◆ getRepositoryObjectTypesForComponent()

◆ getSubObjects()

◆ getSubObjectsAsString()

◆ getSubObjectsRecursively()

◆ getSubobjectsToFilter()

◆ getTranslationType()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ hasCheckbox()

◆ hasLocalRoles()

◆ ilObjectDefinition()

◆ isAdministrationObject()

◆ isAllowedInRepository()

◆ isAllowedInWorkspace()

◆ isContainer()

◆ isInactivePlugin()

◆ isPlugin()

◆ isPluginTypeName()

◆ isRBACObject()

◆ isSideBlock()

◆ isSystemObject()

◆ readDefinitionData()

◆ readDefinitionDataFromCache()

◆ readDefinitionDataFromDB()

◆ setHandlers()

◆ stopInheritance()

Field Documentation

◆ $obj_data

◆ $obj_id

◆ $parent

◆ $sub_types

◆ MODE_ADMINISTRATION

◆ MODE_REPOSITORY

◆ MODE_WORKSPACE