Open Monograph Press  3.3.0
CustomLocaleGridHandler Class Reference
Inheritance diagram for CustomLocaleGridHandler:
GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 editLocaleFile ($args, $request)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 loadData ($request, $filter)
 
 renderFilter ($request, $filterData=array())
 
 updateLocale ($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)
 

Static Public Member Functions

static setPlugin ($plugin)
 
- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 

Data Fields

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

Static Public Attributes

static $plugin
 

Additional Inherited Members

- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 renderGridBodyPartsInternally ($request)
 
 renderRowInternally ($request, $row)
 
 renderRowsInternally ($request, &$elements)
 
 setFirstDataColumn ()
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Definition at line 19 of file CustomLocaleGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

CustomLocaleGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 40 of file CustomLocaleGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

CustomLocaleGridHandler::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 51 of file CustomLocaleGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ editLocaleFile()

CustomLocaleGridHandler::editLocaleFile (   $args,
  $request 
)

Edit a locale file.

Parameters
$argsarray
$requestPKPKRequest

Definition at line 263 of file CustomLocaleGridHandler.inc.php.

References PKPHandler\setupTemplate().

◆ getFilterForm()

CustomLocaleGridHandler::getFilterForm ( )

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

Returns
Form|string
string Filter template.

Reimplemented from GridHandler.

Definition at line 214 of file CustomLocaleGridHandler.inc.php.

◆ getFilterSelectionData()

CustomLocaleGridHandler::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

Reimplemented from GridHandler.

Definition at line 242 of file CustomLocaleGridHandler.inc.php.

◆ initFeatures()

CustomLocaleGridHandler::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 201 of file CustomLocaleGridHandler.inc.php.

◆ initialize()

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

◆ loadData()

CustomLocaleGridHandler::loadData (   $request,
  $filter 
)

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 CustomLocaleGridHandler.inc.php.

References CustomLocaleAction\getLocaleFiles().

◆ renderFilter()

CustomLocaleGridHandler::renderFilter (   $request,
  $filterData = array() 
)

Render the filter (a template).

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

Reimplemented from GridHandler.

Definition at line 221 of file CustomLocaleGridHandler.inc.php.

◆ setPlugin()

static CustomLocaleGridHandler::setPlugin (   $plugin)
static

Set the custom locale plugin.

Definition at line 33 of file CustomLocaleGridHandler.inc.php.

References $plugin.

Referenced by CustomLocalePlugin\setupGridHandler().

◆ updateLocale()

CustomLocaleGridHandler::updateLocale (   $args,
  $request 
)

Update the custom locale data.

Parameters
$argsarray
$requestPKPRequest

Definition at line 62 of file CustomLocaleGridHandler.inc.php.

References PKPHandler\setupTemplate().

Field Documentation

◆ $form

$form CustomLocaleGridHandler::$form

Form

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

◆ $plugin

CustomLocaleGridHandler::$plugin
static

The custom locale plugin

Definition at line 28 of file CustomLocaleGridHandler.inc.php.

Referenced by setPlugin().


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