Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
DataObjectRequiredPolicy Class Reference
Inheritance diagram for DataObjectRequiredPolicy:
AuthorizationPolicy CopyeditorSubmissionRequiredPolicy SectionEditorSubmissionRequiredPolicy

Public Member Functions

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

Detailed Description

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

Definition at line 17 of file

Member Function Documentation

DataObjectRequiredPolicy::dataObjectEffect ( )

Test the data object's effect


Definition at line 88 of file

Referenced by effect().

DataObjectRequiredPolicy::DataObjectRequiredPolicy ( $request,
  $message = null,
  $operations = null 


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

Definition at line 57 of file

DataObjectRequiredPolicy::effect ( )
& DataObjectRequiredPolicy::getArgs ( )

Return the request arguments


Definition at line 45 of file

DataObjectRequiredPolicy::getDataObjectId ( )

Identifies a submission id in the request.

integer|false returns false if no valid submission id could be found.

Definition at line 97 of file

Referenced by CopyeditorSubmissionRequiredPolicy\effect(), and SectionEditorSubmissionRequiredPolicy\effect().

& DataObjectRequiredPolicy::getRequest ( )

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