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

Collaboration diagram for ilObjectDefinition:

Public Member Functions
	__construct ()

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

	getClassName (string $obj_name)

	getLocation (string $obj_name)

	getGroup (string $id)
	Get Group information. More...

	getGroupOfObj (string $obj_name)
	Get Group of object type. More...

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

	getTranslationType (string $obj_name)
	get translation type (sys, db or null) More...

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

	getDevMode (string $obj_name)
	get dev mode status by type More...

	getDevModeAll ()
	get all object types in dev mode More...

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

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

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

	isActivePluginType (string $type)
	Returns true if the given type is an active type of repositoryObject or Organisation Unit Extension plugin. More...

	getAllRBACObjects ()

	getAllObjects ()
	get all object types More...

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

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

	allowExport (string $obj_name)

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

	getSubObjects (string $obj_type, bool $filter=true)
	get all sub objects by type More...

	getSubObjectsRecursively (string $obj_type, bool $include_source_obj=true, bool $add_admin_objects=false)
	Get all sub objects by type. More...

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

	getCreatableSubObjects (string $obj_type, int $context=self::MODE_REPOSITORY, ?int $parent_ref_id=null)

	getSubObjectsAsString (string $obj_type)
	get a string of all sub objects by type More...

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

	setHandlers ($xml_parser)

	handlerBeginTag ($xml_parser, string $name, array $attribs)

	handlerCharacterData ($xml_parser, string $data)

	handlerEndTag ($xml_parser, string $name)

	__filterObjects (array &$sub_objects)

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

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

	getSideBlockTypes (bool $filter_repository_types=true)

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

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

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

	isAdministrationObject (string $obj_name)
	Check if administration object. More...

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

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

	getOrgUnitPermissionTypes ()
	Get object type with org unit position permission support. More...

	getLTIProviderTypes ()
	Get object types which offer lti provider support. More...

	isOrgUnitPermissionType (string $obj_type)
	Check if object type offers org unit position support. More...

	getPositionByType (string $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...

	supportsOfflineHandling (string $obj_type)
	check whether obj_type supports centralised offline handling More...

Static Public Member Functions
static	getRepositoryObjectTypesForComponent (string $component_type, string $component_name)
	Get all repository object types of component. More...

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

static	getGroupedRepositoryObjectTypes ($parent_obj_type)

Data Fields
const	MODE_REPOSITORY = 1

const	MODE_WORKSPACE = 2

const	MODE_ADMINISTRATION = 3

Protected Member Functions
	readPluginData ()
	Loads the different plugins into the object definition. More...

	parsePluginData (string $slotId, bool $isInAdministration)
	loads a single plugin definition into the object definition More...

Static Protected Member Functions
static	getGroupedPluginObjectTypes (array $grouped_obj, string $slotId)

Protected Attributes
ilSetting	$settings

ilComponentRepository	$component_repository

array	$obj_data = []

array	$obj_group = []

array	$sub_types = []

string	$parent_tag_name

string	$current_tag

string	$current_tag_name

string	$root_trans_type = null

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 ilObjDefReader on il_object_def, il_object_subobj, il_object_group

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectDefinition::__construct ( )

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

References $DIC, readDefinitionData(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->component_repository = $DIC["component.repository"];
         $this->settings = $DIC->settings();
         $this->readDefinitionData();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __filterObjects()

ilObjectDefinition::__filterObjects ( array & $sub_objects )

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

Referenced by getSubObjects().

                                                         : void
     {
         // DO NOTHING
     }

Here is the caller graph for this function:

◆ allowCopy()

ilObjectDefinition::allowCopy ( string $obj_name )

checks if copying of an object type is allowed

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

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

◆ allowExport()

ilObjectDefinition::allowExport ( string $obj_name )

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

Referenced by ilExportOptions\addOptions().

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

Here is the caller graph for this function:

◆ allowLink()

ilObjectDefinition::allowLink ( string $obj_name )

checks if linking of an object type is allowed

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

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

◆ getAdvancedMetaDataTypes()

ilObjectDefinition::getAdvancedMetaDataTypes ( )

Get advanced meta data objects.

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

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

◆ getAllObjects()

ilObjectDefinition::getAllObjects ( )

get all object types

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

Referenced by ilAbstractSearch\getValidObjectTypes().

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

Here is the caller graph for this function:

◆ getAllRBACObjects()

ilObjectDefinition::getAllRBACObjects ( )

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

References isRBACObject().

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

Here is the call graph for this function:

◆ getAllRepositoryTypes()

ilObjectDefinition::getAllRepositoryTypes ( bool $incl_adm = false )

get all RBAC object types

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

References isAdministrationObject(), and isAllowedInRepository().

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

Here is the call graph for this function:

◆ getClassName()

ilObjectDefinition::getClassName ( string $obj_name )

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

Referenced by ilConditionHandler\_checkCondition(), ilBlockGUI\addRepoCommands(), ilContainer\getCompleteDescriptions(), ilNewsForContextBlockGUI\getHTML(), ilContainerStartObjectsContentTableGUI\getItemListGUI(), ilAdministrationExplorerGUI\getNodeHref(), ilConditionHandler\getOperatorsByTriggerType(), ilAdministrationGUI\jump(), and ilObjSessionGUI\redirectToParentContentPageObject().

                                                   : string
     {
         return $this->obj_data[$obj_name]["class_name"] ?? '';
     }

Here is the caller graph for this function:

◆ getComponentForType()

static ilObjectDefinition::getComponentForType ( string $obj_type )

static

Get component for object type.

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

References $DIC, and $ilDB.

                                                                 : string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $result = $ilDB->queryF("SELECT component FROM il_object_def WHERE id = %s", ["text"], [$obj_type]);
 
         if ($rec = $ilDB->fetchAssoc($result)) {
             return $rec["component"];
         }
 
         return "";
     }

◆ getCreatableSubObjects()

ilObjectDefinition::getCreatableSubObjects	(	string	$obj_type,
		int	$context = `self::MODE_REPOSITORY`,
		?int	$parent_ref_id = `null`
	)

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

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

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

Here is the call graph for this function:

◆ getDevMode()

ilObjectDefinition::getDevMode ( string $obj_name )

get dev mode status by type

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

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

                                                 : bool
     {
         return (bool) ($this->obj_data[$obj_name]["devmode"] ?? false);
     }

Here is the caller graph for this function:

◆ getDevModeAll()

ilObjectDefinition::getDevModeAll ( )

get all object types in dev mode

Returns: array object types set to development

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

References getDevMode().

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

Here is the call graph for this function:

◆ getExplorerContainerTypes()

ilObjectDefinition::getExplorerContainerTypes ( )

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

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

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

                                                : array
     {
         $res = $grp_map = $cnt_grp = [];
 
         // all repository object types
         foreach ($this->getSubObjectsRecursively("root") as $rtype) {
             $type = $rtype["name"];
 
             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)) {
                 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]);
         }
         $res[] = "itgr";
 
         return array_unique($res);
     }

