ilOrgUnitExtension Class Reference

Class ilOrgUnitExtension. More...

Inheritance diagram for ilOrgUnitExtension:

Collaboration diagram for ilOrgUnitExtension:

Public Member Functions
	__construct ($a_ref_id=0)
	ilOrgUnitExtension constructor. More...
	getEmployees ($recursively=false)
	Get all user ids of employees of the underlying OrgUnit. More...
	getSuperiors ($recursively=false)
	Get all user ids of superiors of the underlying OrgUnit. More...
	getOrgUnit ()
	getOrgUnitPathRefIds ()
	getOrgUnitPath ()
	getOrgUnitPathTitles ()
	getOrgUnitSubtree ($with_data=true, $type="")
Public Member Functions inherited from ilObjectPlugin
	__construct ($a_ref_id=0)
	Constructor. More...
	getParentTypes ()
	returns a list of all repository object types which can be a parent of this type. More...
Public Member Functions inherited from ilObject2
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	read ()
	Read data from db. More...
	getId ()
	setId ($a_id)
	setRefId ($a_id)
	getRefId ()
	getType ()
	setType ($a_type)
	getPresentationTitle ()
	getTitle ()
	getUntranslatedTitle ()
	setTitle ($a_title)
	getDescription ()
	setDescription ($a_desc)
	getLongDescription ()
	getImportId ()
	setImportId ($a_import_id)
	getOwner ()
	getOwnerName ()
	setOwner ($a_owner)
	getCreateDate ()
	getLastUpdateDate ()
	create ($a_clone_mode=false)
	update ()
	MDUpdateListener ($a_element)
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	putInTree ($a_parent_ref)
	setPermissions ($a_parent_ref)
	createReference ()
	countReferences ()
	delete ()
	initDefaultRoles ()
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	cloneMetaData ($target_obj)
	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	cloneDependencies ($a_target_id, $a_copy_id)
Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ()
	read object data from db into object More...
	getId ()
	get object id public More...
	setId ($a_id)
	set object id public More...
	setRefId ($a_id)
	set reference id public More...
	getRefId ()
	get reference id public More...
	getType ()
	get object type public More...
	setType ($a_type)
	set object type public More...
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	get object title public More...
	getUntranslatedTitle ()
	get untranslated object title public More...
	setTitle ($a_title)
	set object title More...
	getDescription ()
	get object description More...
	setDescription ($a_desc)
	set object description More...
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	get import id More...
	setImportId ($a_import_id)
	set import id More...
	setOfflineStatus ($a_status)
	Set offline status. More...
	getOfflineStatus ()
	Get offline status. More...
	supportsOfflineHandling ()
	Check whether object supports offline handling. More...
	getOwner ()
	get object owner More...
	getOwnerName ()
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Protected Member Functions
	getPlugin ()
