Open Journal Systems  3.3.0
DataObjectRequiredPolicy Class Reference
Inheritance diagram for DataObjectRequiredPolicy:
AuthorizationPolicy OjsIssueGalleyRequiredPolicy OjsIssueRequiredPolicy PublicationRequiredPolicy QueryRequiredPolicy RepresentationRequiredPolicy ReviewAssignmentRequiredPolicy ReviewRoundRequiredPolicy SubmissionRequiredPolicy

Public Member Functions

 __construct ($request, &$args, $parameterName, $message=null, $operations=null)
 
 dataObjectEffect ()
 
 effect ()
 
getArgs ()
 
 getDataObjectId ($lookOnlyByParameterName=false)
 
getRequest ()
 
- Public Member Functions inherited from AuthorizationPolicy
 __construct ($message=null)
 
 addAuthorizedContextObject ($assocType, &$authorizedObject)
 
 applies ()
 
getAdvice ($adviceType)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
 hasAdvice ($adviceType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAdvice ($adviceType, &$adviceContent)
 
 setAuthorizedContext (&$authorizedContext)
 

Data Fields

 $_args
 
 $_operations
 
 $_parameterName
 
 $_request
 
- Data Fields inherited from AuthorizationPolicy
 $_advice = array()
 
 $_authorizedContext = array()
 

Detailed Description

Abstract base class for policies that check for a data object from a parameter.

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

Constructor & Destructor Documentation

◆ __construct()

DataObjectRequiredPolicy::__construct (   $request,
$args,
  $parameterName,
  $message = null,
  $operations = null 
)

Constructor

Parameters
$requestPKPRequest
$argsarray request parameters
$parameterNamestring the request parameter we expect
$messagestring
$operationsarray Optional list of operations for which this check takes effect. If specified, operations outside this set will not be checked against this policy.

Reimplemented in ReviewAssignmentRequiredPolicy.

Definition at line 69 of file DataObjectRequiredPolicy.inc.php.

Member Function Documentation

◆ dataObjectEffect()

DataObjectRequiredPolicy::dataObjectEffect ( )

◆ effect()

DataObjectRequiredPolicy::effect ( )
See also
AuthorizationPolicy::effect()

Reimplemented from AuthorizationPolicy.

Definition at line 84 of file DataObjectRequiredPolicy.inc.php.

References dataObjectEffect().

◆ getArgs()

& DataObjectRequiredPolicy::getArgs ( )

Return the request arguments

Returns
array

Definition at line 57 of file DataObjectRequiredPolicy.inc.php.

References $_args.

◆ getDataObjectId()

DataObjectRequiredPolicy::getDataObjectId (   $lookOnlyByParameterName = false)

Identifies a data object id in the request.

Parameters
$lookOnlyByParameterNameboolean True iff page router requests should only look for named parameters.
Returns
integer|false returns false if no valid submission id could be found.

Reimplemented in OjsIssueRequiredPolicy.

Definition at line 111 of file DataObjectRequiredPolicy.inc.php.

References $_parameterName.

Referenced by OjsIssueGalleyRequiredPolicy\dataObjectEffect(), RepresentationRequiredPolicy\dataObjectEffect(), QueryRequiredPolicy\dataObjectEffect(), ReviewRoundRequiredPolicy\dataObjectEffect(), PublicationRequiredPolicy\dataObjectEffect(), SubmissionRequiredPolicy\dataObjectEffect(), and ReviewAssignmentRequiredPolicy\dataObjectEffect().

◆ getRequest()

& DataObjectRequiredPolicy::getRequest ( )

Return the request.

Returns
PKPRequest

Definition at line 49 of file DataObjectRequiredPolicy.inc.php.

References $_request.

Field Documentation

◆ $_args

array DataObjectRequiredPolicy::$_args

Definition at line 28 of file DataObjectRequiredPolicy.inc.php.

Referenced by getArgs().

◆ $_operations

array DataObjectRequiredPolicy::$_operations

Definition at line 40 of file DataObjectRequiredPolicy.inc.php.

◆ $_parameterName

string DataObjectRequiredPolicy::$_parameterName

Definition at line 34 of file DataObjectRequiredPolicy.inc.php.

Referenced by getDataObjectId().

◆ $_request

PKPRequest DataObjectRequiredPolicy::$_request

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

Referenced by getRequest().


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