SurveyDeactivate
in package
Table of Contents
Properties
- $siddates : array<string|int, mixed>
- $app : LSYii_Application
- $archivedResponseSettings : ArchivedTableSettings
- $archivedTimingsSettings : ArchivedTableSettings
- $archivedTokenSettings : ArchivedTableSettings
- $permission : Permission
- $savedControl : SavedControl
- $survey : Survey
- $surveyDeactivator : SurveyDeactivator
- $surveyLink : SurveyLink
Methods
- __construct() : mixed
- deactivate() : array<string|int, mixed>
- expire() : void
- Marks a survey as expired
- setArchivedResponseSettings() : mixed
- setArchivedTimingsSettings() : mixed
- setArchivedTokenSettings() : mixed
- archiveTable() : void
- Archives a table
- archiveToken() : void
- Archives token table
- getSiddate() : string
- Gets a string of the form of <sid>_<timestamp>
- handleSurveyTable() : void
- Handles survey table
- handleTimingTable() : void
- Handles survey table
Properties
$siddates
protected
array<string|int, mixed>
$siddates
$app
private
LSYii_Application
$app
$archivedResponseSettings
private
ArchivedTableSettings
$archivedResponseSettings
Tags
$archivedTimingsSettings
private
ArchivedTableSettings
$archivedTimingsSettings
Tags
$archivedTokenSettings
private
ArchivedTableSettings
$archivedTokenSettings
Tags
$permission
private
Permission
$permission
$savedControl
private
SavedControl
$savedControl
$survey
private
Survey
$survey
$surveyDeactivator
private
SurveyDeactivator
$surveyDeactivator
$surveyLink
private
SurveyLink
$surveyLink
Methods
__construct()
public
__construct(Survey $survey, Permission $permission, SurveyDeactivator $surveyDeactivator, LSYii_Application $app, SurveyLink $surveyLink, SavedControl $savedControl) : mixed
Parameters
- $survey : Survey
- $permission : Permission
- $surveyDeactivator : SurveyDeactivator
- $app : LSYii_Application
- $surveyLink : SurveyLink
- $savedControl : SavedControl
deactivate()
public
deactivate(int $iSurveyID[, array<string|int, mixed> $params = [] ][, bool $force = false ]) : array<string|int, mixed>
Parameters
- $iSurveyID : int
- $params : array<string|int, mixed> = []
- $force : bool = false
Tags
Return values
array<string|int, mixed>expire()
Marks a survey as expired
public
expire(int $iSurveyID) : void
Parameters
- $iSurveyID : int
Tags
setArchivedResponseSettings()
public
setArchivedResponseSettings(ArchivedTableSettings $archivedResponseSettings) : mixed
Parameters
- $archivedResponseSettings : ArchivedTableSettings
setArchivedTimingsSettings()
public
setArchivedTimingsSettings(ArchivedTableSettings $archivedTimingsSettings) : mixed
Parameters
- $archivedTimingsSettings : ArchivedTableSettings
setArchivedTokenSettings()
public
setArchivedTokenSettings(ArchivedTableSettings $archivedTokenSettings) : mixed
Parameters
- $archivedTokenSettings : ArchivedTableSettings
archiveTable()
Archives a table
protected
archiveTable(int $iSurveyID, int $userID, string $tableName, string $tableType, string $DBDate, string $properties[, string $attributes = null ]) : void
Parameters
- $iSurveyID : int
- $userID : int
- $tableName : string
- $tableType : string
- $DBDate : string
- $properties : string
- $attributes : string = null
-
JSON encoded attributes
Tags
archiveToken()
Archives token table
protected
archiveToken(int $iSurveyID, string $date, int $userID, string $DBDate, array<string|int, mixed> &$aData) : void
Parameters
- $iSurveyID : int
- $date : string
- $userID : int
- $DBDate : string
- $aData : array<string|int, mixed>
getSiddate()
Gets a string of the form of <sid>_<timestamp>
protected
getSiddate(int $iSurveyID) : string
Parameters
- $iSurveyID : int
Return values
stringhandleSurveyTable()
Handles survey table
protected
handleSurveyTable(int $iSurveyID, string $date, array<string|int, mixed> &$aData, int $userID, string $DBDate) : void
Parameters
- $iSurveyID : int
- $date : string
- $aData : array<string|int, mixed>
- $userID : int
- $DBDate : string
handleTimingTable()
Handles survey table
protected
handleTimingTable(int $iSurveyID, string $date, array<string|int, mixed> &$aData, int $userID, string $DBDate) : void
Parameters
- $iSurveyID : int
- $date : string
- $aData : array<string|int, mixed>
- $userID : int
- $DBDate : string