ILIAS
release_8 Revision v8.19
|
parses the objects.xml it handles the xml-description of all ilias objects More...
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 | |
readDefinitionDataFromCache () | |
readDefinitionDataFromDB () | |
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 |
parses the objects.xml it handles the xml-description of all ilias objects
Definition at line 28 of file class.ilObjectDefinition.php.
ilObjectDefinition::__construct | ( | ) |
Definition at line 44 of file class.ilObjectDefinition.php.
References $DIC, readDefinitionData(), and ILIAS\Repository\settings().
ilObjectDefinition::__filterObjects | ( | array & | $sub_objects | ) |
Definition at line 645 of file class.ilObjectDefinition.php.
Referenced by getSubObjects().
ilObjectDefinition::allowCopy | ( | string | $obj_name | ) |
checks if copying of an object type is allowed
Definition at line 403 of file class.ilObjectDefinition.php.
ilObjectDefinition::allowExport | ( | string | $obj_name | ) |
Definition at line 408 of file class.ilObjectDefinition.php.
ilObjectDefinition::allowLink | ( | string | $obj_name | ) |
checks if linking of an object type is allowed
Definition at line 395 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAdvancedMetaDataTypes | ( | ) |
Get advanced meta data objects.
Definition at line 829 of file class.ilObjectDefinition.php.
References $type.
ilObjectDefinition::getAllObjects | ( | ) |
get all object types
Definition at line 387 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAllRBACObjects | ( | ) |
Definition at line 370 of file class.ilObjectDefinition.php.
References $type, and isRBACObject().
ilObjectDefinition::getAllRepositoryTypes | ( | bool | $incl_adm = false | ) |
get all RBAC object types
Definition at line 785 of file class.ilObjectDefinition.php.
References $type, isAdministrationObject(), and isAllowedInRepository().
ilObjectDefinition::getClassName | ( | string | $obj_name | ) |
Definition at line 230 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().
|
static |
Get component for object type.
Definition at line 725 of file class.ilObjectDefinition.php.
ilObjectDefinition::getCreatableSubObjects | ( | string | $obj_type, |
int | $context = self::MODE_REPOSITORY , |
||
int | $parent_ref_id = null |
||
) |
Definition at line 556 of file class.ilObjectDefinition.php.
References $context, $type, ilObjStudyProgramme\getCreatableSubObjects(), getDevMode(), getSubObjects(), isAdministrationObject(), isAllowedInRepository(), isAllowedInWorkspace(), and isSystemObject().
Referenced by ilPermissionGUI\savePermissions().
ilObjectDefinition::getDevMode | ( | string | $obj_name | ) |
get dev mode status by type
Definition at line 308 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects(), getDevModeAll(), and getSubObjectsRecursively().
ilObjectDefinition::getDevModeAll | ( | ) |
get all object types in dev mode
Definition at line 318 of file class.ilObjectDefinition.php.
References $type, and getDevMode().
ilObjectDefinition::getExplorerContainerTypes | ( | ) |
Get all object types which are defined as container in an explorer context.
Definition at line 916 of file class.ilObjectDefinition.php.
References $res, $type, getGroupOfObj(), getSubObjectsRecursively(), and isContainer().
ilObjectDefinition::getGroup | ( | string | $id | ) |
Get Group information.
Definition at line 243 of file class.ilObjectDefinition.php.
References $id.
|
staticprotected |
Definition at line 212 of file class.ilObjectDefinition.php.
References $DIC, XapiProxy\$plugin, and ilComponentRepository\getPluginSlotById().
|
static |
mixed | $parent_obj_type |
Definition at line 742 of file class.ilObjectDefinition.php.
References $DIC, $ilDB, ilDBConstants\FETCHMODE_ASSOC, ilCachedObjectDefinition\getInstance(), ILIAS\Repository\int(), and ilArrayUtil\sortArray().
ilObjectDefinition::getGroupOfObj | ( | string | $obj_name | ) |
Get Group of object type.
Definition at line 251 of file class.ilObjectDefinition.php.
Referenced by getExplorerContainerTypes().
ilObjectDefinition::getLocation | ( | string | $obj_name | ) |
Definition at line 235 of file class.ilObjectDefinition.php.
Referenced by ilConditionHandler\_checkCondition(), ilContainer\getCompleteDescriptions(), ilConditionHandler\getOperatorsByTriggerType(), and ilObjectFactory\includeClassIfNotExists().
ilObjectDefinition::getLTIProviderTypes | ( | ) |
Get object types which offer lti provider support.
Definition at line 869 of file class.ilObjectDefinition.php.
References $type.
ilObjectDefinition::getOrgUnitPermissionTypes | ( | ) |
Get object type with org unit position permission support.
Definition at line 854 of file class.ilObjectDefinition.php.
References $type.
Referenced by isOrgUnitPermissionType().
ilObjectDefinition::getPlugins | ( | ) |
Get plugin object info.
Definition at line 902 of file class.ilObjectDefinition.php.
References $type, and isPlugin().
ilObjectDefinition::getPositionByType | ( | string | $type | ) |
Get Position By Object Type.
Definition at line 891 of file class.ilObjectDefinition.php.
References $type, and ILIAS\Repository\settings().
|
static |
Get all repository object types of component.
This is only every called with $a_component_type = "Modules". This is only used in two locations:
Definition at line 698 of file class.ilObjectDefinition.php.
ilObjectDefinition::getSideBlockTypes | ( | bool | $filter_repository_types = true | ) |
Definition at line 673 of file class.ilObjectDefinition.php.
References $type, isAllowedInRepository(), and isSideBlock().
Referenced by ilObjSessionGUI\materialsObject().
ilObjectDefinition::getSubObjects | ( | string | $obj_type, |
bool | $filter = true |
||
) |
get all sub objects by type
Definition at line 431 of file class.ilObjectDefinition.php.
References $data, __filterObjects(), ILIAS\Repository\int(), ILIAS\Repository\settings(), and ilArrayUtil\sortArray().
Referenced by getCreatableSubObjects(), and getSubObjectsRecursively().
ilObjectDefinition::getSubObjectsAsString | ( | string | $obj_type | ) |
get a string of all sub objects by type
Definition at line 595 of file class.ilObjectDefinition.php.
References $data.
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 468 of file class.ilObjectDefinition.php.
References $data, $type, getDevMode(), getSubObjects(), isRBACObject(), and ilArrayUtil\sortArray().
Referenced by ilObject\getAllOwnedRepositoryObjects(), and getExplorerContainerTypes().
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 538 of file class.ilObjectDefinition.php.
References ILIAS\LTI\ToolProvider\$key.
ilObjectDefinition::getTranslationType | ( | string | $obj_name | ) |
get translation type (sys, db or null)
Definition at line 267 of file class.ilObjectDefinition.php.
References $DIC, $ilDB, ilDBConstants\FETCHMODE_ASSOC, and ROOT_FOLDER_ID.
ilObjectDefinition::handlerBeginTag | ( | $xml_parser, | |
string | $name, | ||
array | $attribs | ||
) |
Definition at line 621 of file class.ilObjectDefinition.php.
References $current_tag_name, and $parent_tag_name.
ilObjectDefinition::handlerCharacterData | ( | $xml_parser, | |
string | $data | ||
) |
Definition at line 635 of file class.ilObjectDefinition.php.
ilObjectDefinition::handlerEndTag | ( | $xml_parser, | |
string | $name | ||
) |
Definition at line 639 of file class.ilObjectDefinition.php.
ilObjectDefinition::hasCheckbox | ( | string | $obj_name | ) |
should the object get a checkbox (needed for 'cut','copy' ...)
Definition at line 259 of file class.ilObjectDefinition.php.
ilObjectDefinition::hasLocalRoles | ( | string | $obj_type | ) |
Check whether the creation of local roles is allowed Currently disabled for type "root" and "adm".
Definition at line 417 of file class.ilObjectDefinition.php.
ilObjectDefinition::isActivePluginType | ( | string | $type | ) |
Returns true if the given type is an active type of repositoryObject or Organisation Unit Extension plugin.
Definition at line 361 of file class.ilObjectDefinition.php.
ilObjectDefinition::isAdministrationObject | ( | string | $obj_name | ) |
Check if administration object.
Definition at line 810 of file class.ilObjectDefinition.php.
Referenced by getAllRepositoryTypes(), and getCreatableSubObjects().
ilObjectDefinition::isAllowedInRepository | ( | string | $obj_name | ) |
checks if object type can be used in repository context
Definition at line 777 of file class.ilObjectDefinition.php.
Referenced by getAllRepositoryTypes(), getCreatableSubObjects(), and getSideBlockTypes().
ilObjectDefinition::isAllowedInWorkspace | ( | string | $obj_name | ) |
checks if object type can be used in workspace context
Definition at line 802 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects().
ilObjectDefinition::isContainer | ( | string | $obj_name | ) |
Check if object type is container ('crs','fold','grp' ...)
Definition at line 609 of file class.ilObjectDefinition.php.
Referenced by getExplorerContainerTypes(), ilPermissionGUI\hasContainerCommands(), and ilDidacticTemplateSetting\hasIconSupport().
ilObjectDefinition::isInactivePlugin | ( | string | $type | ) |
Check whether type belongs to inactive plugin.
Definition at line 818 of file class.ilObjectDefinition.php.
References isPlugin().
ilObjectDefinition::isOrgUnitPermissionType | ( | string | $obj_type | ) |
Check if object type offers org unit position support.
Definition at line 883 of file class.ilObjectDefinition.php.
References getOrgUnitPermissionTypes().
ilObjectDefinition::isPlugin | ( | string | $obj_name | ) |
get RBAC status by type returns true if object type is an (activated) plugin type
Definition at line 345 of file class.ilObjectDefinition.php.
Referenced by ilObject\_prepareCloneSelection(), ilAdministrationGUI\executeCommand(), ilNewsForContextBlockGUI\getInfoForData(), getPlugins(), and isInactivePlugin().
ilObjectDefinition::isPluginTypeName | ( | string | $str | ) |
Check if given type is a plugin type name (starts with an "x")
Definition at line 353 of file class.ilObjectDefinition.php.
ilObjectDefinition::isRBACObject | ( | string | $obj_name | ) |
get RBAC status by type returns true if object type is a RBAC object type
Definition at line 336 of file class.ilObjectDefinition.php.
Referenced by ilObject\_writeDescription(), getAllRBACObjects(), and getSubObjectsRecursively().
ilObjectDefinition::isSideBlock | ( | string | $obj_name | ) |
Check, whether object type is a side block.
Definition at line 668 of file class.ilObjectDefinition.php.
Referenced by ilSessionMaterialsTableGUI\getDataFromDb(), and getSideBlockTypes().
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 660 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects().
|
protected |
loads a single plugin definition into the object definition
$slotId | string slot id, e.g. robj |
$isInAdministration | bool can the object be created in the administration? |
Definition at line 977 of file class.ilObjectDefinition.php.
References XapiProxy\$plugin, and ilObjectPlugin\getPluginObjectByType().
Referenced by readPluginData().
ilObjectDefinition::readDefinitionData | ( | ) |
Read object definition data.
Definition at line 203 of file class.ilObjectDefinition.php.
References ilGlobalCache\COMP_OBJ_DEF, ilGlobalCache\getInstance(), readDefinitionDataFromCache(), and readDefinitionDataFromDB().
Referenced by __construct().
|
protected |
Definition at line 53 of file class.ilObjectDefinition.php.
References ilCachedObjectDefinition\getInstance(), and readPluginData().
Referenced by readDefinitionData().
|
protected |
Definition at line 110 of file class.ilObjectDefinition.php.
References $DIC, $ilDB, and readPluginData().
Referenced by readDefinitionData().
|
protected |
Loads the different plugins into the object definition.
Definition at line 966 of file class.ilObjectDefinition.php.
References parsePluginData().
Referenced by readDefinitionDataFromCache(), and readDefinitionDataFromDB().
ilObjectDefinition::setHandlers | ( | $xml_parser | ) |
Definition at line 614 of file class.ilObjectDefinition.php.
ilObjectDefinition::stopInheritance | ( | string | $obj_name | ) |
Does object permits stopping inheritance?
Definition at line 300 of file class.ilObjectDefinition.php.
ilObjectDefinition::supportsOfflineHandling | ( | string | $obj_type | ) |
check whether obj_type supports centralised offline handling
Definition at line 956 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 35 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 41 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 42 of file class.ilObjectDefinition.php.
Referenced by handlerBeginTag().
|
protected |
Definition at line 37 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 38 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 40 of file class.ilObjectDefinition.php.
Referenced by handlerBeginTag().
|
protected |
Definition at line 34 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 39 of file class.ilObjectDefinition.php.
const ilObjectDefinition::MODE_ADMINISTRATION = 3 |
Definition at line 32 of file class.ilObjectDefinition.php.
Referenced by ilObjTalkTemplateAdministrationGUI\showPossibleSubObjects(), and ilObjOrgUnitGUI\showPossibleSubObjects().
const ilObjectDefinition::MODE_REPOSITORY = 1 |
Definition at line 30 of file class.ilObjectDefinition.php.
Referenced by ilObjectAddNewItemGUI\__construct(), ilTrQuery\getObjectTypeStatistics(), and ilObjectGUI\showPossibleSubObjects().
const ilObjectDefinition::MODE_WORKSPACE = 2 |
Definition at line 31 of file class.ilObjectDefinition.php.
Referenced by ilObjectAddNewItemGUI\getHTML(), ilObjectAddNewItemGUI\parsePersonalWorkspace(), ilObjWorkspaceFolderGUI\render(), and ilObjectAddNewItemGUI\render().