ILIAS
Release_4_0_x_branch Revision 61816
|
parses the objects.xml it handles the xml-description of all ilias objects More...
Public Member Functions | |
ilObjectDefinition () | |
Constructor. | |
readDefinitionData () | |
Read object definition data. | |
getClassName ($a_obj_name) | |
get class name by type | |
getLocation ($a_obj_name) | |
get location by type | |
getGroup ($a_id) | |
Get Group information. | |
getGroupOfObj ($a_obj_name) | |
Get Group of object type. | |
hasCheckbox ($a_obj_name) | |
should the object get a checkbox (needed for 'cut','copy' ...) | |
getTranslationType ($a_obj_name) | |
get translation type (sys, db or 0)s | |
stopInheritance ($a_obj_name) | |
Does object permits stopping inheritance? | |
getDevMode ($a_obj_name) | |
get devmode status by type | |
getDevModeAll () | |
get all object types in devmode | |
isRBACObject ($a_obj_name) | |
get RBAC status by type returns true if object type is a RBAC object type | |
isPlugin ($a_obj_name) | |
get RBAC status by type returns true if object type is a RBAC object type | |
getAllRBACObjects () | |
get all RBAC object types | |
getAllObjects () | |
get all object types | |
allowLink ($a_obj_name) | |
checks if linking of an object type is allowed | |
allowCopy ($a_obj_name) | |
checks if copying of an object type is allowed | |
getSubObjects ($a_obj_type, $a_filter=true) | |
get all subobjects by type | |
getSubObjectsRecursively ($a_obj_type) | |
Get all subobjects by type. | |
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. | |
getCreatableSubObjects ($a_obj_type) | |
get only creatable subobjects by type | |
getSubObjectsAsString ($a_obj_type) | |
get a string of all subobjects by type | |
isContainer ($a_obj_name) | |
Check if object type is container ('crs','fold','grp' ...) | |
setHandlers ($a_xml_parser) | |
set event handler | |
handlerBeginTag ($a_xml_parser, $a_name, $a_attribs) | |
start tag handler | |
handlerCharacterData ($a_xml_parser, $a_data) | |
end tag handler | |
handlerEndTag ($a_xml_parser, $a_name) | |
end tag handler | |
__filterObjects (&$subobjects) | |
isSystemObject ($a_obj_name) | |
checks if object type is a system object | |
isSideBlock ($a_obj_name) | |
Check, whether object type is a side block. | |
Public Member Functions inherited from ilSaxParser | |
ilSaxParser ($a_xml_file= '', $throwException=false) | |
Constructor setup ILIAS global object public. | |
setXMLContent ($a_xml_content) | |
getXMLContent () | |
getInputType () | |
startParsing () | |
stores xml data in array | |
createParser () | |
create parser | |
setOptions ($a_xml_parser) | |
set parser options | |
openXMLFile () | |
open xml file | |
parse ($a_xml_parser, $a_fp=null) | |
parse xml file | |
freeParser ($a_xml_parser) | |
free xml parser handle | |
setThrowException ($throwException) | |
set error handling | |
Public Member Functions inherited from PEAR | |
PEAR ($error_class=null) | |
Constructor. | |
_PEAR () | |
Destructor (the emulated type of...). | |
& | getStaticProperty ($class, $var) |
If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. | |
registerShutdownFunc ($func, $args=array()) | |
Use this function to register a shutdown method for static classes. | |
isError ($data, $code=null) | |
Tell whether a value is a PEAR error. | |
setErrorHandling ($mode=null, $options=null) | |
Sets how errors generated by this object should be handled. | |
expectError ($code= '*') | |
This method is used to tell which errors you expect to get. | |
popExpect () | |
This method pops one element off the expected error codes stack. | |
_checkDelExpect ($error_code) | |
This method checks unsets an error code if available. | |
delExpect ($error_code) | |
This method deletes all occurences of the specified element from the expected error codes stack. | |
& | raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false) |
This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. | |
& | throwError ($message=null, $code=null, $userinfo=null) |
Simpler form of raiseError with fewer options. | |
staticPushErrorHandling ($mode, $options=null) | |
staticPopErrorHandling () | |
pushErrorHandling ($mode, $options=null) | |
Push a new error handler on top of the error handler options stack. | |
popErrorHandling () | |
Pop the last error handler used. | |
loadExtension ($ext) | |
OS independant PHP extension load. |
Static Public Member Functions | |
static | getRepositoryObjectTypesForComponent ($a_component_type, $a_component_name) |
Get all repository object types of component. | |
static | getGroupedRepositoryObjectTypes ($a_parent_obj_type) |
Get grouped repository object types. |
Data Fields | |
$obj_id | |
$parent | |
$obj_data | |
Data Fields inherited from ilSaxParser | |
$input_type = null | |
$xml_content = '' | |
$ilias | |
$lng | |
$xml_file | |
$throwException = false | |
Data Fields inherited from PEAR | |
$_debug = false | |
$_default_error_mode = null | |
$_default_error_options = null | |
$_default_error_handler = '' | |
$_error_class = 'PEAR_Error' | |
$_expected_errors = array() |
Additional Inherited Members | |
Protected Member Functions inherited from ilSaxParser | |
handleError ($message, $code) | |
use given error handler to handle error message or internal ilias error message handle |
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 34 of file class.ilObjectDefinition.php.
ilObjectDefinition::__filterObjects | ( | & | $subobjects | ) |
Definition at line 659 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 397 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 386 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAllObjects | ( | ) |
get all object types
public
Definition at line 375 of file class.ilObjectDefinition.php.
ilObjectDefinition::getAllRBACObjects | ( | ) |
get all RBAC object types
public
Definition at line 354 of file class.ilObjectDefinition.php.
References $type, and isRBACObject().
ilObjectDefinition::getClassName | ( | $a_obj_name | ) |
get class name by type
string | object type public |
Definition at line 203 of file class.ilObjectDefinition.php.
ilObjectDefinition::getCreatableSubObjects | ( | $a_obj_type | ) |
get only creatable subobjects by type
string | object type public |
Definition at line 534 of file class.ilObjectDefinition.php.
References $type, getDevMode(), getSubObjects(), and isSystemObject().
ilObjectDefinition::getDevMode | ( | $a_obj_name | ) |
get devmode status by type
string | object type public |
Definition at line 298 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects(), and getDevModeAll().
ilObjectDefinition::getDevModeAll | ( | ) |
get all object types in devmode
public
Definition at line 309 of file class.ilObjectDefinition.php.
References $type, and getDevMode().
ilObjectDefinition::getGroup | ( | $a_id | ) |
Get Group information.
Definition at line 223 of file class.ilObjectDefinition.php.
|
static |
Get grouped repository object types.
Definition at line 740 of file class.ilObjectDefinition.php.
References $ilDB, $q, $ret, DB_FETCHMODE_ASSOC, IL_COMP_SERVICE, ilPlugin\lookupIdForName(), and ilUtil\sortArray().
ilObjectDefinition::getGroupOfObj | ( | $a_obj_name | ) |
Get Group of object type.
Definition at line 231 of file class.ilObjectDefinition.php.
ilObjectDefinition::getLocation | ( | $a_obj_name | ) |
get location by type
string | object type public |
Definition at line 215 of file class.ilObjectDefinition.php.
|
static |
Get all repository object types of component.
Definition at line 717 of file class.ilObjectDefinition.php.
References $ilDB.
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 410 of file class.ilObjectDefinition.php.
References $data, $ilSetting, __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 563 of file class.ilObjectDefinition.php.
References $data.
ilObjectDefinition::getSubObjectsRecursively | ( | $a_obj_type | ) |
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 462 of file class.ilObjectDefinition.php.
References $data, $type, and getSubObjects().
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
string | object type public |
Definition at line 506 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 253 of file class.ilObjectDefinition.php.
References $ilDB, $q, and DB_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 617 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 641 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 652 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 242 of file class.ilObjectDefinition.php.
ilObjectDefinition::ilObjectDefinition | ( | ) |
Constructor.
setup ILIAS global object public
Definition at line 64 of file class.ilObjectDefinition.php.
References ilSaxParser\$ilias, ILIAS_ABSOLUTE_PATH, ilSaxParser\ilSaxParser(), and readDefinitionData().
ilObjectDefinition::isContainer | ( | $a_obj_name | ) |
Check if object type is container ('crs','fold','grp' ...)
public
string | object type |
Definition at line 585 of file class.ilObjectDefinition.php.
ilObjectDefinition::isPlugin | ( | $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 343 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 331 of file class.ilObjectDefinition.php.
Referenced by getAllRBACObjects().
ilObjectDefinition::isSideBlock | ( | $a_obj_name | ) |
Check, whether object type is a side block.
string | object type |
Definition at line 709 of file class.ilObjectDefinition.php.
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 698 of file class.ilObjectDefinition.php.
Referenced by getCreatableSubObjects().
ilObjectDefinition::readDefinitionData | ( | ) |
Read object definition data.
Definition at line 95 of file class.ilObjectDefinition.php.
References $ilDB, ilPlugin\_getDirectory(), IL_COMP_SERVICE, and ilPlugin\lookupIdForName().
Referenced by ilObjectDefinition().
ilObjectDefinition::setHandlers | ( | $a_xml_parser | ) |
set event handler
ressouce | internal xml_parser_handler private |
Reimplemented from ilSaxParser.
Definition at line 602 of file class.ilObjectDefinition.php.
ilObjectDefinition::stopInheritance | ( | $a_obj_name | ) |
Does object permits stopping inheritance?
string | object type public |
Definition at line 287 of file class.ilObjectDefinition.php.
ilObjectDefinition::$obj_data |
Definition at line 56 of file class.ilObjectDefinition.php.
ilObjectDefinition::$obj_id |
Definition at line 42 of file class.ilObjectDefinition.php.
ilObjectDefinition::$parent |
Definition at line 49 of file class.ilObjectDefinition.php.