OmpPublishedSubmissionRequiredPolicy Class Reference

Inheritance diagram for OmpPublishedSubmissionRequiredPolicy:

Public Member Functions
	__construct ($request, &$args, $submissionParameterName='submissionId', $operations=null)
	dataObjectEffect ()
	getDataObjectId ($lookOnlyByParameterName=false)
Public Member Functions inherited from DataObjectRequiredPolicy
	__construct ($request, &$args, $parameterName, $message=null, $operations=null)
	effect ()
&	getArgs ()
&	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
	$context
Data Fields inherited from DataObjectRequiredPolicy
	$_args
	$_operations
	$_parameterName
	$_request
Data Fields inherited from AuthorizationPolicy
	$_advice = array()
	$_authorizedContext = array()

Detailed Description

Policy that ensures that the request contains a valid published submission.

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

Constructor & Destructor Documentation

__construct()

OmpPublishedSubmissionRequiredPolicy::__construct	(		$request,
		&	$args,
			$submissionParameterName = 'submissionId',
			$operations = null
	)

Constructor

Parameters

$request	PKPRequest
$args	array request parameters
$submissionParameterName	string the request parameter we expect the submission id in.
$operations	array

Definition at line 32 of file OmpPublishedSubmissionRequiredPolicy.inc.php.

Member Function Documentation

dataObjectEffect()

OmpPublishedSubmissionRequiredPolicy::dataObjectEffect

(

)

See also

DataObjectRequiredPolicy::dataObjectEffect()

Reimplemented from DataObjectRequiredPolicy.

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

References AuthorizationPolicy\addAuthorizedContextObject(), PKPServices\get(), and getDataObjectId().

getDataObjectId()

OmpPublishedSubmissionRequiredPolicy::getDataObjectId

(

$lookOnlyByParameterName = false

)

Identifies a data object id in the request.

Parameters

$lookOnlyByParameterName

boolean True iff page router requests should only look for named parameters.

Returns

integer|false returns false if no valid submission id could be found. Considers a not numeric public URL identifier

Reimplemented from DataObjectRequiredPolicy.

Definition at line 63 of file OmpPublishedSubmissionRequiredPolicy.inc.php.

Referenced by dataObjectEffect().

Field Documentation

$context

Context OmpPublishedSubmissionRequiredPolicy::$context

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

---

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

• OmpPublishedSubmissionRequiredPolicy.inc.php