Protected Member Functions inherited from ilObjectPlugin
	getPlugin ()
	Get plugin object. More...
	txt ($a_var)
	Wrapper for txt function. More...
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate ()
	beforeCreate ()
	doUpdate ()
	beforeUpdate ()
	doMDUpdateListener ($a_element)
	beforeMDUpdateListener ($a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDelete ()
	beforeDelete ()
	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
	beforeCloneObject ()

Protected Attributes
	$ilObjOrgUnitTree
	$parent_ref_id
	$tree
Protected Attributes inherited from ilObjectPlugin
	$plugin
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Additional Inherited Members
Static Public Member Functions inherited from ilObjectPlugin
static	getPluginObjectByType ($type)
	Return either a repoObject plugin or a orgunit extension plugin or null if the type is not a plugin. More...
static	lookupTxtById ($plugin_id, $lang_var)
Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupOwnerName ($a_owner_id)
static	_getIdForImportId ($a_import_id)
static	_getAllReferences ($a_id)
static	_lookupTitle ($a_id)
static	_lookupOwner ($a_id)
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
static	_lookupLastUpdate ($a_id, $a_as_string=false)
static	_getLastUpdateOfObjects ($a_objs)
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
static	_resetDeletedDate ($a_ref_id)
static	_lookupDeletedDate ($a_ref_id)
static	_writeTitle ($a_obj_id, $a_title)
static	_writeDescription ($a_obj_id, $a_desc)
static	_writeImportId ($a_obj_id, $a_import_id)
static	_lookupType ($a_id, $a_reference=false)
static	_isInTrash ($a_ref_id)
static	_hasUntrashedReference ($a_obj_id)
static	_lookupObjectId ($a_ref_id)
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
static	_exists ($a_id, $a_reference=false, $a_type=null)
static	_getObjectsByType ($a_obj_type="", $a_owner="")
static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	lookupOfflineStatus ($a_obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner ($a_id)
	lookup object owner More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
static	_lookupObjId ($a_id)
static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...
static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...
static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate ($a_id)
	Lookup creation date. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
Static Protected Member Functions inherited from ilObjectPlugin
static	loadRepoPlugin (string $type_id)
static	loadOrgUnitPlugin (string $type_id)
Static Protected Attributes inherited from ilObjectPlugin
static	$plugin_by_type = array()

Detailed Description

Class ilOrgUnitExtension.

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilOrgUnitExtension.php.

Constructor & Destructor Documentation

__construct()

ilOrgUnitExtension::__construct

(

$a_ref_id = 0

)

ilOrgUnitExtension constructor.

Parameters

int

$a_ref_id

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

References $_GET, $DIC, $list, ilObjectPlugin\$plugin, $tree, ilObjOrgUnitTree\_getInstance(), ilPlugin\getActivePluginIdsForSlot(), ilObjectPlugin\getPluginObjectByType(), and IL_COMP_MODULE.

    {
        global $DIC;
        $tree = $DIC['tree'];

        parent::__construct($a_ref_id);
        $this->ilObjOrgUnitTree = ilObjOrgUnitTree::_getInstance();
        $this->parent_ref_id = $tree->getParentId($a_ref_id ? $a_ref_id : $_GET['ref_id']);
        $this->tree = $tree;
    }

Here is the call graph for this function:

Member Function Documentation

getEmployees()

ilOrgUnitExtension::getEmployees

(

$recursively = false

)

Get all user ids of employees of the underlying OrgUnit.

Parameters

bool

$recursively

include all employees in the suborgunits

Returns

int[]

Definition at line 89 of file class.ilOrgUnitExtension.php.

References ilObjOrgUnitTree\getEmployees().

    {
        return $this->ilObjOrgUnitTree->getEmployees($this->parent_ref_id, $recursively);
    }

Here is the call graph for this function:

getOrgUnit()

ilOrgUnitExtension::getOrgUnit

(

)

Returns

ilObjOrgUnit

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

References ilObjectFactory\getInstanceByRefId().

    {
        return ilObjectFactory::getInstanceByRefId($this->parent_ref_id);
    }

Here is the call graph for this function:

getOrgUnitPath()

ilOrgUnitExtension::getOrgUnitPath

(

)

Returns

array Returns the path to the underlying OrgUnit starting with the root OrgUnit. The array are nodes of the global $tree.

Definition at line 131 of file class.ilOrgUnitExtension.php.

References ilObjOrgUnit\getRootOrgRefId().

Referenced by getOrgUnitPathRefIds(), and getOrgUnitPathTitles().

    {
        return $this->tree->getPathFull($this->parent_ref_id, ilObjOrgUnit::getRootOrgRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOrgUnitPathRefIds()

ilOrgUnitExtension::getOrgUnitPathRefIds

(

)

Returns

int[] RefIds from the root OrgUnit to the underlying OrgUnit

Definition at line 118 of file class.ilOrgUnitExtension.php.

References $path, and getOrgUnitPath().

    {
        $path = array();
        foreach ($this->getOrgUnitPath() as $node) {
            $path[] = $node['child'];
        }
        return $path;
    }

Here is the call graph for this function:

getOrgUnitPathTitles()

ilOrgUnitExtension::getOrgUnitPathTitles

(

)

Returns

string[] Returns the titles to the underlying OrgUnit starting with the root OrgUnit.

Definition at line 139 of file class.ilOrgUnitExtension.php.

References getOrgUnitPath().

    {
        $titles = array();
        foreach ($this->getOrgUnitPath() as $node) {
            if ($node["title"] == "__OrgUnitAdministration") {
                $node["title"] = $this->lng->txt("objs_orgu");
            }
            $titles[] = $node['title'];
        }
        return $titles;
    }

Here is the call graph for this function:

getOrgUnitSubtree()

ilOrgUnitExtension::getOrgUnitSubtree	(		$with_data = true,
			$type = ""
	)

Parameters

bool	$with_data	if this is set to true, only the ids are delivered
string	$type	what type are you looking for?

Returns

array

Definition at line 156 of file class.ilOrgUnitExtension.php.

References ilObject\$type.

    {
        $node = $this->tree->getNodeData($this->parent_ref_id);
        return $this->tree->getSubTree($node, $with_data, $type);
    }

getPlugin()

ilOrgUnitExtension::getPlugin ( )

protected

Returns

ilOrgUnitExtensionPlugin

Exceptions

ilPluginException

Definition at line 70 of file class.ilOrgUnitExtension.php.

References ilObjectPlugin\$plugin, ilPlugin\getPluginObject(), ilObject2\getType(), IL_COMP_MODULE, and ilPlugin\lookupNameForId().

    {
        if (!$this->plugin) {
            $this->plugin = ilPlugin::getPluginObject(IL_COMP_MODULE, "OrgUnit", "orguext", ilPlugin::lookupNameForId(IL_COMP_MODULE, "OrgUnit", "orguext", $this->getType()));
            if (!$this->plugin instanceof ilOrgUnitExtensionPlugin) {
                throw new ilPluginException("ilOrgUnitExtension: Could not instantiate plugin object for type " . $this->getType() . ".");
            }
        }

        return $this->plugin;
    }

Here is the call graph for this function:

getSuperiors()

ilOrgUnitExtension::getSuperiors

(

$recursively = false

)

Get all user ids of superiors of the underlying OrgUnit.

Parameters

bool

$recursively

Returns

int[]

Definition at line 101 of file class.ilOrgUnitExtension.php.

References ilObjOrgUnitTree\getSuperiors().

    {
        return $this->ilObjOrgUnitTree->getSuperiors($this->parent_ref_id, $recursively);
    }

Here is the call graph for this function:

Field Documentation

$ilObjOrgUnitTree

ilOrgUnitExtension::$ilObjOrgUnitTree

protected

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

$parent_ref_id

ilOrgUnitExtension::$parent_ref_id

protected

Definition at line 19 of file class.ilOrgUnitExtension.php.

$tree

ilOrgUnitExtension::$tree

protected

Definition at line 24 of file class.ilOrgUnitExtension.php.

Referenced by __construct().

---

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

• Modules/OrgUnit/classes/Extension/class.ilOrgUnitExtension.php