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

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 createReviewFormElement ($args, $request)
 
 deleteReviewFormElement ($args, $request)
 
 editReviewFormElement ($args, $request)
 
 getDataElementSequence ($gridDataElement)
 
 getRequestArgs ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 updateReviewFormElement ($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

 $reviewFormId
 
- 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

Handle review form element grid requests.

Definition at line 20 of file ReviewFormElementsGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReviewFormElementsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

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

◆ createReviewFormElement()

ReviewFormElementsGridHandler::createReviewFormElement (   $args,
  $request 
)

Add a new review form element.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 184 of file ReviewFormElementsGridHandler.inc.php.

◆ deleteReviewFormElement()

ReviewFormElementsGridHandler::deleteReviewFormElement (   $args,
  $request 
)

Delete a review form element.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 250 of file ReviewFormElementsGridHandler.inc.php.

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

◆ editReviewFormElement()

ReviewFormElementsGridHandler::editReviewFormElement (   $args,
  $request 
)

Edit an existing review form element.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 197 of file ReviewFormElementsGridHandler.inc.php.

◆ getDataElementSequence()

ReviewFormElementsGridHandler::getDataElementSequence (   $gridDataElement)

Override to return the data element sequence value.

Parameters
$gridDataElementmixed
Returns
int

Reimplemented from GridHandler.

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

◆ getRequestArgs()

ReviewFormElementsGridHandler::getRequestArgs ( )

See also
GridHandler::getRequestArgs()

Reimplemented from GridHandler.

Definition at line 154 of file ReviewFormElementsGridHandler.inc.php.

◆ getRowInstance()

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

Reimplemented from GridHandler.

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

◆ initFeatures()

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

Reimplemented from GridHandler.

Definition at line 126 of file ReviewFormElementsGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

Definition at line 65 of file ReviewFormElementsGridHandler.inc.php.

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

◆ loadData()

ReviewFormElementsGridHandler::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 142 of file ReviewFormElementsGridHandler.inc.php.

References DAORegistry\getDAO().

◆ setDataElementSequence()

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

Override to set the data element new sequence.

Parameters
$requestPKPRequest
$rowIdint
$gridDataElementmixed
$newSequenceint

Reimplemented from GridHandler.

Definition at line 168 of file ReviewFormElementsGridHandler.inc.php.

References DAORegistry\getDAO().

◆ updateReviewFormElement()

ReviewFormElementsGridHandler::updateReviewFormElement (   $args,
  $request 
)

Save changes to a review form element.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

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

Field Documentation

◆ $reviewFormId

int ReviewFormElementsGridHandler::$reviewFormId

Review form ID

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


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