Open Journal Systems  3.3.0
APP\Services\ContextService Class Reference
Inheritance diagram for APP\Services\ContextService:
PKP\Services\PKPContextService

Public Member Functions

 __construct ()
 
 afterAddContext ($hookName, $args)
 
 afterDeleteContext ($hookName, $args)
 
 afterEditContext ($hookName, $args)
 
 validateContext ($hookName, $args)
 
- Public Member Functions inherited from PKP\Services\PKPContextService
 add ($context, $request)
 
 delete ($context)
 
 edit ($context, $params, $request)
 
 get ($contextId)
 
 getCount ($args=[])
 
 getFullProperties ($context, $args=null)
 
 getIds ($args=[])
 
 getMany ($args=array())
 
 getManySummary ($args=[])
 
 getMax ($args=array())
 
 getProperties ($context, $props, $args=null)
 
 getQueryBuilder ($args=array())
 
 getSummaryProperties ($context, $args=null)
 
 moveTemporaryFile ($context, $temporaryFile, $fileNameBase, $userId, $localeKey='')
 
 restoreLocaleDefaults ($context, $request, $locale)
 
 validate ($action, $props, $allowedLocales, $primaryLocale)
 

Data Fields

 $contextsFileDirName = 'journals'
 
- Data Fields inherited from PKP\Services\PKPContextService
 $contextsFileDirName
 
 $installFileDirs
 

Additional Inherited Members

- Protected Member Functions inherited from PKP\Services\PKPContextService
 _saveFileParam ($context, $value, $settingName, $userId, $localeKey='', $isImage=false)
 

Detailed Description

Definition at line 17 of file ContextService.inc.php.

Constructor & Destructor Documentation

◆ __construct()

APP\Services\ContextService::__construct ( )

Initialize hooks for extending PKPContextService

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

References Config\getVar(), and HookRegistry\register().

Member Function Documentation

◆ afterAddContext()

APP\Services\ContextService::afterAddContext (   $hookName,
  $args 
)

Take additional actions after a new context has been added

Parameters
$hookNamestring
$argsarray [ @option Journal The new context @option Request ]

Definition at line 47 of file ContextService.inc.php.

References PKPServices\get(), and DAORegistry\getDAO().

◆ afterDeleteContext()

APP\Services\ContextService::afterDeleteContext (   $hookName,
  $args 
)

Take additional actions after a context has been deleted

Parameters
$hookNamestring
$argsarray [ @option Journal The new context @option Request ]

Definition at line 110 of file ContextService.inc.php.

References DAORegistry\getDAO().

◆ afterEditContext()

APP\Services\ContextService::afterEditContext (   $hookName,
  $args 
)

Update journal-specific settings when a context is edited

Parameters
$hookNamestring
$argsarray [ @option Journal The new context @option Journal The current context @option array The params to edit @option Request ]

Definition at line 76 of file ContextService.inc.php.

References PKP\Services\PKPContextService\_saveFileParam().

◆ validateContext()

APP\Services\ContextService::validateContext (   $hookName,
  $args 
)

Make additional validation checks

Parameters
$hookNamestring
$argsarray [ @option Journal The new context @option Request ]

Definition at line 144 of file ContextService.inc.php.

References PKPApplication\get().

Field Documentation

◆ $contextsFileDirName

APP\Services\ContextService::$contextsFileDirName = 'journals'

The file directory where context files are stored. Expects journals or presses.

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


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