PublicFolder Class Reference

Inheritance diagram for PublicFolder:

Public Member Functions
	__construct ($folder=null)
	__get ($attribute)
	getIcon ($role=Icon::DEFAULT_ROLE)
	getId ()
	isVisible ($userId)
	isReadable ($userId)
	isWritable ($userId)
	isEditable ($userId)
	isSubfolderAllowed ($userId)
	getDescriptionTemplate ()
	getSubfolders ()
	getParent ()
	getEditTemplate ()
	setDataFromEditTemplate ($request)
	deleteFile ($fileRefId)
	store ()
	createSubfolder (FolderType $folderdata)
	deleteSubfolder ($subfolderId)
	delete ()
	isFileDownloadable ($fileRefId, $userId)
	isFileEditable ($fileRefId, $userId)
	isFileWritable ($fileRefId, $userId)
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	findOrCreateTopFolder (Instance $instance)
static	findTopFolder (Instance $instance)
static	createTopFolder (Instance $instance)
static	getTypeName ()
static	availableInRange ($rangeIdOrObject, $userId)
Static Public Member Functions inherited from StandardFolder
static	getTypeName ()
static	availableInRange ($range_id_or_object, $user_id)

Protected Attributes
	$folder
Protected Attributes inherited from StandardFolder
	$folderdata

Additional Inherited Members
Static Public Attributes inherited from StandardFolder
static	$sorter = 0
Protected Member Functions inherited from StandardFolder
	isVisibleNonRecursive ($user_id)
	getValidationMessages ($upload_type, $newfile)

Constructor & Destructor Documentation

__construct()

__construct

(

$folder = null

)

{}

Member Function Documentation

__get()

__get

(

$attribute

)

{}

availableInRange()

static availableInRange (   $rangeIdOrObject,   $userId  )

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.

createSubfolder()

createSubfolder

(

FolderType

$folderdata

)

{

Parameters

$foldertype

FolderType

Returns

FolderType|null A FolderType instance representing the created subfolder or null on failure.

}

Implements FolderType.

createTopFolder()

static createTopFolder ( Instance  $instance )

static

delete()

delete

(

)

{Deletes this folder.

Returns

bool True on success, False on failure.

}

Implements FolderType.

deleteFile()

deleteFile

(

$fileRefId

)

{Deletes a file in this folder.

Parameters

string

$file_ref_id

The ID of the FileRef object of the file that shall be deleted.

Returns

bool True on success, False on failure.

}

Implements FolderType.

deleteSubfolder()

deleteSubfolder

(

$subfolderId

)

{Deletes a subfolder in this folder.

Parameters

string

$subfolder_id

The ID of the subfolder that shall be deleted.

Returns

bool True on success, False on failure.

}

Implements FolderType.

findOrCreateTopFolder()

static findOrCreateTopFolder ( Instance  $instance )

static

findTopFolder()

static findTopFolder ( Instance  $instance )

static

getDescriptionTemplate()

getDescriptionTemplate

(

)

{returns description of the folder

Returns

Flexi | string

}

Implements FolderType.

getEditTemplate()

getEditTemplate

(

)

{returns template form, must not contain opening and closing <form> tags

Returns

Flexi | string

}

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.

getId()

getId

(

)

{Returns the ID of the folder that is managed from this FolderType instance.

Returns

string ID of the folder.

}

Implements FolderType.

getParent()

getParent

(

)

{Returns the FolderType of the parent folder or null if this is the top folder.

Returns

null|FolderType

}

Implements FolderType.

getSubfolders()

getSubfolders

(

)

{Returns a list of subfolders of this folder.

Returns

FolderType[] List of folder objects

}

Implements FolderType.

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.

isEditable()

isEditable

(

$userId

)

{Determines if a user may have edit permissions for the folder.

Parameters

string

$user_id

The user who wishes to edit the folder.

Returns

boolean True, if the user is permitted to edit the folder, false otherwise.

}

Implements FolderType.

isFileDownloadable()

isFileDownloadable	(		$fileRefId,
			$userId
	)

{Determines if a user may download the file.

Parameters

string	$file_ref_id	The ID of the FileRef object of a file that shall be downloaded.
string	$user_id	The user who wishes to download the file.

Returns

boolean True, if the user is permitted to download the file, false otherwise.

}

Implements FolderType.

isFileEditable()

isFileEditable	(		$fileRefId,
			$userId
	)

{Determines if a user may edit the file.

Parameters

string	$file_ref_id	The ID of the FileRef object of a file that shall be edited.
string	$user_id	The user who wishes to edit the file.

Returns

boolean True, if the user is permitted to edit the file, false otherwise.

}

Implements FolderType.

isFileWritable()

isFileWritable	(		$fileRefId,
			$userId
	)

{Determines if a user may write to the file.

Parameters

string	$file_id	The FileRef object of a file that shall be written.
string	$user_id	The user who wishes to write to the file.

Returns

boolean True, if the user is permitted to write to the file, false otherwise.

}

Implements FolderType.

isReadable()

isReadable

(

$userId

)

{Determines if a user may read the content of the folder.

Parameters

string

$user_id

The user who wishes to read the folder's content.

Returns

boolean True, if the user is permitted to read the folder, false otherwise.

}

Implements FolderType.

isSubfolderAllowed()

isSubfolderAllowed

(

$userId

)

{Determines if a user may create a subfolder in this folder.

Parameters

string

$user_id

The user who wishes to create a subfolder.

Returns

boolean True, if the user is permitted to create a subfolder, false otherwise.

}

Implements FolderType.

isVisible()

isVisible

(

$userId

)

{Determines if a user may see the folder.

Parameters

$user_id

Returns

boolean

}

Implements FolderType.

isWritable()

isWritable

(

$userId

)

{Determines if a user may have write permissions for the folder.

Parameters

string

$user_id

The user who wishes to write into the folder.

Returns

boolean True, if the user is permitted to write into the folder, false otherwise.

}

Implements FolderType.

setDataFromEditTemplate()

setDataFromEditTemplate

(

$request

)

{gets data from edit form

Parameters

ArrayAccess | Request

$folderdata

Returns

FolderType|MessageBox FolderType instance on success, a MessageBox object with an error message on failure.

}

Implements FolderType.

store()

store

(

)

{

Returns

bool

}

Implements FolderType.

Field Documentation

$folder

$folder

protected

---

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

• lib/models/Courseware/Filesystem/PublicFolder.php