Public Member Functions | |
| __construct ($request, $fileIdAndRevision=null) | |
| & | _getCache () |
| getRequest () | |
| getSubmissionFile ($request) | |
 Public Member Functions inherited from AuthorizationPolicy | |
| __construct ($message=null) | |
| addAuthorizedContextObject ($assocType, &$authorizedObject) | |
| applies () | |
| effect () | |
| & | getAdvice ($adviceType) |
| & | getAuthorizedContext () |
| & | getAuthorizedContextObject ($assocType) |
| hasAdvice ($adviceType) | |
| hasAuthorizedContextObject ($assocType) | |
| setAdvice ($adviceType, &$adviceContent) | |
| setAuthorizedContext (&$authorizedContext) | |
Data Fields | |
| $_fileIdAndRevision | |
| $_request | |
| Data Fields inherited from AuthorizationPolicy | |
| $_advice = array() | |
| $_authorizedContext = array() | |
Detailed Description
Abstract class for submission file access policies.
Definition at line 18 of file SubmissionFileBaseAccessPolicy.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| SubmissionFileBaseAccessPolicy::__construct | ( | $request, | |
$fileIdAndRevision = null |
|||
| ) |
Constructor
- Parameters
-
$request PKPRequest $fileIdAndRevision string If passed, this policy will try to get the submission file from this data.
Reimplemented in SubmissionFileMatchesSubmissionPolicy, SubmissionFileAssignedQueryAccessPolicy, SubmissionFileAssignedReviewerAccessPolicy, SubmissionFileRequestedRevisionRequiredPolicy, and SubmissionFileUploaderAccessPolicy.
Definition at line 37 of file SubmissionFileBaseAccessPolicy.inc.php.
Member Function Documentation
◆ _getCache()
| & SubmissionFileBaseAccessPolicy::_getCache | ( | ) |
Get a cache of submission files. Used because many policy subclasses may be combined to fetch a single submission file.
- Returns
- array
Definition at line 52 of file SubmissionFileBaseAccessPolicy.inc.php.
Referenced by getSubmissionFile().
◆ getRequest()
| SubmissionFileBaseAccessPolicy::getRequest | ( | ) |
Get the current request object.
- Returns
- PKPRequest
Definition at line 102 of file SubmissionFileBaseAccessPolicy.inc.php.
References $_request.
Referenced by SubmissionFileAuthorEditorPolicy\effect(), SubmissionFileNotQueryAccessPolicy\effect(), SubmissionFileUploaderAccessPolicy\effect(), SubmissionFileAssignedReviewerAccessPolicy\effect(), SubmissionFileAssignedQueryAccessPolicy\effect(), SubmissionFileMatchesSubmissionPolicy\effect(), SubmissionFileRequestedRevisionRequiredPolicy\effect(), and SubmissionFileStageRequiredPolicy\effect().
◆ getSubmissionFile()
| SubmissionFileBaseAccessPolicy::getSubmissionFile | ( | $request | ) |
Get the requested submission file.
- Parameters
-
$request PKPRequest
- Returns
- SubmissionFile
Definition at line 67 of file SubmissionFileBaseAccessPolicy.inc.php.
References $_fileIdAndRevision, _getCache(), and DAORegistry\getDAO().
Referenced by SubmissionFileAuthorEditorPolicy\effect(), SubmissionFileNotQueryAccessPolicy\effect(), SubmissionFileUploaderAccessPolicy\effect(), SubmissionFileAssignedReviewerAccessPolicy\effect(), SubmissionFileAssignedQueryAccessPolicy\effect(), SubmissionFileMatchesSubmissionPolicy\effect(), SubmissionFileRequestedRevisionRequiredPolicy\effect(), and SubmissionFileStageRequiredPolicy\effect().
Field Documentation
◆ $_fileIdAndRevision
| string SubmissionFileBaseAccessPolicy::$_fileIdAndRevision |
File id and revision, separated with a dash (e.g. 15-1)
Definition at line 29 of file SubmissionFileBaseAccessPolicy.inc.php.
Referenced by getSubmissionFile().
◆ $_request
| PKPRequest SubmissionFileBaseAccessPolicy::$_request |
Definition at line 23 of file SubmissionFileBaseAccessPolicy.inc.php.
Referenced by getRequest().
The documentation for this class was generated from the following file:
