CourseTopicFolder Class Reference

Inheritance diagram for CourseTopicFolder:

Collaboration diagram for CourseTopicFolder:

Public Member Functions
	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 ($uploadedfile, $user_id)
	getSubfolders ()
	getFiles ()
	getParent ()
	createFile ($file)
	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 ()
	getIcon ($role)
	getId ()
	isVisible ($user_id)
	isReadable ($user_id)
	isWritable ($user_id)
	isEditable ($user_id)
	isSubfolderAllowed ($user_id)
	getDescriptionTemplate ()
	getSubfolders ()
	getFiles ()
	getParent ()
	getEditTemplate ()
	setDataFromEditTemplate ($folderdata)
	validateUpload ($file, $user_id)
	createFile ($file)
	deleteFile ($file_ref_id)
	createSubfolder (FolderType $foldertype)
	deleteSubfolder ($subfolder_id)
	delete ()
	store ()
	isFileDownloadable ($file_ref_id, $user_id)
	isFileEditable ($file_ref_id, $user_id)
	isFileWritable ($file_ref_id, $user_id)

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

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

Additional Inherited Members
Protected Attributes inherited from StandardFolder
	$folderdata

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.

Here is the call graph for this function:

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.

Here is the call graph for this function:

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

)

Returns the name of the icon shape that shall be used with the FolderType implementation.

Parameters

string

$role

role of icon

Returns

Icon icon for the FolderType implementation.

Implements FolderType.

Here is the call graph for this function:

getTypeName()

static getTypeName ( )

static

Returns a human-friendly representation of the FolderType's name.

Returns

string A human-friendly name for the FolderType implementation.

Implements FolderType.

Here is the caller graph for this function:

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Stores the data which was edited in the edit template

Returns

mixed The template with the edited data

Implements FolderType.

Here is the call graph for this function:

Field Documentation

$sorter

$sorter = 1

static

---

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

• lib/filesystem/CourseTopicFolder.php