Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
PublicFolder Class Reference
Inheritance diagram for PublicFolder:
StandardFolder FolderType

Public Member Functions

 getIcon ($role=Icon::DEFAULT_ROLE)
 
 __get ($attribute)
 
 __set ($name, $value)
 
 isVisible ($user_id)
 
 isReadable ($user_id)
 
 getDescriptionTemplate ()
 
 isFileDownloadable ($file_id, $user_id)
 
 isFileEditable ($file_id, $user_id)
 
 isFileWritable ($file_id, $user_id)
 
 getEditTemplate ()
 
 setDataFromEditTemplate ($request)
 
- 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 = 1
 
- 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

__get (   $attribute)
Parameters
$attribute
Returns
mixed
__set (   $name,
  $value 
)
Parameters
$name
$value
Returns
mixed
static availableInRange (   $range_id_or_object,
  $user_id 
)
static
Parameters
Object | string$range_id_or_object
string$user_id
Returns
bool

Implements FolderType.

getDescriptionTemplate ( )

Returns a description template for PublicFolders.

Returns
string A string describing this folder type.

Implements FolderType.

getEditTemplate ( )

Returns the edit template for this folder type.

Returns
Flexi_Template

Implements FolderType.

getIcon (   $role = Icon::DEFAULT_ROLE)
Parameters
string$role
Returns
Icon

Implements FolderType.

static getTypeName ( )
static

Returns a localised name of the PublicFolder type.

Returns
string The localised name of this folder type.

Implements FolderType.

isFileDownloadable (   $file_id,
  $user_id 
)

Files in PublicFolders are always downloadable.

Parameters
string$file_idThe ID to a FileRef.
string$user_idThe user who wishes to downlaod the file.
Returns
bool True

Implements FolderType.

isFileEditable (   $file_id,
  $user_id 
)

Files in PublicFolders are editable for the owner only.

Parameters
string$file_idThe ID to a FileRef.
string$user_idThe user who wishes to edit the file.
Returns
bool True, if the user is the owner of the file, false otherwise.

Implements FolderType.

isFileWritable (   $file_id,
  $user_id 
)

Files in PublicFolders are writable for the owner only.

Parameters
string$file_idThe ID to a FileRef.
string$user_idThe user who wishes to write to the file.
Returns
bool True, if the user is the owner of the file, false otherwise.

Implements FolderType.

isReadable (   $user_id)

PublicFolders are readable for the owner, or for all if viewable flag is set

Parameters
string$user_idThe user who wishes to read the folder.
Returns
bool True

Implements FolderType.

isVisible (   $user_id)

PublicFolders are visible for the owner, or for all if viewable flag is set

Parameters
string$user_idThe user who wishes to see the folder.
Returns
bool True

Implements FolderType.

setDataFromEditTemplate (   $request)

Sets the data from a submitted edit template.

Parameters
array$requestThe data from the edit template.
Returns
PublicFolder A "reference" to this PublicFolder.

Implements FolderType.

Field Documentation

$sorter = 1
static

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