Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPAuthorGridHandler Class Reference
Inheritance diagram for PKPAuthorGridHandler:
GridHandler PKPHandler AuthorGridHandler

Public Member Functions

 addAuthor ($args, $request)
 
 addUser ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 canAdminister ()
 
 deleteAuthor ($args, $request)
 
 editAuthor ($args, $request)
 
 getDataElementSequence ($row)
 
 getReadOnly ()
 
 getRequestArgs ()
 
 getRequestedSubmissionId ($request)
 
 getRowInstance ()
 
 getSubmission ()
 
 initFeatures ($request, $args)
 
 loadData ($request, $filter=null)
 
 PKPAuthorGridHandler ()
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setReadOnly ($readOnly)
 
 setSubmission ($submission)
 
 updateAuthor ($args, $request)
 
- Public Member Functions inherited from GridHandler
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
 fetchCell (&$args, $request)
 
 fetchGrid ($args, $request)
 
 fetchRow (&$args, $request)
 
 getActions ($position=GRID_ACTION_POSITION_ABOVE)
 
 getColumn ($columnId)
 
getColumns ()
 
getColumnsByFlag ($flag)
 
 getColumnsCount ($flag)
 
 getDataElementSequence (&$gridDataElement)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getInstructions ()
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestArgs ()
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 GridHandler ($dataProvider=null)
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 initialize ($request, $args=null)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setDataElementSequence ($request, $rowId, &$gridDataElement, $newSequence)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setInstructions ($instructions)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Public Attributes inherited from GridHandler
 $_actions = array(GRID_ACTION_POSITION_DEFAULT => array())
 
 $_columns = array()
 
 $_data
 
 $_emptyRowText = 'grid.noItems'
 
 $_features
 
 $_footNote = ''
 
 $_instructions = ''
 
 $_itemIterator
 
 $_template
 
 $_title = ''
 
 $_urls
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, $rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 initFeatures ($request, &$args)
 
 loadData ($request, $filter)
 
 noAutocompleteResults ()
 
 renderFilter ($request, $filterData=array())
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 

Detailed Description

base PKP class to handle author grid requests.

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

Member Function Documentation

PKPAuthorGridHandler::addAuthor (   $args,
  $request 
)

An action to manually add a new author

Parameters
$argsarray
$requestPKPRequest

Definition at line 263 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::addUser (   $args,
  $request 
)

Add a user with data initialized from an existing author.

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 378 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
$enforceRestrictedSiteboolean True iff site restrictions are to be enforced
Returns
boolean

Definition at line 87 of file PKPAuthorGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), canAdminister(), PKPHandler\getAuthorizedContextObject(), getRequestArgs(), AppLocale\requireComponents(), GridHandler\setInstructions(), setReadOnly(), setSubmission(), and GridHandler\setTitle().

PKPAuthorGridHandler::canAdminister ( )

Determines if there should be an 'add user' action on this grid. Overridden by child grids.

Returns
boolean

Definition at line 232 of file PKPAuthorGridHandler.inc.php.

Referenced by authorize().

PKPAuthorGridHandler::deleteAuthor (   $args,
  $request 
)

Delete a author

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 355 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::editAuthor (   $args,
  $request 
)

Edit a author

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 275 of file PKPAuthorGridHandler.inc.php.

Referenced by loadData().

PKPAuthorGridHandler::getDataElementSequence (   $row)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Definition at line 192 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::getReadOnly ( )

Get whether or not this grid should be 'read only'

Returns
boolean

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

PKPAuthorGridHandler::getRequestArgs ( )

Get the arguments that will identify the data in the grid. Overridden by child grids.

Returns
array

Definition at line 220 of file PKPAuthorGridHandler.inc.php.

Referenced by authorize().

PKPAuthorGridHandler::getRequestedSubmissionId (   $request)

Fetches the application-specific submission id from the request object. Should be overridden by subclasses.

Parameters
PKPRequest$request
Returns
int

Definition at line 242 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::getRowInstance ( )

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

Returns
GridRow
AuthorGridRow

Definition at line 211 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::getSubmission ( )

Get the submission associated with this author grid.

Returns
Submission

Definition at line 52 of file PKPAuthorGridHandler.inc.php.

Referenced by AuthorGridHandler\canAdminister().

PKPAuthorGridHandler::initFeatures (   $request,
  $args 
)
See Also
GridHandler::initFeatures()

Definition at line 180 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::loadData (   $request,
  $filter = null 
)

Implement this method to load data into the grid.

Parameters
$requestRequest
$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

Definition at line 249 of file PKPAuthorGridHandler.inc.php.

References editAuthor().

PKPAuthorGridHandler::PKPAuthorGridHandler ( )

Constructor

Definition at line 40 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::setDataElementSequence (   $request,
  $rowId,
  $gridDataElement,
  $newSequence 
)

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Definition at line 199 of file PKPAuthorGridHandler.inc.php.

PKPAuthorGridHandler::setReadOnly (   $readOnly)

Set the boolean for 'read only' status

Parameters
boolean

Definition at line 76 of file PKPAuthorGridHandler.inc.php.

Referenced by authorize().

PKPAuthorGridHandler::setSubmission (   $submission)

Set the Submission

Parameters
Submission

Definition at line 60 of file PKPAuthorGridHandler.inc.php.

Referenced by authorize().

PKPAuthorGridHandler::updateAuthor (   $args,
  $request 
)

Edit a author

Parameters
$argsarray
$requestPKPRequest
Returns
string Serialized JSON object

Definition at line 298 of file PKPAuthorGridHandler.inc.php.


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