Open Journal Systems  3.3.0
SubscriptionsGridHandler Class Reference
Inheritance diagram for SubscriptionsGridHandler:
GridHandler PKPHandler IndividualSubscriptionsGridHandler InstitutionalSubscriptionsGridHandler

Public Member Functions

 __construct ()
 
 addSubscription ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 renewSubscription ($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

 getFilterForm ()
 
 getRowInstance ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 loadData ($request, $filter)
 
 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 grid requests.

Definition at line 21 of file SubscriptionsGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubscriptionsGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 26 of file SubscriptionsGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addSubscription()

SubscriptionsGridHandler::addSubscription (   $args,
  $request 
)

Add a new subscription.

Parameters
$argsarray
$requestPKPRequest

Definition at line 129 of file SubscriptionsGridHandler.inc.php.

◆ authorize()

SubscriptionsGridHandler::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 42 of file SubscriptionsGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getFilterForm()

SubscriptionsGridHandler::getFilterForm ( )
protected

Returns a Form object or the path name of a filter template.

Returns
Form|string
string Filter template.

Reimplemented from GridHandler.

Definition at line 116 of file SubscriptionsGridHandler.inc.php.

◆ getFilterSelectionData()

SubscriptionsGridHandler::getFilterSelectionData (   $request)

Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).

Parameters
$requestPKPRequest
Returns
array
array Filter selection data.

Reimplemented from GridHandler.

Definition at line 99 of file SubscriptionsGridHandler.inc.php.

◆ getRowInstance()

SubscriptionsGridHandler::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
SubscriptionsGridRow

Reimplemented from GridHandler.

Definition at line 91 of file SubscriptionsGridHandler.inc.php.

◆ initFeatures()

SubscriptionsGridHandler::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 82 of file SubscriptionsGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

Reimplemented in IndividualSubscriptionsGridHandler, and InstitutionalSubscriptionsGridHandler.

Definition at line 51 of file SubscriptionsGridHandler.inc.php.

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

◆ renewSubscription()

SubscriptionsGridHandler::renewSubscription (   $args,
  $request 
)

Renew a subscription.

Parameters
$argsarray first parameter is the ID of the subscription to renew
$requestPKPRequest

Definition at line 139 of file SubscriptionsGridHandler.inc.php.

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


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