StudipDocumentTree Class Reference

Inheritance diagram for StudipDocumentTree:

Collaboration diagram for StudipDocumentTree:

Public Member Functions
	ExistsGroupFolders ($seminar_id)
	StudipDocumentTree ($args)
	init ()
	initSubfolders ($parent_id)
	getPermissionString ($folder_id)
	checkPermission ($folder_id, $perm, $user_id=null)
	checkGroupFolder ($folder_id, $user_id)
	setPermission ($folder_id, $perm)
	unsetPermission ($folder_id, $perm)
	setDefaultPermission ($folder_id)
	isWritable ($folder_id, $user_id=null)
	isReadable ($folder_id, $user_id=null)
	isExecutable ($folder_id, $user_id=null)
	checkCreateFolder ($folder_id, $user_id=null)
	isGroupFolder ($folder_id)
	getNextSuperFolder ($folder_id)
	getRootFolder ($folder_id)
	isLockedFolder ($folder_id, $user_id=null)
	isExerciseFolder ($folder_id, $user_id=null)
	isDownloadFolder ($folder_id, $user_id=null)
	getReadableFolders ($user_id)
	getUnreadableFolders ($user_id, $ignore_groups=false)
	getReadableKidsKids ($item_id, $user_id, $in_recursion=false)
	isFolder ($item_id)
	getGroupFolders ()
Public Member Functions inherited from TreeAbstract
	TreeAbstract ()
	init ()
	storeItem ($item_id, $parent_id, $name, $priority)
	buildIndex ($item_id=false)
	getKids ($item_id)
	getNumKids ($item_id)
	getKidsKids ($item_id, $in_recursion=false)
	getNumKidsKids ($item_id, $in_recursion=false)
	isLastKid ($item_id)
	isFirstKid ($item_id)
	isChildOf ($ancestor_id, $item_id)
	hasKids ($item_id)
	getItemPath ($item_id)
	getParents ($item_id)
	getShortPath ($item_id, $length=null, $delimeter=">", $offset=0)
	getMaxPriority ($parent_id)
	getNumEntries ($item_id, $num_entries_from_kids=false)
	getNumEntriesKids ($item_id, $in_recursion=false)
	getValue ($item_id, $field)

Data Fields
	$range_id
	$entity_type
	$must_have_perm
	$perms = array('x' => 1, 'w' => 2, 'r' => 4, 'f' => 8)
	$default_perm = 7
	$permissions_activated = false
	$group_folders = array()
Data Fields inherited from TreeAbstract
	$root_name
	$view
	$tree_data = array()
	$tree_childs = array()
	$tree_num_childs = array()
	$index_offset = 0

Additional Inherited Members
Static Public Member Functions inherited from TreeAbstract
	GetInstance ($class_name, $args=null, $invalidate_cache=false)

Member Function Documentation

checkCreateFolder()

checkCreateFolder	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

checkGroupFolder()

checkGroupFolder	(		$folder_id,
			$user_id
	)

Here is the call graph for this function:

Here is the caller graph for this function:

checkPermission()

checkPermission	(		$folder_id,
			$perm,
			$user_id = null
	)

Here is the call graph for this function:

Here is the caller graph for this function:

ExistsGroupFolders()

ExistsGroupFolders

(

$seminar_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupFolders()

getGroupFolders

(

)

getNextSuperFolder()

getNextSuperFolder

(

$folder_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

getPermissionString()

getPermissionString

(

$folder_id

)

Here is the call graph for this function:

getReadableFolders()

getReadableFolders

(

$user_id

)

Here is the call graph for this function:

getReadableKidsKids()

getReadableKidsKids	(		$item_id,
			$user_id,
			$in_recursion = false
	)

Here is the call graph for this function:

Here is the caller graph for this function:

getRootFolder()

getRootFolder

(

$folder_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

getUnreadableFolders()

getUnreadableFolders	(		$user_id,
			$ignore_groups = false
	)

Here is the call graph for this function:

init()

init

(

)

initializes the tree

stores all folders in array $tree_data @access public

Reimplemented from TreeAbstract.

Here is the call graph for this function:

initSubfolders()

initSubfolders

(

$parent_id

)

Here is the call graph for this function:

Here is the caller graph for this function:

isDownloadFolder()

isDownloadFolder	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

isExecutable()

isExecutable	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

Here is the caller graph for this function:

isExerciseFolder()

isExerciseFolder	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

isFolder()

isFolder

(

$item_id

)

isGroupFolder()

isGroupFolder

(

$folder_id

)

Here is the caller graph for this function:

isLockedFolder()

isLockedFolder	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

isReadable()

isReadable	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

Here is the caller graph for this function:

isWritable()

isWritable	(		$folder_id,
			$user_id = null
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setDefaultPermission()

setDefaultPermission

(

$folder_id

)

Here is the call graph for this function:

setPermission()

setPermission	(		$folder_id,
			$perm
	)

Here is the caller graph for this function:

StudipDocumentTree()

StudipDocumentTree

(

$args

)

constructor

do not use directly, call TreeAbstract::GetInstance("StudipDocumentTree") @access private

Here is the call graph for this function:

unsetPermission()

unsetPermission	(		$folder_id,
			$perm
	)

Field Documentation

$default_perm

$default_perm = 7

$entity_type

$entity_type

$group_folders

$group_folders = array()

$must_have_perm

$must_have_perm

$permissions_activated

$permissions_activated = false

$perms

$perms = array('x' => 1, 'w' => 2, 'r' => 4, 'f' => 8)

$range_id

$range_id

---

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

• lib/classes/StudipDocumentTree.class.php