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

Public Member Functions

 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 view ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 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)
 
 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 Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

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

Member Function Documentation

◆ authorize()

AnnouncementHandler::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 26 of file AnnouncementHandler.inc.php.

References PKPHandler\addPolicy().

◆ index()

AnnouncementHandler::index (   $args,
  $request 
)

Show public announcements page.

Parameters
$argsarray
$requestPKPRequest
Returns
string

Reimplemented from PKPHandler.

Definition at line 43 of file AnnouncementHandler.inc.php.

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

◆ view()

AnnouncementHandler::view (   $args,
  $request 
)

View announcement details.

Parameters
$argsarray first parameter is the ID of the announcement to display
$requestPKPRequest

Definition at line 72 of file AnnouncementHandler.inc.php.

References Application\getContextAssocType(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), PKPHandler\setupTemplate(), and PKPHandler\validate().


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