CoursePublicFolder Class Reference

Inheritance diagram for CoursePublicFolder:

Public Member Functions
	getIcon ($role=Icon::DEFAULT_ROLE)
	hasWorldwideAccess ()
	isVisible ($user_id)
	isReadable ($user_id)
	getDescriptionTemplate ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	isFileDownloadable ($file_id, $user_id)
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 $file, $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 = 7
Static Public Attributes inherited from StandardFolder
static	$sorter = 0

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

Member Function Documentation

availableInRange()

static availableInRange (   $range_id_or_object,   $user_id  )

static

Parameters

Object | string	$range_id_or_object
string	$user_id

Returns

bool

Implements FolderType.

getDescriptionTemplate()

getDescriptionTemplate

(

)

Returns a description template for CoursePublicFolders.

Returns

string A string describing this folder type.

Implements FolderType.

getEditTemplate()

getEditTemplate

(

)

Returns the edit template for this folder type.

Returns

Flexi

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.

getTypeName()

static getTypeName ( )

static

Returns a localised name of the CoursePublicFolder type.

Returns

string The localised name of this folder type.

Implements FolderType.

hasWorldwideAccess()

hasWorldwideAccess

(

)

Determines, if the folder is accessible worldwide.

Returns

bool True, if the folder is accessible worldwide, false otherwise.

isFileDownloadable()

isFileDownloadable	(		$file_id,
			$user_id
	)

Files in CoursePublicFolders are downloadable for all logged in users.

Parameters

string	$file_id	The ID to a FileRef.
string	$user_id	The user who wishes to downlaod the file.

Returns

bool

Implements FolderType.

isReadable()

isReadable

(

$user_id

)

CoursePublicFolders are readable for all logged in users.

Parameters

string

$user_id

The user who wishes to read the folder.

Returns

bool True

Implements FolderType.

isVisible()

isVisible

(

$user_id

)

CoursePublicFolders are visible for all logged in users. If ENABLE_FREE_ACCESS is set to 'courses_only' or '1', the folder is visible for everyone. In case, the worldwide access option for the folder is set, the folder is visible worldwide.

Parameters

string

$user_id

The user who wishes to see the folder.

Returns

bool True

Implements FolderType.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

Sets the data from a submitted edit template.

Parameters

array

$request

The data from the edit template.

Returns

FolderType

Implements FolderType.

Field Documentation

$sorter

$sorter = 7

static

---

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

• lib/filesystem/CoursePublicFolder.php