LimeSurvey API - Master branch

OpHandlerQuestionAttributeUpdate
in package
implements OpHandlerInterface Uses OpHandlerSurveyTrait, OpHandlerValidationTrait, OpHandlerExceptionTrait

Table of Contents

Interfaces

OpHandlerInterface

Properties

$attributesService  : AttributesService
$entity  : string
$questionAggregateService  : QuestionAggregateService
$questionService  : QuestionService
$transformer  : TransformerInputQuestionAttribute

Methods

__construct()  : mixed
addErrorToValidationData()  : array<string|int, mixed>
Adds the error message to the validationData array
canHandle()  : bool
extractTempId()  : int|mixed
returns and removes tempId from dataset
getSurveyIdFromContext()  : int
Extracts and returns surveyId from context
getValidationReturn()  : array<string|int, mixed>|array<string|int, array<string|int, ValidationErrorItem>>
handle()  : void
Updates multiple attributes for a single question. Format is exactly the same as in Question create, so they share the prepare function.
validateCollection()  : array<string|int, mixed>
checks incoming props if it's a collection otherwise adds error to validationData.
validateCollectionIndex()  : array<string|int, mixed>
validates for collection first and then checks the indexes to be numeric or alphabetic dependent on the alphabetic flag
validateEntityId()  : array<string|int, mixed>
checks for entity id being there, otherwise adds error to validationData
validateOperation()  : array<string|int, mixed>
Checks if patch is valid for this operation.
throwNoValuesException()  : void

Properties

Methods

addErrorToValidationData()

Adds the error message to the validationData array

public addErrorToValidationData(string $error, array<string|int, mixed> $validationData) : array<string|int, mixed>
Parameters
$error : string
$validationData : array<string|int, mixed>
Return values
array<string|int, mixed>

extractTempId()

returns and removes tempId from dataset

public extractTempId(array<string|int, mixed> &$dataSet) : int|mixed
Parameters
$dataSet : array<string|int, mixed>
Return values
int|mixed

handle()

Updates multiple attributes for a single question. Format is exactly the same as in Question create, so they share the prepare function.

public handle(OpInterface $op) : void

patch structure: { "patch": [{ "entity": "questionAttribute", "op": "update", "id": 809, "props": { "dualscale_headerA": { "de": "A ger", "en": "A" }, "dualscale_headerB": { "de": "B ger", "en": "B" }, "public_statistics": { "": "1" } } } ] }

Parameters
$op : OpInterface
Tags
throws
OpHandlerException
throws
PersistErrorException

validateCollection()

checks incoming props if it's a collection otherwise adds error to validationData.

public validateCollection(OpInterface $op, array<string|int, mixed> $validationData) : array<string|int, mixed>

Basically this only check for the incoming props being a multidimensional array.

Parameters
$op : OpInterface
$validationData : array<string|int, mixed>
Return values
array<string|int, mixed>

validateCollectionIndex()

validates for collection first and then checks the indexes to be numeric or alphabetic dependent on the alphabetic flag

public validateCollectionIndex(OpInterface $op, array<string|int, mixed> $validationData[, bool $alphabetic = true ]) : array<string|int, mixed>
Parameters
$op : OpInterface
$validationData : array<string|int, mixed>
$alphabetic : bool = true
Return values
array<string|int, mixed>

validateEntityId()

checks for entity id being there, otherwise adds error to validationData

public validateEntityId(OpInterface $op, array<string|int, mixed> $validationData) : array<string|int, mixed>
Parameters
$op : OpInterface
$validationData : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results