Here is the call graph for this function:

◆ getGroup()

ilObjectDefinition::getGroup ( string $id )

Get Group information.

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

References $id.

                                         : array
     {
         return $this->obj_group[$id];
     }

◆ getGroupedPluginObjectTypes()

static ilObjectDefinition::getGroupedPluginObjectTypes	(	array	$grouped_obj,
		string	$slotId
	)

staticprotected

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

References $DIC, XapiProxy\$plugin, and ilComponentRepository\getPluginSlotById().

                                                                                              : array
     {
         global $DIC;
 
         $component_repository = $DIC["component.repository"];
         $plugins = $component_repository->getPluginSlotById($slotId)->getActivePlugins();
         foreach ($plugins as $plugin) {
             $pl_id = $plugin->getId();
             if (!isset($grouped_obj[$pl_id])) {
                 $grouped_obj[$pl_id] = [
                     "pos" => "99992000", // "unassigned" group
                     "objs" => [0 => $pl_id]
                 ];
             }
         }
         return $grouped_obj;
     }

Here is the call graph for this function:

◆ getGroupedRepositoryObjectTypes()

static ilObjectDefinition::getGroupedRepositoryObjectTypes ( $parent_obj_type )

static

Parameters

mixed $parent_obj_type

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

References $DIC, $ilDB, ilDBConstants\FETCHMODE_ASSOC, ilCachedObjectDefinition\getInstance(), ILIAS\Repository\int(), and ilArrayUtil\sortArray().

