Open Journal Systems  3.3.0
LanguageGridHandler Class Reference
Inheritance diagram for LanguageGridHandler:
GridHandler PKPHandler AdminLanguageGridHandler ManageLanguageGridHandler

Public Member Functions

 __construct ()
 
 addManagementColumns ()
 
 addManagementData ($request, $data)
 
 addNameColumn ()
 
 addPrimaryColumn ($columnId)
 
 getCellProvider ()
 
 initialize ($request, $args=null)
 
 saveLanguageSetting ($args, $request)
 
 setContextPrimaryLocale ($args, $request)
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 addAction ($action, $position=GRID_ACTION_POSITION_ABOVE)
 
 addColumn ($column)
 
 authorize ($request, &$args, $roleAssignments)
 
 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 ()
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getFilterForm ()
 
 getFilterSelectionData ($request)
 
 getRowDataElement ($request, &$rowId)
 
 getRowsSequence ($request)
 
 initFeatures ($request, $args)
 
 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 language grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

LanguageGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Reimplemented in AdminLanguageGridHandler, and ManageLanguageGridHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ addManagementColumns()

LanguageGridHandler::addManagementColumns ( )

Add columns related to management settings.

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

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

Referenced by AdminLanguageGridHandler\initialize(), and ManageLanguageGridHandler\initialize().

◆ addManagementData()

LanguageGridHandler::addManagementData (   $request,
  $data 
)

Add data related to management settings.

Parameters
$requestRequest
$dataArray Data already loaded.
Returns
Array Same passed array, but with the extra management data inserted.

Definition at line 254 of file LanguageGridHandler.inc.php.

Referenced by ManageLanguageGridHandler\loadData(), and AdminLanguageGridHandler\loadData().

◆ addNameColumn()

LanguageGridHandler::addNameColumn ( )

◆ addPrimaryColumn()

LanguageGridHandler::addPrimaryColumn (   $columnId)

Add primary column.

Parameters
$columnIdstring The column id.

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

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

Referenced by AdminLanguageGridHandler\initialize(), and ManageLanguageGridHandler\initialize().

◆ getCellProvider()

LanguageGridHandler::getCellProvider ( )

Return an instance of the cell provider used by this grid.

Returns
GridCellProvider

Definition at line 171 of file LanguageGridHandler.inc.php.

Referenced by addManagementColumns(), addNameColumn(), addPrimaryColumn(), and AdminLanguageGridHandler\initialize().

◆ getRowInstance()

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

Reimplemented from GridHandler.

Definition at line 55 of file LanguageGridHandler.inc.php.

◆ initialize()

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

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

Reimplemented from GridHandler.

Reimplemented in ManageLanguageGridHandler, and AdminLanguageGridHandler.

Definition at line 39 of file LanguageGridHandler.inc.php.

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

◆ saveLanguageSetting()

LanguageGridHandler::saveLanguageSetting (   $args,
  $request 
)

Save language management settings.

Parameters
$argsarray
$requestRequest
Returns
JSONObject JSON message

Definition at line 68 of file LanguageGridHandler.inc.php.

References PKPServices\get(), PKPLocale\getAllLocales(), DAO\getDataChangedEvent(), GridHandler\getGridDataElements(), and PKPLocale\isLocaleValid().

◆ setContextPrimaryLocale()

LanguageGridHandler::setContextPrimaryLocale (   $args,
  $request 
)

Set context primary locale.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

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

References Application\getContextDAO(), DAO\getDataChangedEvent(), GridHandler\getGridDataElements(), and PKPLocale\isLocaleValid().


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