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

Public Member Functions

 __construct ()
 
 addSubscriptionType ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 deleteSubscriptionType ($args, $request)
 
 editSubscriptionType ($args, $request)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 updateSubscriptionType ($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)
 
 getDataElementSequence ($gridDataElement)
 
 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)
 
 setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence)
 
 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)
 
- 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 subscription type grid requests.

Definition at line 22 of file SubscriptionTypesGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubscriptionTypesGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addSubscriptionType()

SubscriptionTypesGridHandler::addSubscriptionType (   $args,
  $request 
)

Add a new subscription type.

Parameters
$argsarray
$requestPKPRequest

Definition at line 164 of file SubscriptionTypesGridHandler.inc.php.

References editSubscriptionType().

◆ authorize()

SubscriptionTypesGridHandler::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 43 of file SubscriptionTypesGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ deleteSubscriptionType()

SubscriptionTypesGridHandler::deleteSubscriptionType (   $args,
  $request 
)

Delete a subscription type.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

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

◆ editSubscriptionType()

SubscriptionTypesGridHandler::editSubscriptionType (   $args,
  $request 
)

Edit an existing subscription type.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 175 of file SubscriptionTypesGridHandler.inc.php.

Referenced by addSubscriptionType().

◆ getRowInstance()

SubscriptionTypesGridHandler::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
SubscriptionTypesGridRow

Reimplemented from GridHandler.

Definition at line 131 of file SubscriptionTypesGridHandler.inc.php.

◆ initFeatures()

SubscriptionTypesGridHandler::initFeatures (   $request,
  $args 
)

Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.

Parameters
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 138 of file SubscriptionTypesGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

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

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

◆ loadData()

SubscriptionTypesGridHandler::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 146 of file SubscriptionTypesGridHandler.inc.php.

References DAORegistry\getDAO(), GridHandler\getGridRangeInfo(), and PKPHandler\getId().

◆ updateSubscriptionType()

SubscriptionTypesGridHandler::updateSubscriptionType (   $args,
  $request 
)

Update an existing subscription type.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

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

References DAO\getDataChangedEvent().


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