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

Public Member Functions

 deleteSubscription ($args, $request)
 
 editSubscription ($args, $request)
 
 initialize ($request, $args=null)
 
 renderFilter ($request)
 
 updateSubscription ($args, $request)
 
- Public Member Functions inherited from SubscriptionsGridHandler
 __construct ()
 
 addSubscription ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 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

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

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

Member Function Documentation

◆ deleteSubscription()

InstitutionalSubscriptionsGridHandler::deleteSubscription (   $args,
  $request 
)

Delete a subscription.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 189 of file InstitutionalSubscriptionsGridHandler.inc.php.

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

◆ editSubscription()

InstitutionalSubscriptionsGridHandler::editSubscription (   $args,
  $request 
)

Edit an existing subscription.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 152 of file InstitutionalSubscriptionsGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from SubscriptionsGridHandler.

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

References GridHandler\addColumn(), and GridHandler\setTitle().

◆ loadData()

InstitutionalSubscriptionsGridHandler::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 133 of file InstitutionalSubscriptionsGridHandler.inc.php.

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

◆ renderFilter()

InstitutionalSubscriptionsGridHandler::renderFilter (   $request)

Render the filter (a template).

Parameters
$requestPKPRequest
$filterDataArray Data to be used by the filter template.
Returns
string

Definition at line 98 of file InstitutionalSubscriptionsGridHandler.inc.php.

◆ updateSubscription()

InstitutionalSubscriptionsGridHandler::updateSubscription (   $args,
  $request 
)

Update an existing subscription.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 166 of file InstitutionalSubscriptionsGridHandler.inc.php.

References DAO\getDataChangedEvent().


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