ILIAS
release_5-4 Revision v5.4.26-12-gabc799a52e6
|
parses the objects.xml it handles the xml-description of all ilias objects More...
Public Member Functions | |
__construct () | |
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... | |
isActivePluginType ($type) | |
Returns true iff the given type is an active type of a repositoryObject or Organisation Unit Extension plugin. 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 necessary 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... | |
getSideBlockTypes (bool $filter_repository_types=true) | |
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... | |
getOrgUnitPermissionTypes () | |
Get object type with orgunit position permission support. More... | |
getLTIProviderTypes () | |
Get object types which offer lti provider support. More... | |
isOrgUnitPermissionType ($a_obj_type) | |
Check if object type offers orgunit position support. 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... | |
supportsOfflineHandling ($a_obj_type) | |
check whether obj_type supports centralised offline handling 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) |
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 () | |
readPluginData () | |
Loads the different plugins into the object definition. More... | |
parsePluginData ($component, $slotName, $slotId, $isInAdministration) | |
loads a single plugin definition into the object definition More... | |
Static Protected Member Functions | |
static | getGroupedPluginObjectTypes ($grouped_obj, $component, $slotName, $slotId) |
Protected Attributes | |
$plugin_admin | |
$settings | |
parses the objects.xml it handles the xml-description of all ilias objects
ilObjDefReader on il_object_def, il_object_subobj, il_object_group
Definition at line 15 of file class.ilObjectDefinition.php.
ilObjectDefinition::__construct | ( | ) |
Constructor.
Definition at line 58 of file class.ilObjectDefinition.php.
References $DIC, readDefinitionData(), and settings().
ilObjectDefinition::__filterObjects | ( | & | $subobjects | ) |
Definition at line 791 of file class.ilObjectDefinition.php.
Referenced by getSubObjects().
ilObjectDefinition::allowCopy | ( | $a_obj_name | ) |
checks if copying of an object type is allowed
string | object type public |
Definition at line 472 of file class.ilObjectDefinition.php.
ilObjectDefinition::allowExport | ( | $a_obj_name | ) |
Definition at line 477 of file class.ilObjectDefinition.php.
ilObjectDefinition::allowLink | ( | $a_obj_name | ) |
checks if linking of an object type is allowed
string | object type public |
Definition at line 461 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAdvancedMetaDataTypes | ( | ) |
Get advanced meta data objects.
Definition at line 1013 of file class.ilObjectDefinition.php.
References $sub_types, $t, and $type.
ilObjectDefinition::getAllObjects | ( | ) |
get all object types
public
Definition at line 450 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAllRBACObjects | ( | ) |
get all RBAC object types
public
Definition at line 431 of file class.ilObjectDefinition.php.
References $type, and isRBACObject().
ilObjectDefinition::getAllRepositoryTypes | ( | $a_incl_adm = false | ) |
get all RBAC object types
public
Definition at line 956 of file class.ilObjectDefinition.php.
References $type, isAdministrationObject(), and isAllowedInRepository().
ilObjectDefinition::getClassName | ( | $a_obj_name | ) |
get class name by type
string | object type public |
Definition at line 247 of file class.ilObjectDefinition.php.
|
static |
ilObjectDefinition::getCreatableSubObjects | ( | $a_obj_type, | |
$a_context = self::MODE_REPOSITORY , |
|||
$a_parent_ref_id = null |
|||
) |
get only creatable subobjects by type
string | object type |
integer | context |
integer | parent_ref_id public |
Definition at line 658 of file class.ilObjectDefinition.php.
References $sub_types, $type, ilObjStudyProgramme\getCreatableSubObjects(), getDevMode(), getSubObjects(), isAdministrationObject(), isAllowedInRepository(), isAllowedInWorkspace(), and isSystemObject().
ilObjectDefinition::getDevMode | ( | $a_obj_name | ) |
get devmode status by type
string | object type public |
Definition at line 343 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects(), getDevModeAll(), and getSubObjectsRecursively().
ilObjectDefinition::getDevModeAll | ( | ) |
get all object types in devmode
public
Definition at line 354 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 1108 of file class.ilObjectDefinition.php.
References $res, $type, getGroupOfObj(), getSubObjectsRecursively(), and isContainer().
ilObjectDefinition::getGroup | ( | $a_id | ) |
Get Group information.
Definition at line 267 of file class.ilObjectDefinition.php.
|
staticprotected |
$grouped_obj | |
$component | |
$slotName | |
$slotId | |
$plugin_id |
Definition at line 219 of file class.ilObjectDefinition.php.
References $DIC, and ilPlugin\lookupIdForName().
|
static |
$a_parent_obj_type |
Definition at line 904 of file class.ilObjectDefinition.php.
References $DIC, $ilDB, $ret, ilDBConstants\FETCHMODE_ASSOC, ilCachedComponentData\getInstance(), IL_COMP_MODULE, IL_COMP_SERVICE, and ilUtil\sortArray().
ilObjectDefinition::getGroupOfObj | ( | $a_obj_name | ) |
Get Group of object type.
Definition at line 275 of file class.ilObjectDefinition.php.
Referenced by getExplorerContainerTypes().
ilObjectDefinition::getLocation | ( | $a_obj_name | ) |
get location by type
string | object type public |
Definition at line 259 of file class.ilObjectDefinition.php.
ilObjectDefinition::getLTIProviderTypes | ( | ) |
Get object types which offer lti provider support.
Definition at line 1052 of file class.ilObjectDefinition.php.
References $type.
ilObjectDefinition::getOrgUnitPermissionTypes | ( | ) |
Get object type with orgunit position permission support.
Definition at line 1037 of file class.ilObjectDefinition.php.
References $type.
Referenced by isOrgUnitPermissionType().
ilObjectDefinition::getPlugins | ( | ) |
Get plugin object info.
Definition at line 1092 of file class.ilObjectDefinition.php.
References $type, and isPlugin().
ilObjectDefinition::getPositionByType | ( | $a_type | ) |
Get Position By Object Type.
$a_type |
Definition at line 1079 of file class.ilObjectDefinition.php.
References $a_type, $ilSetting, and $settings.
|
static |
Get all repository object types of component.
Definition at line 854 of file class.ilObjectDefinition.php.
ilObjectDefinition::getSideBlockTypes | ( | bool | $filter_repository_types = true | ) |
bool | $filter_repository_types |
Definition at line 834 of file class.ilObjectDefinition.php.
References $type, isAllowedInRepository(), and isSideBlock().
ilObjectDefinition::getSubObjects | ( | $a_obj_type, | |
$a_filter = true |
|||
) |
get all subobjects by type
string | object type |
boolean | filter disabled objects? (default: true) public |
Definition at line 506 of file class.ilObjectDefinition.php.
References $data, $ilSetting, $settings, __filterObjects(), and ilUtil\sortArray().
Referenced by getCreatableSubObjects(), and getSubObjectsRecursively().
ilObjectDefinition::getSubObjectsAsString | ( | $a_obj_type | ) |
get a string of all subobjects by type
string | object type public |
Definition at line 698 of file class.ilObjectDefinition.php.
References $data.
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!
string | object type public |
Definition at line 552 of file class.ilObjectDefinition.php.
References $data, $ilSetting, $settings, $type, getDevMode(), getSubObjects(), isRBACObject(), and ilUtil\sortArray().
Referenced by getExplorerContainerTypes().
ilObjectDefinition::getSubobjectsToFilter | ( | $a_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 it not necessary to view/edit role permission for the usrf object since it's not possible to create a new one
string | object type public |
Definition at line 629 of file class.ilObjectDefinition.php.
References $key.
ilObjectDefinition::getTranslationType | ( | $a_obj_name | ) |
get translation type (sys, db or 0)s
string | object type public |
Definition at line 297 of file class.ilObjectDefinition.php.
References $DIC, $ilDB, and ilDBConstants\FETCHMODE_ASSOC.
ilObjectDefinition::handlerBeginTag | ( | $a_xml_parser, | |
$a_name, | |||
$a_attribs | |||
) |
start tag handler
ressouce | internal xml_parser_handler |
string | element tag name |
array | element attributes private |
Definition at line 750 of file class.ilObjectDefinition.php.
ilObjectDefinition::handlerCharacterData | ( | $a_xml_parser, | |
$a_data | |||
) |
end tag handler
ressouce | internal xml_parser_handler |
string | data private |
Definition at line 773 of file class.ilObjectDefinition.php.
ilObjectDefinition::handlerEndTag | ( | $a_xml_parser, | |
$a_name | |||
) |
end tag handler
ressouce | internal xml_parser_handler |
string | element tag name private |
Definition at line 784 of file class.ilObjectDefinition.php.
ilObjectDefinition::hasCheckbox | ( | $a_obj_name | ) |
should the object get a checkbox (needed for 'cut','copy' ...)
string | object type public |
Definition at line 286 of file class.ilObjectDefinition.php.
ilObjectDefinition::hasLocalRoles | ( | $a_obj_type | ) |
Check whether the creation of local roles is allowed Currently disabled for type "root" and "adm".
Definition at line 487 of file class.ilObjectDefinition.php.
ilObjectDefinition::isActivePluginType | ( | $type | ) |
Returns true iff the given type is an active type of a repositoryObject or Organisation Unit Extension plugin.
$type |
Definition at line 407 of file class.ilObjectDefinition.php.
References $plugin_admin, $type, IL_COMP_MODULE, IL_COMP_SERVICE, and ilPlugin\lookupNameForId().
ilObjectDefinition::isAdministrationObject | ( | $a_obj_name | ) |
Check if administration object.
string | $a_obj_name |
Definition at line 988 of file class.ilObjectDefinition.php.
Referenced by getAllRepositoryTypes(), and getCreatableSubObjects().
ilObjectDefinition::isAllowedInRepository | ( | $a_obj_name | ) |
checks if object type can be used in repository context
string | object type public |
Definition at line 945 of file class.ilObjectDefinition.php.
Referenced by getAllRepositoryTypes(), getCreatableSubObjects(), and getSideBlockTypes().
ilObjectDefinition::isAllowedInWorkspace | ( | $a_obj_name | ) |
checks if object type can be used in workspace context
string | object type public |
Definition at line 978 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects().
ilObjectDefinition::isContainer | ( | $a_obj_name | ) |
Check if object type is container ('crs','fold','grp' ...)
public
string | object type |
Definition at line 719 of file class.ilObjectDefinition.php.
Referenced by getExplorerContainerTypes().
ilObjectDefinition::isInactivePlugin | ( | $a_type | ) |
Check whether type belongs to inactive plugin.
Definition at line 999 of file class.ilObjectDefinition.php.
References $a_type, and isPlugin().
ilObjectDefinition::isOrgUnitPermissionType | ( | $a_obj_type | ) |
Check if object type offers orgunit position support.
string | $obj_type |
Definition at line 1068 of file class.ilObjectDefinition.php.
References getOrgUnitPermissionTypes().
ilObjectDefinition::isPlugin | ( | $a_obj_name | ) |
get RBAC status by type returns true if object type is an (activated) plugin type
string | object type public |
Definition at line 386 of file class.ilObjectDefinition.php.
Referenced by getPlugins(), and isInactivePlugin().
ilObjectDefinition::isPluginTypeName | ( | $a_str | ) |
Check if given type is a plugin type name (starts with an "x")
string | object type public |
Definition at line 397 of file class.ilObjectDefinition.php.
ilObjectDefinition::isRBACObject | ( | $a_obj_name | ) |
get RBAC status by type returns true if object type is a RBAC object type
string | object type public |
Definition at line 374 of file class.ilObjectDefinition.php.
Referenced by getAllRBACObjects(), and getSubObjectsRecursively().
ilObjectDefinition::isSideBlock | ( | $a_obj_name | ) |
Check, whether object type is a side block.
string | object type |
Definition at line 825 of file class.ilObjectDefinition.php.
Referenced by getSideBlockTypes().
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
string | object type public |
Definition at line 814 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects().
|
protected |
loads a single plugin definition into the object definition
$component | The component e.g. IL_COMP_SERVICE |
$slotName | The Slot name, e.g. Repository |
$slotId | the slot id, e.g. robj |
$isInAdministration,can | the object be created in the administration? |
Definition at line 1182 of file class.ilObjectDefinition.php.
References $plugin_admin, ilPlugin\_getDirectory(), ilObjectPlugin\getPluginObjectByType(), and ilPlugin\lookupIdForName().
Referenced by readPluginData().
ilObjectDefinition::readDefinitionData | ( | ) |
Read object definition data.
Definition at line 201 of file class.ilObjectDefinition.php.
References ilGlobalCache\COMP_COMPONENT, ilGlobalCache\getInstance(), readDefinitionDataFromCache(), and readDefinitionDataFromDB().
Referenced by __construct().
|
protected |
Definition at line 68 of file class.ilObjectDefinition.php.
References ilCachedComponentData\getInstance(), and readPluginData().
Referenced by readDefinitionData().
|
protected |
Definition at line 125 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 1169 of file class.ilObjectDefinition.php.
References IL_COMP_MODULE, IL_COMP_SERVICE, and parsePluginData().
Referenced by readDefinitionDataFromCache(), and readDefinitionDataFromDB().
ilObjectDefinition::setHandlers | ( | $a_xml_parser | ) |
set event handler
ressouce | internal xml_parser_handler private |
Definition at line 735 of file class.ilObjectDefinition.php.
ilObjectDefinition::stopInheritance | ( | $a_obj_name | ) |
Does object permits stopping inheritance?
string | object type public |
Definition at line 332 of file class.ilObjectDefinition.php.
ilObjectDefinition::supportsOfflineHandling | ( | $a_obj_type | ) |
check whether obj_type supports centralised offline handling
$a_obj_type |
Definition at line 1156 of file class.ilObjectDefinition.php.
ilObjectDefinition::$obj_data |
Definition at line 47 of file class.ilObjectDefinition.php.
ilObjectDefinition::$obj_id |
Definition at line 33 of file class.ilObjectDefinition.php.
ilObjectDefinition::$parent |
Definition at line 40 of file class.ilObjectDefinition.php.
|
protected |
Definition at line 20 of file class.ilObjectDefinition.php.
Referenced by isActivePluginType(), and parsePluginData().
|
protected |
Definition at line 25 of file class.ilObjectDefinition.php.
Referenced by getPositionByType(), getSubObjects(), and getSubObjectsRecursively().
ilObjectDefinition::$sub_types = array() |
Definition at line 49 of file class.ilObjectDefinition.php.
Referenced by getAdvancedMetaDataTypes(), and getCreatableSubObjects().
const ilObjectDefinition::MODE_ADMINISTRATION = 3 |
Definition at line 53 of file class.ilObjectDefinition.php.
Referenced by ilObjOrgUnitGUI\showPossibleSubObjects().
const ilObjectDefinition::MODE_REPOSITORY = 1 |
Definition at line 51 of file class.ilObjectDefinition.php.
Referenced by ilObjectAddNewItemGUI\__construct(), ilTrQuery\getObjectTypeStatistics(), and ilObjectGUI\showPossibleSubObjects().
const ilObjectDefinition::MODE_WORKSPACE = 2 |
Definition at line 52 of file class.ilObjectDefinition.php.
Referenced by ilObjectAddNewItemGUI\getHTML(), ilObjectAddNewItemGUI\parsePersonalWorkspace(), ilObjWorkspaceFolderGUI\render(), and ilObjectAddNewItemGUI\render().