Referenced by ILIAS\UI\Component\Legacy\Content\ItemBlock\ItemBlockSequenceGenerator\getGroupedObjTypes().

                                                                             : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $set = $ilDB->query("SELECT * FROM il_object_group");
         $groups = [];
         while ($gr_rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $groups[$gr_rec["id"]] = $gr_rec;
         }
 
         $global_cache = ilCachedObjectDefinition::getInstance();
 
         $recs = $global_cache->lookupGroupedRepObj($parent_obj_type);
 
         $grouped_obj = [];
         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"];
             }
         }
         // now get objects from repository plugin
         $grouped_obj = self::getGroupedPluginObjectTypes($grouped_obj, "robj");
         $grouped_obj = self::getGroupedPluginObjectTypes($grouped_obj, "orguext");
 
         return ilArrayUtil::sortArray($grouped_obj, "pos", "asc", true, true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGroupOfObj()

ilObjectDefinition::getGroupOfObj ( string $obj_name )

Get Group of object type.

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

References null.

Referenced by getExplorerContainerTypes(), and ilAbstractSearch\getValidObjectTypes().

                                                    : ?string
     {
         return $this->obj_data[$obj_name]["group"] ?? null;
     }

Here is the caller graph for this function:

◆ getLocation()

ilObjectDefinition::getLocation ( string $obj_name )

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

Referenced by ilConditionHandler\_checkCondition(), ilContainer\getCompleteDescriptions(), and ilConditionHandler\getOperatorsByTriggerType().

                                                  : string
     {
         return $this->obj_data[$obj_name]["location"] ?? '';
     }

Here is the caller graph for this function:

◆ getLTIProviderTypes()

ilObjectDefinition::getLTIProviderTypes ( )

Get object types which offer lti provider support.

Returns: string[] $types

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

                                          : array
     {
         $types = [];
         foreach ($this->obj_data as $type => $object_info) {
             if (array_key_exists('lti_provider', $object_info) && $object_info['lti_provider']) {
                 $types[] = $type;
             }
         }
         return $types;
     }

◆ getOrgUnitPermissionTypes()

ilObjectDefinition::getOrgUnitPermissionTypes ( )

Get object type with org unit position permission support.

Returns: string[] $types

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

Referenced by isOrgUnitPermissionType().

                                                : array
     {
         $types = [];
         foreach ($this->obj_data as $type => $object_info) {
             if ($object_info['orgunit_permissions']) {
                 $types[] = $type;
             }
         }
         return $types;
     }

Here is the caller graph for this function:

◆ getPlugins()

ilObjectDefinition::getPlugins ( )

Get plugin object info.

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

References isPlugin().

                                 : array
     {
         $plugins = [];
         foreach ($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 ( string $type )

Get Position By Object Type.

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

References ILIAS\Repository\settings().

                                                    : int
     {
         if ($this->settings->get("obj_add_new_pos_" . $type) > 0) {
             return (int) $this->settings->get("obj_add_new_pos_" . $type);
         }
         return (int) $this->obj_data[$type]["default_pos"];
     }

Here is the call graph for this function:

◆ getRepositoryObjectTypesForComponent()

static ilObjectDefinition::getRepositoryObjectTypesForComponent	(	string	$component_type,
		string	$component_name
	)

static

Get all repository object types of component.

This is only every called with $a_component_type = "components/ILIAS". This is only used in two locations:

Services/Repository/Administration/class.ilModulesTableGUI.php
Services/Repository/Administration/class.ilObjRepositorySettings.php

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

References $DIC, and $ilDB.

                                                                                                                : array
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $sql =
             "SELECT id, class_name, component, location, checkbox, inherit, translate, devmode, allow_link," . PHP_EOL
             . "allow_copy, rbac, `system`, sideblock, default_pos, grp, default_pres_pos, `export`, repository," . PHP_EOL
             . "workspace, administration, amet, orgunit_permissions, lti_provider, offline_handling" . PHP_EOL
             . "FROM il_object_def" . PHP_EOL
             . "WHERE component = %s" . PHP_EOL
         ;
         $result = $ilDB->queryF($sql, ["text"], [$component_type . "/" . $component_name]);
 
         $types = [];
         while ($rec = $ilDB->fetchAssoc($result)) {
             if ($rec["system"] != 1) {
                 $types[] = $rec;
             }
         }
 
         return $types;
     }

◆ getSideBlockTypes()

ilObjectDefinition::getSideBlockTypes ( bool $filter_repository_types = true )

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

References isAllowedInRepository(), and isSideBlock().

                                                                            : array
     {
         $side_block_types = [];
         foreach (array_keys($this->obj_data) as $type) {
             if (
                 $filter_repository_types &&
                 !$this->isAllowedInRepository($type)
             ) {
                 continue;
             }
             if ($this->isSideBlock($type)) {
                 $side_block_types[] = $type;
             }
         }
         return $side_block_types;
     }

Here is the call graph for this function:

◆ getSubObjects()

ilObjectDefinition::getSubObjects	(	string	$obj_type,
		bool	$filter = `true`
	)

get all sub objects by type

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

References $data, __filterObjects(), ILIAS\Repository\int(), ILIAS\Repository\settings(), and ilArrayUtil\sortArray().

Referenced by getCreatableSubObjects(), and getSubObjectsRecursively().

                                                                         : array
     {
         $subs = [];
         if ($subobjects = ($this->obj_data[$obj_type]["subobjects"] ?? false)) {
             // Filter some objects e.g. chat object are creatable if chat is active
             if ($filter) {
                 $this->__filterObjects($subobjects);
             }
             foreach ($subobjects as $data => $sub) {
                 if (!isset($sub["module"]) || $sub["module"] != "n") {
                     if (!($this->settings->get("obj_dis_creation_" . $data))) {
                         $subs[$data] = $sub;
 
                         // determine position
                         $pos = (int) $this->obj_data[$data]["default_pos"];
                         if ($this->settings->get("obj_add_new_pos_" . $data) > 0) {
                             $pos = (int) $this->settings->get("obj_add_new_pos_" . $data);
                         }
                         $subs[$data]["pos"] = $pos;
                     }
                 }
             }
 
             return ilArrayUtil::sortArray($subs, "pos", 'ASC', true, true);
         }
 
         return $subs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubObjectsAsString()

ilObjectDefinition::getSubObjectsAsString ( string $obj_type )

get a string of all sub objects by type

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

References $data.

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

◆ getSubObjectsRecursively()

ilObjectDefinition::getSubObjectsRecursively	(	string	$obj_type,
		bool	$include_source_obj = `true`,
		bool	$add_admin_objects = `false`
	)

Get all sub objects by type.

This function returns all sub objects allowed by the provided object type and all its sub object types recursively.

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

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

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

Referenced by ilObject\getAllOwnedRepositoryObjects(), and getExplorerContainerTypes().

      : array {
         // This associative array is used to collect all sub object types.
         // key=>type, value=data
         $recursive_subs = [];
 
         // This array is used to keep track of the object types, we
         // need to call function getSubobjects() for.
         $to_do = [$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 = [];
 
         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 (!$add_admin_objects and $type == 'adm') {
                 $subs = [];
             } else {
                 $subs = $this->getSubObjects($type);
             }
             foreach ($subs as $subtype => $data) {
                 // Hide role templates and folder from view
                 if ($this->getDevMode($subtype) or !$this->isRBACObject($subtype)) {
                     continue;
                 }
                 if ($subtype == 'rolt') {
                     continue;
                 }
                 if (!$add_admin_objects and $subtype == 'adm') {
                     continue;
                 }
 
                 $recursive_subs[$subtype] = $data;
                 if (!in_array($subtype, $done) && !in_array($subtype, $to_do)) {
                     $to_do[] = $subtype;
                 }
             }
         }
 
         if ($include_source_obj) {
             if (!isset($recursive_subs[$obj_type])) {
                 $recursive_subs[$obj_type]['name'] = $obj_type;
                 $recursive_subs[$obj_type]['lng'] = $obj_type;
                 $recursive_subs[$obj_type]['max'] = 0;
                 $recursive_subs[$obj_type]['pos'] = -1;
             }
         }
         return ilArrayUtil::sortArray($recursive_subs, "pos", 'ASC', true, true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubobjectsToFilter()

ilObjectDefinition::getSubobjectsToFilter ( string $obj_type = "adm" )

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

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

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

                                                                    : array
     {
         foreach ($this->obj_data[$obj_type]["subobjects"] as $key => $value) {
             switch ($key) {
                 case "rolf":
                 case "orgu":
                     // DO NOTHING
                     break;
 
                 default:
                     $tmp_subs[] = $key;
             }
         }
         $tmp_subs[] = "adm";
 
         return $tmp_subs;
     }

◆ getTranslationType()

ilObjectDefinition::getTranslationType ( string $obj_name )

get translation type (sys, db or null)

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

References $DIC, $ilDB, $root_trans_type, ilDBConstants\FETCHMODE_ASSOC, and ROOT_FOLDER_ID.

                                                         : ?string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         if ($obj_name == "root") {
             if (!isset($this->root_trans_type)) {
                 $sql =
                     "SELECT count(obj_id) cnt" . PHP_EOL
                     . "FROM object_translation" . PHP_EOL
                     . "WHERE obj_id = " . $ilDB->quote(ROOT_FOLDER_ID, 'integer') . PHP_EOL
                 ;
                 $set = $ilDB->query($sql);
                 $rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
                 if ($rec["cnt"] > 0) {
                     $this->root_trans_type = "db";
                 } else {
                     $this->root_trans_type = $this->obj_data[$obj_name]["translate"];
                 }
             }
             return $this->root_trans_type;
         }
 
         if (isset($this->obj_data[$obj_name])) {
             return $this->obj_data[$obj_name]["translate"];
         }
 
         return "";
     }

◆ handlerBeginTag()

ilObjectDefinition::handlerBeginTag	(		$xml_parser,
		string	$name,
		array	$attribs
	)

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

References $current_tag_name, and $parent_tag_name.

Referenced by setHandlers().

                                                                               : void
     {
         switch ($name) {
             case 'object':
                 $this->parent_tag_name = $attribs["name"];
                 break;
             case 'property':
                 $this->current_tag = "property";
                 $this->current_tag_name = $attribs["name"];
                 $this->obj_data[$this->parent_tag_name]["properties"][$this->current_tag_name]["module"] = $attribs["module"];
                 break;
         }
     }

Here is the caller graph for this function:

◆ handlerCharacterData()

ilObjectDefinition::handlerCharacterData	(		$xml_parser,
		string	$data
	)

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

Referenced by setHandlers().

                                                                    : void
     {
     }

Here is the caller graph for this function:

◆ handlerEndTag()

ilObjectDefinition::handlerEndTag	(		$xml_parser,
		string	$name
	)

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

Referenced by setHandlers().

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

Here is the caller graph for this function:

◆ hasCheckbox()

ilObjectDefinition::hasCheckbox ( string $obj_name )

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

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

                                                  : bool
     {
         return (bool) ($this->obj_data[$obj_name]["checkbox"] ?? false);
     }

◆ hasLocalRoles()

ilObjectDefinition::hasLocalRoles ( string $obj_type )

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

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

                                                    : bool
     {
         switch ($obj_type) {
             case 'root':
                 return false;
 
             default:
                 return true;
         }
     }

◆ isActivePluginType()

ilObjectDefinition::isActivePluginType ( string $type )

Returns true if the given type is an active type of repositoryObject or Organisation Unit Extension plugin.

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

                                                     : bool
     {
         if (!$this->component_repository->hasPluginId($type)) {
             return false;
         }
         $plugin_slot = $this->component_repository->getPluginById($type)->getPluginSlot();
         return $plugin_slot->getId() === "robj" || $plugin_slot->getId() === "orguext";
     }

◆ isAdministrationObject()

ilObjectDefinition::isAdministrationObject ( string $obj_name )

Check if administration object.

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

Referenced by getAllRepositoryTypes(), getCreatableSubObjects(), and ilAbstractSearch\getValidObjectTypes().

                                                             : bool
     {
         return (bool) ($this->obj_data[$obj_name]['administration'] ?? false);
     }

Here is the caller graph for this function:

◆ isAllowedInRepository()

ilObjectDefinition::isAllowedInRepository ( string $obj_name )

checks if object type can be used in repository context

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

Referenced by getAllRepositoryTypes(), getCreatableSubObjects(), getSideBlockTypes(), and ilAbstractSearch\getValidObjectTypes().

                                                            : bool
     {
         return (bool) ($this->obj_data[$obj_name]["repository"] ?? false);
     }

Here is the caller graph for this function:

◆ isAllowedInWorkspace()

ilObjectDefinition::isAllowedInWorkspace ( string $obj_name )

checks if object type can be used in workspace context

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

Referenced by getCreatableSubObjects().

                                                           : bool
     {
         return (bool) ($this->obj_data[$obj_name]["workspace"] ?? false);
     }

Here is the caller graph for this function:

◆ isContainer()

ilObjectDefinition::isContainer ( string $obj_name )

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

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

Referenced by getExplorerContainerTypes(), and ilDidacticTemplateSetting\hasIconSupport().

                                                  : bool
     {
         return (bool) ($this->obj_data[$obj_name]['subobjects'] ?? false);
     }

Here is the caller graph for this function:

◆ isInactivePlugin()

ilObjectDefinition::isInactivePlugin ( string $type )

Check whether type belongs to inactive plugin.

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

References isPlugin().

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

Here is the call graph for this function:

◆ isOrgUnitPermissionType()

ilObjectDefinition::isOrgUnitPermissionType ( string $obj_type )

Check if object type offers org unit position support.

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

References getOrgUnitPermissionTypes().

                                                              : bool
     {
         return in_array($obj_type, $this->getOrgUnitPermissionTypes());
     }

Here is the call graph for this function:

◆ isPlugin()

ilObjectDefinition::isPlugin ( string $obj_name )

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

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

Referenced by ilObject\_prepareCloneSelection(), ilAdministrationGUI\executeCommand(), ilNewsForContextBlockGUI\getInfoForData(), getPlugins(), and isInactivePlugin().

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

Here is the caller graph for this function:

◆ isPluginTypeName()

ilObjectDefinition::isPluginTypeName ( string $str )

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

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

                                                  : bool
     {
         return (substr($str, 0, 1) == "x");
     }

◆ isRBACObject()

ilObjectDefinition::isRBACObject ( string $obj_name )

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

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

Referenced by ilObject\_writeDescription(), getAllRBACObjects(), getSubObjectsRecursively(), and ilAbstractSearch\getValidObjectTypes().

                                                   : bool
     {
         return (bool) ($this->obj_data[$obj_name]["rbac"] ?? false);
     }

Here is the caller graph for this function:

◆ isSideBlock()

ilObjectDefinition::isSideBlock ( string $obj_name )

Check, whether object type is a side block.

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

Referenced by ilSessionMaterialsTableGUI\getDataFromDb(), getSideBlockTypes(), and ilAbstractSearch\getValidObjectTypes().

                                                  : bool
     {
         return (bool) ($this->obj_data[$obj_name]["sideblock"] ?? false);
     }

Here is the caller graph for this function:

◆ isSystemObject()

ilObjectDefinition::isSystemObject ( string $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 administration, 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

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

Referenced by getCreatableSubObjects(), and ilAbstractSearch\getValidObjectTypes().

                                                     : bool
     {
         return (bool) ($this->obj_data[$obj_name]["system"] ?? false);
     }

Here is the caller graph for this function:

◆ parsePluginData()

ilObjectDefinition::parsePluginData	(	string	$slotId,
		bool	$isInAdministration
	)

protected

loads a single plugin definition into the object definition

Parameters

$slotId	string slot id, e.g. robj
$isInAdministration	bool can the object be created in the administration?

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

References XapiProxy\$plugin, ilObjectPlugin\getPluginObjectByType(), and null.

Referenced by readPluginData().

                                                                                 : void
     {
         $plugins = $this->component_repository->getPluginSlotById($slotId)->getActivePlugins();
         foreach ($plugins as $plugin) {
             $pl_id = $plugin->getId();
             if ($pl_id != "" && !isset($this->obj_data[$pl_id])) {
                 $loc = $plugin->getPath() . "/classes";
                 // The plugin_id is the same as the type_id in repository object plugins.
                 $pl = ilObjectPlugin::getPluginObjectByType($pl_id);
 
                 $this->obj_data[$pl_id] = [
                     "name" => $pl_id,
                     "class_name" => $pl->getPluginName(),
                     "plugin" => "1",
                     "location" => $loc,
                     "checkbox" => "1",
                     "inherit" => "0",
                     "component" => "",
                     "translate" => "0",
                     "devmode" => "0",
                     "allow_link" => "1",
                     "allow_copy" => $pl->allowCopy() ? '1' : '0',
                     "rbac" => "1",
                     "group" => null,
                     "system" => "0",
                     "default_pos" => "99992000", // "unassigned" group
                     'repository' => '1',
                     'workspace' => '0',
                     'administration' => $isInAdministration ? '1' : '0',
                     "sideblock" => "0",
                     'export' => $plugin->supportsExport(),
                     'offline_handling' => '0',
                     'orgunit_permissions' => $pl->useOrguPermissions() ? '1' : '0'
                 ];
 
                 $parent_types = $pl->getParentTypes();
                 foreach ($parent_types as $parent_type) {
                     $this->obj_data[$parent_type]["subobjects"][$pl_id] = [
                         "name" => $pl_id,
                         "max" => "",
                         "lng" => $pl_id,
                         "plugin" => true
                     ];
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDefinitionData()

ilObjectDefinition::readDefinitionData ( )

Read object definition data.

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

References ilCachedObjectDefinition\getInstance(), and readPluginData().

Referenced by __construct().

                                         : void
     {
         $global_cache = ilCachedObjectDefinition::getInstance();
         foreach ($global_cache->getIlObjectDef() as $rec) {
             $this->obj_data[$rec["id"]] = [
                 "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((string) $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'],
                 'orgunit_permissions' => $rec['orgunit_permissions'],
                 'lti_provider' => $rec['lti_provider'],
                 'offline_handling' => $rec['offline_handling']
             ];
             $this->obj_data[$rec["id"]]["subobjects"] = [];
 
             $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"]] = [
                 "name" => $rec2["subobj"],
                 "max" => $max,
                 "lng" => $rec2["subobj"]
             ];
         }
 
         $this->obj_group = $global_cache->getIlObjectGroup();
         $this->readPluginData();
         $this->sub_types = $global_cache->getIlObjectSubType();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readPluginData()

ilObjectDefinition::readPluginData ( )

protected

Loads the different plugins into the object definition.

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

References parsePluginData().

Referenced by readDefinitionData().

                                        : void
     {
         $this->parsePluginData("robj", false);
         $this->parsePluginData("orguext", true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilObjectDefinition::setHandlers ( $xml_parser )

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

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

                                             : void
     {
         xml_set_element_handler($xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
         xml_set_character_data_handler($xml_parser, $this->handlerCharacterData(...));
     }

Here is the call graph for this function:

◆ stopInheritance()

ilObjectDefinition::stopInheritance ( string $obj_name )

Does object permits stopping inheritance?

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

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

◆ supportsOfflineHandling()

ilObjectDefinition::supportsOfflineHandling ( string $obj_type )

check whether obj_type supports centralised offline handling

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

                                                              : bool
     {
         return (bool) ($this->obj_data[$obj_type]['offline_handling'] ?? false);
     }

Field Documentation

◆ $component_repository

ilComponentRepository ilObjectDefinition::$component_repository

protected

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

◆ $current_tag

string ilObjectDefinition::$current_tag

protected

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

◆ $current_tag_name

string ilObjectDefinition::$current_tag_name

protected

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

Referenced by handlerBeginTag().

◆ $obj_data

array ilObjectDefinition::$obj_data = []

protected

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

◆ $obj_group

array ilObjectDefinition::$obj_group = []

protected

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

◆ $parent_tag_name

string ilObjectDefinition::$parent_tag_name

protected

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

Referenced by handlerBeginTag().

◆ $root_trans_type

string ilObjectDefinition::$root_trans_type = null

protected

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

Referenced by getTranslationType().

◆ $settings

ilSetting ilObjectDefinition::$settings

protected

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

◆ $sub_types

array ilObjectDefinition::$sub_types = []

protected

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

◆ MODE_ADMINISTRATION

const ilObjectDefinition::MODE_ADMINISTRATION = 3

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

Referenced by ilObjTalkTemplateAdministrationGUI\getCreatableObjectTypes(), and ilObjOrgUnitGUI\getCreatableObjectTypes().

◆ MODE_REPOSITORY

const ilObjectDefinition::MODE_REPOSITORY = 1

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

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

◆ MODE_WORKSPACE

const ilObjectDefinition::MODE_WORKSPACE = 2

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

Referenced by ilObjWorkspaceFolderGUI\buildAvailableObjectTypes().

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

components/ILIAS/ILIASObject/classes/class.ilObjectDefinition.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __filterObjects()

◆ allowCopy()

◆ allowExport()

◆ allowLink()

◆ getAdvancedMetaDataTypes()

◆ getAllObjects()

◆ getAllRBACObjects()

◆ getAllRepositoryTypes()

◆ getClassName()

◆ getComponentForType()

◆ getCreatableSubObjects()

◆ getDevMode()

◆ getDevModeAll()

◆ getExplorerContainerTypes()

◆ getGroup()

◆ getGroupedPluginObjectTypes()

◆ getGroupedRepositoryObjectTypes()

◆ getGroupOfObj()

◆ getLocation()

◆ getLTIProviderTypes()

◆ getOrgUnitPermissionTypes()

◆ getPlugins()

◆ getPositionByType()

◆ getRepositoryObjectTypesForComponent()

◆ getSideBlockTypes()

◆ getSubObjects()

◆ getSubObjectsAsString()

◆ getSubObjectsRecursively()

◆ getSubobjectsToFilter()

◆ getTranslationType()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ hasCheckbox()

◆ hasLocalRoles()

◆ isActivePluginType()

◆ isAdministrationObject()

◆ isAllowedInRepository()

◆ isAllowedInWorkspace()

◆ isContainer()

◆ isInactivePlugin()

◆ isOrgUnitPermissionType()

◆ isPlugin()

◆ isPluginTypeName()

◆ isRBACObject()

◆ isSideBlock()

◆ isSystemObject()

◆ parsePluginData()

◆ readDefinitionData()

◆ readPluginData()

◆ setHandlers()

◆ stopInheritance()

◆ supportsOfflineHandling()

Field Documentation

◆ $component_repository

◆ $current_tag

◆ $current_tag_name

◆ $obj_data

◆ $obj_group

◆ $parent_tag_name

◆ $root_trans_type

◆ $settings

◆ $sub_types

◆ MODE_ADMINISTRATION

◆ MODE_REPOSITORY

◆ MODE_WORKSPACE