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

Public Member Functions

 __construct ()
 
 activateReviewForm ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 copyReviewForm ($args, $request)
 
 createReviewForm ($args, $request)
 
 deactivateReviewForm ($args, $request)
 
 deleteReviewForm ($args, $request)
 
 editReviewForm ($args, $request)
 
 getDataElementSequence ($reviewForm)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 reviewFormBasics ($args, $request)
 
 reviewFormElements ($args, $request)
 
 reviewFormPreview ($args, $request)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateReviewForm ($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)
 
 getRequestArgs ()
 
 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)
 

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())
 
- 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 Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle review form grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

ReviewFormGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ activateReviewForm()

ReviewFormGridHandler::activateReviewForm (   $args,
  $request 
)

Activate a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 377 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ authorize()

ReviewFormGridHandler::authorize (   $request,
$args,
  $roleAssignments 
)
See also
PKPHandler::authorize()

Reimplemented from GridHandler.

Definition at line 133 of file ReviewFormGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ copyReviewForm()

ReviewFormGridHandler::copyReviewForm (   $args,
  $request 
)

Copy a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 334 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ createReviewForm()

ReviewFormGridHandler::createReviewForm (   $args,
  $request 
)

Add a new review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

◆ deactivateReviewForm()

ReviewFormGridHandler::deactivateReviewForm (   $args,
  $request 
)

Deactivate a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 410 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ deleteReviewForm()

ReviewFormGridHandler::deleteReviewForm (   $args,
  $request 
)

Delete a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 443 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().

◆ editReviewForm()

ReviewFormGridHandler::editReviewForm (   $args,
  $request 
)

Edit an existing review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 238 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), and PKPTemplateManager\getManager().

◆ getDataElementSequence()

ReviewFormGridHandler::getDataElementSequence (   $reviewForm)
See also
lib/pkp/classes/controllers/grid/GridHandler::getDataElementSequence()

Reimplemented from GridHandler.

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

◆ getRowInstance()

ReviewFormGridHandler::getRowInstance ( )
protected
See also
GridHandler::getRowInstance()
Returns
UserGridRow

Reimplemented from GridHandler.

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

◆ initFeatures()

ReviewFormGridHandler::initFeatures (   $request,
  $args 
)
See also
GridHandler::addFeatures()

Reimplemented from GridHandler.

Definition at line 188 of file ReviewFormGridHandler.inc.php.

◆ initialize()

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

See also
PKPHandler::initialize()
Parameters
$requestPKPRequest
$argsarray optional

Reimplemented from GridHandler.

Definition at line 47 of file ReviewFormGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ loadData()

ReviewFormGridHandler::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 160 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), and DAORegistry\getDAO().

◆ reviewFormBasics()

ReviewFormGridHandler::reviewFormBasics (   $args,
  $request 
)

Edit an existing review form's basics (title, description)

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 262 of file ReviewFormGridHandler.inc.php.

◆ reviewFormElements()

ReviewFormGridHandler::reviewFormElements (   $args,
  $request 
)

Display a list of the review form elements within a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 279 of file ReviewFormGridHandler.inc.php.

References PKPTemplateManager\getManager().

◆ reviewFormPreview()

ReviewFormGridHandler::reviewFormPreview (   $args,
  $request 
)

Preview a review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 203 of file ReviewFormGridHandler.inc.php.

References Application\getContextAssocType(), and DAORegistry\getDAO().

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 172 of file ReviewFormGridHandler.inc.php.

References DAORegistry\getDAO().

◆ updateReviewForm()

ReviewFormGridHandler::updateReviewForm (   $args,
  $request 
)

Update an existing review form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON message

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

References Application\getContextAssocType(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().


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