LimeSurvey API - Master branch

SurveyAggregateService
in package

Survey Aggregate Service

Service class for updating survey settings.

Dependencies are injected to enable mocking.

Table of Contents

Properties

$generalSettings  : GeneralSettings
$languageSettings  : LanguageSettings
$modelPermission  : Permission
$proxyExpressionManager  : ProxyExpressionManager
$restMode  : mixed
$surveyActivate  : SurveyActivate
$surveyDeactivate  : SurveyDeactivate
$templateConfiguration  : TemplateConfiguration
$urlParams  : UrlParams

Methods

__construct()  : mixed
activate()  : array<string|int, mixed>
Activate
checkSurveySettingsUpdatePermission()  : mixed
deactivate()  : array<string|int, mixed>
Deactivate
expire()  : mixed
Marks a survey as expired
getRestMode()  : mixed
setRestMode()  : mixed
Set REST Mode
update()  : array<string|int, mixed>
Update

Properties

Methods

__construct()

public __construct(LanguageSettings $languageSettings, GeneralSettings $generalSettings, UrlParams $urlParams, ProxyExpressionManager $proxyExpressionManager, TemplateConfiguration $templateConfiguration, Permission $modelPermission, SurveyActivate $surveyActivate, SurveyDeactivate $surveyDeactivate) : mixed
Parameters
$languageSettings : LanguageSettings
$generalSettings : GeneralSettings
$urlParams : UrlParams
$proxyExpressionManager : ProxyExpressionManager
$templateConfiguration : TemplateConfiguration
$modelPermission : Permission
$surveyActivate : SurveyActivate
$surveyDeactivate : SurveyDeactivate

activate()

Activate

public activate(int $surveyId, array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
$surveyId : int
$input : array<string|int, mixed>
Return values
array<string|int, mixed>

checkSurveySettingsUpdatePermission()

public checkSurveySettingsUpdatePermission(mixed $surveyId) : mixed
Parameters
$surveyId : mixed

deactivate()

Deactivate

public deactivate(int $surveyId, array<string|int, mixed> $input) : array<string|int, mixed>
Parameters
$surveyId : int
$input : array<string|int, mixed>
Return values
array<string|int, mixed>

expire()

Marks a survey as expired

public expire(mixed $surveyId) : mixed
Parameters
$surveyId : mixed

setRestMode()

Set REST Mode

public setRestMode(bool $restMode) : mixed

In rest mode we have different expectations about data formats. For example datetime objects inputs/output as UTC JSON format Y-m-d\TH:i:s.000\Z.

Parameters
$restMode : bool

        
On this page

Search results