FilesGridCapabilities Class Reference

Public Member Functions
	__construct ($capabilities=0)
	canAdd ()
	canDelete ()
	canDownloadAll ()
	canEdit ()
	canManage ()
	canViewNotes ()
	getDownloadAllAction ($request, $files, $linkParams)
	setCanAdd ($canAdd)
	setCanDelete ($canDelete)
	setCanDownloadAll ($canDownloadAll)
	setCanEdit ($canEdit)
	setCanManage ($canManage)
	setCanViewNotes ($canViewNotes)

Data Fields
	$_canAdd
	$_canDelete
	$_canDownloadAll
	$_canEdit
	$_canManage
	$_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 25 of file FilesGridCapabilities.inc.php.

Constructor & Destructor Documentation

__construct()

FilesGridCapabilities::__construct

(

$capabilities = 0

)

Constructor

Parameters

$capabilities

integer A bit map with zero or more FILE_GRID_* capabilities set.

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

References setCanAdd(), setCanDelete(), setCanDownloadAll(), setCanEdit(), setCanManage(), and setCanViewNotes().

Member Function Documentation

canAdd()

FilesGridCapabilities::canAdd

(

)

Does this grid allow the addition of files or revisions?

Returns

boolean

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

References $_canAdd.

canDelete()

FilesGridCapabilities::canDelete

(

)

Can the user delete files from this grid?

Returns

boolean

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

References $_canDelete.

canDownloadAll()

FilesGridCapabilities::canDownloadAll

(

)

Can the user download all files as an archive?

Returns

boolean

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

References FileArchive\isFunctional().

canEdit()

FilesGridCapabilities::canEdit

(

)

Whether the grid allows file metadata editing

Returns

boolean

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

References $_canEdit.

canManage()

FilesGridCapabilities::canManage

(

)

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

Returns

boolean

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

References $_canManage.

canViewNotes()

FilesGridCapabilities::canViewNotes

(

)

Does this grid allow viewing of notes?

Returns

boolean

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

References $_canViewNotes.

getDownloadAllAction()

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

Get the download all link action.

Parameters

$request	PKPRequest
$files	array The files to be downloaded.
$linkParams	array The link action request parameters.

Returns

LinkAction

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

setCanAdd()

FilesGridCapabilities::setCanAdd

(

$canAdd

)

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

Parameters

$canAdd

boolean

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

Referenced by __construct().

setCanDelete()

FilesGridCapabilities::setCanDelete

(

$canDelete

)

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

Parameters

$canDelete

boolean

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

Referenced by __construct().

setCanDownloadAll()

FilesGridCapabilities::setCanDownloadAll

(

$canDownloadAll

)

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

Returns

boolean

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

Referenced by __construct().

setCanEdit()

FilesGridCapabilities::setCanEdit

(

$canEdit

)

Set whether the grid allows file metadata editing

Returns

boolean

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

Referenced by __construct().

setCanManage()

FilesGridCapabilities::setCanManage

(

$canManage

)

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

Returns

boolean

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

Referenced by __construct().

setCanViewNotes()

FilesGridCapabilities::setCanViewNotes

(

$canViewNotes

)

Set whether this grid allows viewing of notes or not.

Returns

boolean

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

Referenced by __construct().

Field Documentation

$_canAdd

boolean FilesGridCapabilities::$_canAdd

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

Referenced by canAdd().

$_canDelete

boolean FilesGridCapabilities::$_canDelete

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

Referenced by canDelete().

$_canDownloadAll

boolean FilesGridCapabilities::$_canDownloadAll

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

$_canEdit

boolean FilesGridCapabilities::$_canEdit

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

Referenced by canEdit().

$_canManage

boolean FilesGridCapabilities::$_canManage

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

Referenced by canManage().

$_canViewNotes

boolean FilesGridCapabilities::$_canViewNotes

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

Referenced by canViewNotes().

---

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

• FilesGridCapabilities.inc.php