CourseGroupFolder Class Reference

Inheritance diagram for CourseGroupFolder:

Public Member Functions
	checkPermission ($user_id)
	isVisible ($user_id)
	isReadable ($user_id)
	isWritable ($user_id)
	isSubfolderAllowed ($user_id)
	getIcon ($role=Icon::DEFAULT_ROLE)
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	getDescriptionTemplate ()
Public Member Functions inherited from StandardFolder
	__construct ($folderdata=null)
	getIcon ($role=Icon::DEFAULT_ROLE)
	getId ()
	__get ($attribute)
	__set ($name, $value)
	isVisible ($user_id)
	isReadable ($user_id)
	isWritable ($user_id)
	isEditable ($user_id)
	isSubfolderAllowed ($user_id)
	getDescriptionTemplate ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	store ()
	validateUpload (FileType $newfile, $user_id)
	getSubfolders ()
	getFiles ()
	getParent ()
	addFile (FileType $file, $user_id=null)
	deleteFile ($file_ref_id)
	createSubfolder (FolderType $foldertype)
	deleteSubfolder ($subfolder_id)
	delete ()
	isFileDownloadable ($fileref_or_id, $user_id)
	isFileEditable ($fileref_or_id, $user_id)
	isFileWritable ($fileref_or_id, $user_id)
	getRangeObject ()
	getAdditionalColumns ()
	getContentForAdditionalColumn ($column_index)
	getAdditionalColumnOrderWeigh ($column_index)
	getAdditionalActionButtons ()
	copySettings ()

Static Public Member Functions
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)
Static Public Member Functions inherited from StandardFolder
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)

Static Public Attributes
static	$sorter = 4
Static Public Attributes inherited from StandardFolder
static	$sorter = 0

Protected Attributes
	$group_id
	$must_have_perm = "tutor"
Protected Attributes inherited from StandardFolder
	$folderdata

Additional Inherited Members
Protected Member Functions inherited from StandardFolder
	isVisibleNonRecursive ($user_id)
	getValidationMessages ($upload_type, $newfile)

Member Function Documentation

availableInRange()

static availableInRange (   $range_id_or_object,   $user_id  )

static

This method tells if the FolderType implementation can be created in a specific range type.

Some FolderType implementations aren't useful in conjunction with a specific range type. An FolderType implementation therefore must provide this method so that other parts of the file area system can easily check if folders of the FolderType implementation can be placed inside standard folders.

Parameters

string | Object	$range_id_or_object	id or object of type "course", "user", "institute", "message"
string	$user_id

Returns

boolean True, if creatable, false otherwise.

Implements FolderType.

checkPermission()

checkPermission

(

$user_id

)

This method check the permission (global and if he is in the group) for a given user

Parameters

string

$user_id

The User-ID

Returns

bool True if user have permission, False otherwise

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns the description template for a instance of a GroupFolder type

Returns

mixed A description template for a instance of the type GroupFolder

Implements FolderType.

getEditTemplate()

getEditTemplate

(

)

This method returns the special part for the edit template for the folder type GroupFolder

Returns

mixed A edit template for a instance of the type GroupFolder

Implements FolderType.

getIcon()

getIcon

(

$role = Icon::DEFAULT_ROLE

)

This function returns the suitable Icon for this folder type (GroupFolder)

Returns

Icon The icon object for this folder type

Implements FolderType.

getTypeName()

static getTypeName ( )

static

Returns the name of the GroupFolder type.

Returns

string the name of the GroupFolder type

Implements FolderType.

isReadable()

isReadable

(

$user_id

)

Check if this GroupFolder instance is readable for this user or not.

Parameters

string

$user_id

The User-ID

Returns

bool True, if the user is in this group or is the lecturer, false otherwise

Implements FolderType.

isSubfolderAllowed()

isSubfolderAllowed

(

$user_id

)

Check if a Subfolder can be created.

Returns

bool True, if the user is in this group or is the lecturer, false otherwise

Implements FolderType.

isVisible()

isVisible

(

$user_id

)

Check if this GroupFolder instance is visible for this user or not.

Parameters

string

$user_id

The User-ID

Returns

bool True, if the user is in this group or is the lecturer, false otherwise

Implements FolderType.

isWritable()

isWritable

(

$user_id

)

Check if this GroupFolder instance is writable for this user or not.

Parameters

string

$user_id

The User-ID

Returns

bool True, if the user is in this group or is the lecturer, false otherwise

Implements FolderType.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Stores the data which was edited in the edit template

Returns

mixed The template with the edited data

Implements FolderType.

Field Documentation

$group_id

$group_id

protected

$must_have_perm

$must_have_perm = "tutor"

protected

$sorter

$sorter = 4

static

---

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

• lib/filesystem/CourseGroupFolder.php