Open Journal Systems  3.3.0
LibraryFileGridHandler Class Reference
Inheritance diagram for LibraryFileGridHandler:
CategoryGridHandler GridHandler PKPHandler LibraryFileAdminGridHandler SelectableLibraryFileGridHandler SubmissionDocumentsFilesGridHandler

Public Member Functions

 __construct ($dataProvider)
 
 _getEditFileForm ($context, $fileId)
 
 _getNewFileForm ($context)
 
 addFile ($args, $request)
 
 canEdit ()
 
 deleteFile ($args, $request)
 
 editFile ($args, $request)
 
 getActionArgs ()
 
 getContext ()
 
 getFileNameColumn ()
 
 initialize ($request, $args=null)
 
 saveFile ($args, $request)
 
 setCanEdit ($canEdit)
 
 updateFile ($args, $request)
 
 uploadFile ($args, $request)
 
- Public Member Functions inherited from CategoryGridHandler
 fetchCategory ($args, $request)
 
 getCategoryItemsCount ($categoryElement, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
getGridCategoryDataElements ($request, $categoryElement)
 
 getJSHandler ()
 
 getRequestArgs ()
 
 hasGridDataElementsInCategory ($categoryElement, $request)
 
 isDataElementInCategorySelected ($categoryId, &$gridDataElement)
 
 setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence)
 
 setEmptyCategoryRowText ($translationKey)
 
 setGridCategoryDataElements ($request, $categoryElementId, $data)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow ($args, $request)
 
 fetchRows ($args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag=null)
 
 getDataElementSequence ($gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_canEdit
 
 $_context
 
- Data Fields inherited from CategoryGridHandler
 $_categoryData
 
 $_currentCategoryId = null
 
 $_emptyCategoryRowText = 'grid.noItems'
 
- Data Fields inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_constants = []
 
 $_data
 
 $_dataProvider
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Protected Member Functions

 getCategoryRowInstance ()
 
 getRowInstance ()
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from CategoryGridHandler
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
 getCategoryRowIdParameterName ()
 
 getRequestedCategoryRow ($request, $args)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 loadCategoryData ($request, &$categoryDataElement, $filter=null)
 
 renderRowInternally ($request, $row)
 
 setFirstDataColumn ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowsInternally ($request, &$elements)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Base class for handling library file grid requests.

Handle submission documents file grid requests.

Definition at line 25 of file LibraryFileGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

LibraryFileGridHandler::__construct (   $dataProvider)

Constructor

Reimplemented from CategoryGridHandler.

Definition at line 35 of file LibraryFileGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getEditFileForm()

LibraryFileGridHandler::_getEditFileForm (   $context,
  $fileId 
)

Returns a specific instance of the edit form for this grid. Must be implemented by subclasses.

Parameters
$contextPress
$fileIdint

Reimplemented in SubmissionDocumentsFilesGridHandler, and LibraryFileAdminGridHandler.

Definition at line 322 of file LibraryFileGridHandler.inc.php.

Referenced by editFile(), and updateFile().

◆ _getNewFileForm()

LibraryFileGridHandler::_getNewFileForm (   $context)

Returns a specific instance of the new form for this grid. Must be implemented by subclasses.

Parameters
$contextContext

Reimplemented in SubmissionDocumentsFilesGridHandler, and LibraryFileAdminGridHandler.

Definition at line 312 of file LibraryFileGridHandler.inc.php.

Referenced by addFile(), and saveFile().

◆ addFile()

LibraryFileGridHandler::addFile (   $args,
  $request 
)

An action to add a new file

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 181 of file LibraryFileGridHandler.inc.php.

References _getNewFileForm(), and initialize().

◆ canEdit()

LibraryFileGridHandler::canEdit ( )

Can the user edit/add files in this grid?

Returns
boolean

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

References $_canEdit.

Referenced by SubmissionDocumentsFilesGridHandler\getRowInstance(), getRowInstance(), SubmissionDocumentsFilesGridHandler\initialize(), and initialize().

◆ deleteFile()

LibraryFileGridHandler::deleteFile (   $args,
  $request 
)

Delete a file

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 267 of file LibraryFileGridHandler.inc.php.

References DAO\getDataChangedEvent().

◆ editFile()

LibraryFileGridHandler::editFile (   $args,
  $request 
)

An action to add a new file

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 221 of file LibraryFileGridHandler.inc.php.

References _getEditFileForm(), and initialize().

◆ getActionArgs()

LibraryFileGridHandler::getActionArgs ( )

Retrieve the arguments for the 'add file' action.

Returns
array

Reimplemented in SubmissionDocumentsFilesGridHandler.

Definition at line 330 of file LibraryFileGridHandler.inc.php.

◆ getCategoryRowInstance()

LibraryFileGridHandler::getCategoryRowInstance ( )
protected

Get a new instance of a category grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
CategoryGridRow

Reimplemented from CategoryGridHandler.

Definition at line 128 of file LibraryFileGridHandler.inc.php.

References getContext().

◆ getContext()

LibraryFileGridHandler::getContext ( )

Get the context

Returns
object context

Definition at line 53 of file LibraryFileGridHandler.inc.php.

References $_context.

Referenced by getCategoryRowInstance(), and loadData().

◆ getFileNameColumn()

LibraryFileGridHandler::getFileNameColumn ( )

Get an instance of the cell provider for this grid.

Returns
LibraryFileGridCellProvider

Definition at line 161 of file LibraryFileGridHandler.inc.php.

Referenced by initialize().

◆ getRowInstance()

LibraryFileGridHandler::getRowInstance ( )
protected

Get the row handler - override the default row handler

Returns
LibraryFileGridRow

Reimplemented from GridHandler.

Reimplemented in SubmissionDocumentsFilesGridHandler.

Definition at line 153 of file LibraryFileGridHandler.inc.php.

References canEdit().

◆ initialize()

LibraryFileGridHandler::initialize (   $request,
  $args = null 
)

◆ loadData()

LibraryFileGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$filterarray An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
grid data

Reimplemented from GridHandler.

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

References getContext().

◆ saveFile()

LibraryFileGridHandler::saveFile (   $args,
  $request 
)

Save a new library file.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 198 of file LibraryFileGridHandler.inc.php.

References _getNewFileForm(), and DAO\getDataChangedEvent().

◆ setCanEdit()

LibraryFileGridHandler::setCanEdit (   $canEdit)

Set whether or not the user can edit or add files.

Parameters
$canEditboolean

Definition at line 69 of file LibraryFileGridHandler.inc.php.

Referenced by SubmissionDocumentsFilesGridHandler\initialize(), and LibraryFileAdminGridHandler\initialize().

◆ updateFile()

LibraryFileGridHandler::updateFile (   $args,
  $request 
)

Save changes to an existing library file.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 241 of file LibraryFileGridHandler.inc.php.

References _getEditFileForm(), and DAO\getDataChangedEvent().

◆ uploadFile()

LibraryFileGridHandler::uploadFile (   $args,
  $request 
)

Upload a new library file.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 288 of file LibraryFileGridHandler.inc.php.

Field Documentation

◆ $_canEdit

LibraryFileGridHandler::$_canEdit

whether or not the grid is editable

Definition at line 30 of file LibraryFileGridHandler.inc.php.

Referenced by canEdit().

◆ $_context

LibraryFileGridHandler::$_context

the context for this grid

Definition at line 27 of file LibraryFileGridHandler.inc.php.

Referenced by getContext().


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