Open Journal Systems  3.3.0
AdminHandler Class Reference
Inheritance diagram for AdminHandler:
Handler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 clearDataCache ($args, $request)
 
 clearScheduledTaskLogFiles ()
 
 clearTemplateCache ($args, $request)
 
 contexts ($args, $request)
 
 downloadScheduledTaskLogFile ()
 
 expireSessions ($args, $request)
 
 index ($args, $request)
 
 initialize ($request)
 
 phpinfo ()
 
 settings ($args, $request)
 
 systemInfo ($args, $request)
 
 wizard ($args, $request)
 
- 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)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_isBackendPage = true
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Additional Inherited Members

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

Detailed Description

Handle requests for site administration functions.

Definition at line 18 of file AdminHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

AdminHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

AdminHandler::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 PKPHandler.

Definition at line 50 of file AdminHandler.inc.php.

References PKPHandler\addPolicy().

◆ clearDataCache()

AdminHandler::clearDataCache (   $args,
  $request 
)

Clear the data cache.

Parameters
$argsarray
$requestPKPRequest

Definition at line 387 of file AdminHandler.inc.php.

References DAORegistry\getDAO(), and CacheManager\getManager().

◆ clearScheduledTaskLogFiles()

AdminHandler::clearScheduledTaskLogFiles ( )

Clear scheduled tasks execution logs.

Definition at line 413 of file AdminHandler.inc.php.

References ScheduledTaskHelper\clearExecutionLogs(), and PKPApplication\get().

◆ clearTemplateCache()

AdminHandler::clearTemplateCache (   $args,
  $request 
)

Clear compiled templates.

Parameters
$argsarray
$requestPKPRequest

Definition at line 375 of file AdminHandler.inc.php.

References PKPTemplateManager\getManager().

◆ contexts()

AdminHandler::contexts (   $args,
  $request 
)

Display a list of the contexts hosted on the site.

Parameters
$argsarray
$requestPKPRequest

Definition at line 128 of file AdminHandler.inc.php.

References PKPTemplateManager\getManager(), and PKPHandler\setupTemplate().

◆ downloadScheduledTaskLogFile()

AdminHandler::downloadScheduledTaskLogFile ( )

Download scheduled task execution log file.

Definition at line 402 of file AdminHandler.inc.php.

References ScheduledTaskHelper\downloadExecutionLog(), and PKPApplication\get().

◆ expireSessions()

AdminHandler::expireSessions (   $args,
  $request 
)

Expire all user sessions (will log out all users currently logged in).

Parameters
$argsarray
$requestPKPRequest

Definition at line 364 of file AdminHandler.inc.php.

References DAORegistry\getDAO().

◆ index()

AdminHandler::index (   $args,
  $request 
)

Display site admin index page.

Parameters
$argsarray
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 114 of file AdminHandler.inc.php.

References PKPTemplateManager\getManager(), and PKPHandler\setupTemplate().

◆ initialize()

AdminHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 66 of file AdminHandler.inc.php.

References VersionCheck\checkIfNewVersionExists(), VersionCheck\getCurrentDBVersion(), PKPTemplateManager\getManager(), Config\getVar(), and AppLocale\requireComponents().

◆ phpinfo()

AdminHandler::phpinfo ( )

Show full PHP configuration information.

Definition at line 355 of file AdminHandler.inc.php.

◆ settings()

AdminHandler::settings (   $args,
  $request 
)

Display the administration settings page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 148 of file AdminHandler.inc.php.

References PKPLocale\getAllLocales(), PKPTemplateManager\getManager(), and PKPHandler\setupTemplate().

◆ systemInfo()

AdminHandler::systemInfo (   $args,
  $request 
)

◆ wizard()

AdminHandler::wizard (   $args,
  $request 
)

Display a settings wizard for a journal

Parameters
$argsarray
$requestPKPRequest

Definition at line 241 of file AdminHandler.inc.php.

References PKPServices\get(), PKPLocale\getAllLocales(), PKPTemplateManager\getManager(), and PKPHandler\setupTemplate().

Field Documentation

◆ $_isBackendPage

AdminHandler::$_isBackendPage = true

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


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