Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FilesGridCapabilities Class Reference

Public Member Functions

 canAdd ()
 
 canDelete ()
 
 canDownloadAll ()
 
 canManage ()
 
 canViewNotes ()
 
 FilesGridCapabilities ($capabilities)
 
 getDownloadAllAction ($request, $files, $linkParams)
 
 setCanAdd ($canAdd)
 
 setCanDelete ($canDelete)
 
 setCanDownloadAll ($canDownloadAll)
 
 setCanManage ($canManage)
 
 setCanViewNotes ($canViewNotes)
 

Detailed Description

Defines files grid capabilities. Should be used by grid handlers that handle submission files to store which capabilities the grid has.

Definition at line 24 of file FilesGridCapabilities.inc.php.

Member Function Documentation

FilesGridCapabilities::canAdd ( )

Does this grid allow the addition of files or revisions?

Returns
boolean

Definition at line 78 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::canDelete ( )

Can the user delete files from this grid?

Returns
boolean

Definition at line 127 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::canDownloadAll ( )

Can the user download all files as an archive?

Returns
boolean

Definition at line 110 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::canManage ( )

Whether the grid allows file management (select existing files to add to grid)

Returns
boolean

Definition at line 143 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::canViewNotes ( )

Does this grid allow viewing of notes?

Returns
boolean

Definition at line 94 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::FilesGridCapabilities (   $capabilities)

Constructor

Parameters
$capabilitiesinteger A bit map with zero or more FILE_GRID_* capabilities set.

Definition at line 62 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::getDownloadAllAction (   $request,
  $files,
  $linkParams 
)

Get the download all link action.

Parameters
$requestPKPRequest
$filesarray The files to be downloaded.
$linkParamsarray The link action request parameters.
Returns
LinkAction

Definition at line 163 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::setCanAdd (   $canAdd)

Set whether or not the grid allows the addition of files or revisions.

Parameters
$canAddboolean

Definition at line 86 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::setCanDelete (   $canDelete)

Set whether or not the user can delete files from this grid.

Parameters
$canDeleteboolean

Definition at line 135 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::setCanDownloadAll (   $canDownloadAll)

Set whether user can download all files as an archive or not.

Returns
boolean

Definition at line 119 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::setCanManage (   $canManage)

Set whether the grid allows file management (select existing files to add to grid)

Returns
boolean

Definition at line 151 of file FilesGridCapabilities.inc.php.

FilesGridCapabilities::setCanViewNotes (   $canViewNotes)

Set whether this grid allows viewing of notes or not.

Returns
boolean

Definition at line 102 of file FilesGridCapabilities.inc.php.


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