Open Journal Systems  3.3.0
AuthorGridHandler Class Reference
Inheritance diagram for AuthorGridHandler:
GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 addAuthor ($args, $request)
 
 addUser ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 canAdminister ($user)
 
 deleteAuthor ($args, $request)
 
 editAuthor ($args, $request)
 
 getDataElementSequence ($gridDataElement)
 
 getPublication ()
 
 getReadOnly ()
 
 getRequestArgs ()
 
 getSubmission ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 setReadOnly ($readOnly)
 
 updateAuthor ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 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)
 
 getDataProvider ()
 
 getEmptyRowText ()
 
 getFeatures ()
 
 getFootNote ()
 
getGridDataElements ($request)
 
 getGridRangeInfo ($request, $rangeName, $contextData=null)
 
 getIsSubcomponent ()
 
 getItemIterator ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getSelectName ()
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 isDataElementSelected ($gridDataElement)
 
 renderRow ($request, $row)
 
 saveSequence ($args, $request)
 
 setEmptyRowText ($emptyRowText)
 
 setFootNote ($footNote)
 
 setGridDataElements ($data)
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setUrls ($request, $extraUrls=array())
 
- Public Member Functions inherited from PKPHandler
 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

 $_readOnly
 
 $_version
 
- 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

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

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 PKP class to handle author grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

AuthorGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addAuthor()

AuthorGridHandler::addAuthor (   $args,
  $request 
)

An action to manually add a new author

Parameters
$argsarray
$requestPKPRequest

Definition at line 289 of file AuthorGridHandler.inc.php.

References canAdminister(), and editAuthor().

◆ addUser()

AuthorGridHandler::addUser (   $args,
  $request 
)

Add a user with data initialized from an existing author.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 401 of file AuthorGridHandler.inc.php.

References DAORegistry\getDAO().

◆ authorize()

AuthorGridHandler::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.
Returns
boolean

Reimplemented from GridHandler.

Definition at line 92 of file AuthorGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ canAdminister()

AuthorGridHandler::canAdminister (   $user)

Determines if there should be add/edit actions on this grid.

Parameters
$userUser
Returns
boolean

Definition at line 248 of file AuthorGridHandler.inc.php.

References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), getPublication(), and getSubmission().

Referenced by addAuthor(), deleteAuthor(), editAuthor(), initFeatures(), initialize(), setDataElementSequence(), and updateAuthor().

◆ deleteAuthor()

AuthorGridHandler::deleteAuthor (   $args,
  $request 
)

Delete a author

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 382 of file AuthorGridHandler.inc.php.

References canAdminister(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ editAuthor()

AuthorGridHandler::editAuthor (   $args,
  $request 
)

Edit an author

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 302 of file AuthorGridHandler.inc.php.

References canAdminister(), DAORegistry\getDAO(), and getPublication().

Referenced by addAuthor().

◆ getDataElementSequence()

AuthorGridHandler::getDataElementSequence (   $gridDataElement)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

Definition at line 206 of file AuthorGridHandler.inc.php.

◆ getPublication()

AuthorGridHandler::getPublication ( )

Get the publication associated with this author grid.

Returns
Submission

Definition at line 66 of file AuthorGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by canAdminister(), editAuthor(), getRequestArgs(), getRowInstance(), initialize(), loadData(), and updateAuthor().

◆ getReadOnly()

AuthorGridHandler::getReadOnly ( )

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

Returns
boolean

Definition at line 74 of file AuthorGridHandler.inc.php.

References $_readOnly.

Referenced by getRowInstance().

◆ getRequestArgs()

AuthorGridHandler::getRequestArgs ( )

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

Returns
array

Reimplemented from GridHandler.

Definition at line 234 of file AuthorGridHandler.inc.php.

References getPublication(), and getSubmission().

Referenced by initialize().

◆ getRowInstance()

AuthorGridHandler::getRowInstance ( )
protected

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

Reimplemented from GridHandler.

Definition at line 225 of file AuthorGridHandler.inc.php.

References getPublication(), getReadOnly(), and getSubmission().

Referenced by updateAuthor().

◆ getSubmission()

AuthorGridHandler::getSubmission ( )

Get the submission associated with this author grid.

Returns
Submission

Definition at line 58 of file AuthorGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by canAdminister(), getRequestArgs(), getRowInstance(), and initialize().

◆ initFeatures()

AuthorGridHandler::initFeatures (   $request,
  $args 
)
See also
GridHandler::initFeatures()

Reimplemented from GridHandler.

Definition at line 194 of file AuthorGridHandler.inc.php.

References canAdminister().

◆ initialize()

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

◆ loadData()

AuthorGridHandler::loadData (   $request,
  $filter = null 
)
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 276 of file AuthorGridHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getId(), and getPublication().

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 213 of file AuthorGridHandler.inc.php.

References canAdminister(), and DAORegistry\getDAO().

◆ setReadOnly()

AuthorGridHandler::setReadOnly (   $readOnly)

Set the boolean for 'read only' status

Parameters
boolean

Definition at line 82 of file AuthorGridHandler.inc.php.

Referenced by initialize().

◆ updateAuthor()

AuthorGridHandler::updateAuthor (   $args,
  $request 
)

Update an author

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 324 of file AuthorGridHandler.inc.php.

References canAdminister(), PKPServices\get(), DAO\getDataChangedEvent(), PKPHandler\getId(), getPublication(), and getRowInstance().

Field Documentation

◆ $_readOnly

boolean AuthorGridHandler::$_readOnly

Definition at line 29 of file AuthorGridHandler.inc.php.

Referenced by getReadOnly().

◆ $_version

int AuthorGridHandler::$_version

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


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