Open Journal Systems  3.3.0
PKPAnnouncementHandler Class Reference
Inheritance diagram for PKPAnnouncementHandler:
APIHandler PKPHandler

Public Member Functions

 __construct ()
 
 add ($slimRequest, $response, $args)
 
 authorize ($request, &$args, $roleAssignments)
 
 delete ($slimRequest, $response, $args)
 
 edit ($slimRequest, $response, $args)
 
 get ($slimRequest, $response, $args)
 
 getMany ($slimRequest, $response, $args)
 
- Public Member Functions inherited from APIHandler
 convertStringsToSchema ($schema, $params)
 
 getApp ()
 
 getEndpointPattern ()
 
 getEndpoints ()
 
 getEntityId ($parameterName)
 
 getParameter ($parameterName, $default=null)
 
 getRequest ()
 
 getSlimRequest ()
 
 setSlimRequest ($slimRequest)
 
 setupEndpoints ()
 
- 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)
 

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 PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Member Functions inherited from APIHandler
 _validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd')
 
- Protected Attributes inherited from APIHandler
 $_app
 
 $_endpoints = array()
 
 $_handlerPath = null
 
 $_pathPattern
 
 $_request
 
 $_slimRequest = null
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle API requests for announcement operations.

Handle requests for public announcement functions.

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

Constructor & Destructor Documentation

◆ __construct()

PKPAnnouncementHandler::__construct ( )

Constructor

Reimplemented from APIHandler.

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

References APIHandler\getEndpointPattern().

Member Function Documentation

◆ add()

PKPAnnouncementHandler::add (   $slimRequest,
  $response,
  $args 
)

Add an announcement

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 181 of file PKPAnnouncementHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), PKPApplication\get(), and APIHandler\getRequest().

◆ authorize()

PKPAnnouncementHandler::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 68 of file PKPAnnouncementHandler.inc.php.

References PKPHandler\addPolicy().

◆ delete()

PKPAnnouncementHandler::delete (   $slimRequest,
  $response,
  $args 
)

Delete an announcement

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 267 of file PKPAnnouncementHandler.inc.php.

References PKPServices\get(), PKPApplication\get(), and APIHandler\getRequest().

◆ edit()

PKPAnnouncementHandler::edit (   $slimRequest,
  $response,
  $args 
)

Edit an announcement

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 219 of file PKPAnnouncementHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), PKPApplication\get(), and APIHandler\getRequest().

◆ get()

PKPAnnouncementHandler::get (   $slimRequest,
  $response,
  $args 
)

Get a single submission

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 88 of file PKPAnnouncementHandler.inc.php.

References PKPServices\get(), and APIHandler\getRequest().

◆ getMany()

PKPAnnouncementHandler::getMany (   $slimRequest,
  $response,
  $args 
)

Get a collection of announcements

Parameters
$slimRequestRequest Slim request object
$responseResponse object
array$argsarguments
Returns
Response

Definition at line 119 of file PKPAnnouncementHandler.inc.php.

References HookRegistry\call(), PKPServices\get(), PKPApplication\get(), and APIHandler\getRequest().


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