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

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 disableLocale ($args, $request)
 
 enableLocale ($args, $request)
 
 initialize ($request, $args=null)
 
 installLocale ($args, $request)
 
 saveInstallLocale ($args, $request)
 
 setPrimaryLocale ($args, $request)
 
 uninstallLocale ($args, $request)
 
- Public Member Functions inherited from LanguageGridHandler
 addManagementColumns ()
 
 addManagementData ($request, $data)
 
 addNameColumn ()
 
 addPrimaryColumn ($columnId)
 
 getCellProvider ()
 
 saveLanguageSetting ($args, $request)
 
 setContextPrimaryLocale ($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

 _canManage ($request)
 
 _updateContextLocaleSettings ($request)
 
 _updateLocaleSupportState ($request, $rowId, $enable)
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from LanguageGridHandler
 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 ()
 
 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 administrative language grid requests. If in single context (e.g. press) installation, this grid can also handle language management requests. See _canManage().

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

Constructor & Destructor Documentation

◆ __construct()

AdminLanguageGridHandler::__construct ( )

Constructor

Reimplemented from LanguageGridHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _canManage()

AdminLanguageGridHandler::_canManage (   $request)
protected

This grid can also present management functions if the conditions above are true.

Parameters
$requestRequest
Returns
boolean

Definition at line 418 of file AdminLanguageGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and Application\getContextDAO().

Referenced by initialize(), and loadData().

◆ _updateContextLocaleSettings()

AdminLanguageGridHandler::_updateContextLocaleSettings (   $request)
protected

Helper function to update locale settings in all installed contexts, based on site locale settings.

Parameters
$requestobject

Definition at line 384 of file AdminLanguageGridHandler.inc.php.

References PKPServices\get(), and Application\getContextDAO().

Referenced by _updateLocaleSupportState(), saveInstallLocale(), and uninstallLocale().

◆ _updateLocaleSupportState()

AdminLanguageGridHandler::_updateLocaleSupportState (   $request,
  $rowId,
  $enable 
)
protected

Update the locale support state (enabled or disabled).

Parameters
$requestRequest
$rowIdstring The locale row id.
$enableboolean Enable locale flag.

Definition at line 351 of file AdminLanguageGridHandler.inc.php.

References _updateContextLocaleSettings(), DAORegistry\getDAO(), GridHandler\getGridDataElements(), and PKPLocale\isLocaleValid().

Referenced by disableLocale(), and enableLocale().

◆ authorize()

AdminLanguageGridHandler::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 45 of file AdminLanguageGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ disableLocale()

AdminLanguageGridHandler::disableLocale (   $args,
  $request 
)

Disable an existing locale.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 279 of file AdminLanguageGridHandler.inc.php.

References _updateLocaleSupportState(), DAO\getDataChangedEvent(), and GridHandler\getGridDataElements().

◆ enableLocale()

AdminLanguageGridHandler::enableLocale (   $args,
  $request 
)

Enable an existing locale.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 255 of file AdminLanguageGridHandler.inc.php.

References _updateLocaleSupportState(), DAO\getDataChangedEvent(), and GridHandler\getGridDataElements().

◆ initialize()

◆ installLocale()

AdminLanguageGridHandler::installLocale (   $args,
  $request 
)

Open a form to select locales for installation.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 176 of file AdminLanguageGridHandler.inc.php.

◆ loadData()

AdminLanguageGridHandler::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 126 of file AdminLanguageGridHandler.inc.php.

References _canManage(), LanguageGridHandler\addManagementData(), PKPLocale\getAllLocales(), and PKPLocale\isLocaleComplete().

◆ saveInstallLocale()

AdminLanguageGridHandler::saveInstallLocale (   $args,
  $request 
)

Save the install language form.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 190 of file AdminLanguageGridHandler.inc.php.

References _updateContextLocaleSettings(), and DAO\getDataChangedEvent().

◆ setPrimaryLocale()

AdminLanguageGridHandler::setPrimaryLocale (   $args,
  $request 
)

Set primary locale.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 312 of file AdminLanguageGridHandler.inc.php.

References DAORegistry\getDAO(), DAO\getDataChangedEvent(), GridHandler\getGridDataElements(), and PKPLocale\isLocaleValid().

◆ uninstallLocale()

AdminLanguageGridHandler::uninstallLocale (   $args,
  $request 
)

Uninstall a locale.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

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

References _updateContextLocaleSettings(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), GridHandler\getGridDataElements(), and PKPLocale\uninstallLocale().


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