SurveyArchive
in package
implements
CommandInterface
Uses
AuthPermissionTrait
Table of Contents
Interfaces
Properties
- $responseFactory : ResponseFactory
- $session : CHttpSession
- $survey : Survey
- $permissionModel : Permission|null
Methods
- __construct() : mixed
- Constructor
- run() : Response
- Processes the request
- setPermissionModel() : void
- getPermissionModel() : Permission
- hasGlobalPermission() : Response
- hasSurveyPermission() : Response
- processData() : array<string|int, mixed>
- Processes data and returns aggregate summary of the archives
- ensurePermissions() : Response|false
- Ensure Permissions
Properties
$responseFactory
protected
ResponseFactory
$responseFactory
$session
protected
CHttpSession
$session
$survey
protected
Survey
$survey
$permissionModel
private
Permission|null
$permissionModel
= null
Methods
__construct()
Constructor
public
__construct(CHttpSession $session, ResponseFactory $responseFactory, Survey $survey) : mixed
Parameters
- $session : CHttpSession
- $responseFactory : ResponseFactory
- $survey : Survey
run()
Processes the request
public
run(Request $request) : Response
Parameters
- $request : Request
Tags
Return values
ResponsesetPermissionModel()
public
setPermissionModel(Permission $permissionModel) : void
Parameters
- $permissionModel : Permission
getPermissionModel()
protected
getPermissionModel() : Permission
Return values
PermissionhasGlobalPermission()
protected
hasGlobalPermission(string $sPermission, string $sCRUD[, int|null $iUserID = null ]) : Response
Parameters
- $sPermission : string
- $sCRUD : string
- $iUserID : int|null = null
Return values
Response —| boolean
hasSurveyPermission()
protected
hasSurveyPermission(int $iSurveyID, string $sPermission, string $sCRUD[, string|null $iUserID = null ]) : Response
Parameters
- $iSurveyID : int
- $sPermission : string
- $sCRUD : string
- $iUserID : string|null = null
Return values
Response —| boolean
processData()
Processes data and returns aggregate summary of the archives
protected
processData(Survey $survey, array<string|int, mixed> $rawData) : array<string|int, mixed>
Parameters
- $survey : Survey
- $rawData : array<string|int, mixed>
Return values
array<string|int, mixed>ensurePermissions()
Ensure Permissions
private
ensurePermissions(int $surveyId) : Response|false
Parameters
- $surveyId : int