Base class for handling library file grid requests. More...
Public Member Functions | |
| & | _getEditFileForm ($context, $fileId) |
| & | _getNewFileForm ($context) |
| addFile ($args, &$request) | |
| canEdit () | |
| deleteFile ($args, &$request) | |
| editFile ($args, &$request) | |
| getActionArgs () | |
| & | getCategoryRowInstance () |
| getContext () | |
| & | getFileNameColumn () |
| & | getRowInstance () |
| LibraryFileGridHandler ($dataProvider) | |
| loadData ($request, $filter) | |
| saveFile ($args, &$request) | |
| setCanEdit ($canEdit) | |
| updateFile ($args, &$request) | |
| uploadFile ($args, &$request) | |
Public Attributes | |
| $_canEdit | |
| $_context | |
Detailed Description
Base class for handling library file grid requests.
Handle submission documents file grid requests.
Definition at line 26 of file LibraryFileGridHandler.inc.php.
Member Function Documentation
| & LibraryFileGridHandler._getEditFileForm | ( | $ | context, | |
| $ | fileId | |||
| ) |
Returns a specific instance of the edit form for this grid. Must be implemented by subclasses.
- Parameters:
-
$context Press $fileId int
Reimplemented in LibraryFileAdminGridHandler.
Definition at line 333 of file LibraryFileGridHandler.inc.php.
Referenced by editFile(), and updateFile().
| & LibraryFileGridHandler._getNewFileForm | ( | $ | context | ) |
Returns a specific instance of the new form for this grid. Must be implemented by subclasses.
- Parameters:
-
$context Press
Reimplemented in LibraryFileAdminGridHandler.
Definition at line 323 of file LibraryFileGridHandler.inc.php.
Referenced by addFile(), and saveFile().
| LibraryFileGridHandler.addFile | ( | $ | args, | |
| &$ | request | |||
| ) |
An action to add a new file
- Parameters:
-
$args array $request PKPRequest
Definition at line 184 of file LibraryFileGridHandler.inc.php.
References _getNewFileForm().
| LibraryFileGridHandler.canEdit | ( | ) |
Can the user edit/add files in this grid?
- Returns:
- boolean
Definition at line 62 of file LibraryFileGridHandler.inc.php.
Referenced by getRowInstance().
| LibraryFileGridHandler.deleteFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Delete a file
- Parameters:
-
$args array $request PKPRequest
- Returns:
- string Serialized JSON object
Definition at line 275 of file LibraryFileGridHandler.inc.php.
| LibraryFileGridHandler.editFile | ( | $ | args, | |
| &$ | request | |||
| ) |
An action to add a new file
- Parameters:
-
$args array $request PKPRequest
- Returns:
- string Serialized JSON object
Definition at line 227 of file LibraryFileGridHandler.inc.php.
References _getEditFileForm().
| LibraryFileGridHandler.getActionArgs | ( | ) |
Retrieve the arguments for the 'add file' action.
- Returns:
- array
Definition at line 341 of file LibraryFileGridHandler.inc.php.
| & LibraryFileGridHandler.getCategoryRowInstance | ( | ) |
- See also:
- CategoryGridHandler.getCategoryRowInstance()
Definition at line 128 of file LibraryFileGridHandler.inc.php.
References getContext().
| LibraryFileGridHandler.getContext | ( | ) |
Get the context
- Returns:
- object context
Definition at line 54 of file LibraryFileGridHandler.inc.php.
Referenced by getCategoryRowInstance(), and loadData().
| & LibraryFileGridHandler.getFileNameColumn | ( | ) |
Get an instance of the cell provider for this grid.
- Returns:
- LibraryFileGridCellProvider
Definition at line 163 of file LibraryFileGridHandler.inc.php.
| & LibraryFileGridHandler.getRowInstance | ( | ) |
Get the row handler - override the default row handler
- Returns:
- LibraryFileGridRow
Definition at line 154 of file LibraryFileGridHandler.inc.php.
References canEdit().
| LibraryFileGridHandler.LibraryFileGridHandler | ( | $ | dataProvider | ) |
Constructor
Definition at line 36 of file LibraryFileGridHandler.inc.php.
Referenced by LibraryFileAdminGridHandler.LibraryFileAdminGridHandler().
| LibraryFileGridHandler.loadData | ( | $ | request, | |
| $ | filter | |||
| ) |
- See also:
- GridHandler.loadData()
Definition at line 136 of file LibraryFileGridHandler.inc.php.
References getContext().
| LibraryFileGridHandler.saveFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Save a new library file.
- Parameters:
-
$args array $request PKPRequest
- Returns:
- string
Definition at line 202 of file LibraryFileGridHandler.inc.php.
References _getNewFileForm().
| LibraryFileGridHandler.setCanEdit | ( | $ | canEdit | ) |
Set whether or not the user can edit or add files.
- Parameters:
-
$canEdit boolean
Definition at line 70 of file LibraryFileGridHandler.inc.php.
| LibraryFileGridHandler.updateFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Save changes to an existing library file.
- Parameters:
-
$args array $request PKPRequest
- Returns:
- string
Definition at line 248 of file LibraryFileGridHandler.inc.php.
References _getEditFileForm().
| LibraryFileGridHandler.uploadFile | ( | $ | args, | |
| &$ | request | |||
| ) |
Upload a new library file.
- Parameters:
-
$args array $request PKPRequest
- Returns:
- string
Definition at line 298 of file LibraryFileGridHandler.inc.php.
Member Data Documentation
| LibraryFileGridHandler.$_canEdit |
whether or not the grid is editable
Definition at line 31 of file LibraryFileGridHandler.inc.php.
| LibraryFileGridHandler.$_context |
the context for this grid
Definition at line 28 of file LibraryFileGridHandler.inc.php.
The documentation for this class was generated from the following file:
- controllers/grid/files/LibraryFileGridHandler.inc.php
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by
1.7.1