SurveyParser
in package
implements
SurveyParserInterface, ElementParserInterface
Table of Contents
Interfaces
Properties
- $defaultParser : ElementParserInterface
- $parsers : array<string, ElementParserInterface>
- $recursiveParser : ElementParserInterface
Methods
- __construct() : mixed
- parse() : iterable<string|int, VariableInterface|DeferredVariable>
- parseJson() : VariableSetInterface
- parseSurveyStructure() : VariableSetInterface
- setDefaultParser() : void
- Sets the default parser
- setParser() : void
- Sets the parser for a specific question, removes all other registered parser for this question parser.
- getParser() : ElementParserInterface
- parseElement() : iterable<string|int, VariableInterface|DeferredVariable>
- parsePage() : iterable<string|int, VariableInterface|DeferredVariable>
Properties
$defaultParser
private
ElementParserInterface
$defaultParser
$parsers
private
array<string, ElementParserInterface>
$parsers
= []
$recursiveParser
private
ElementParserInterface
$recursiveParser
Methods
__construct()
public
__construct([LocalizerInterface $localizer = new ParserLocalizer() ]) : mixed
Parameters
- $localizer : LocalizerInterface = new ParserLocalizer()
parse()
public
parse(ElementParserInterface $root, array<string|int, mixed> $questionConfig, SurveyConfiguration $surveyConfiguration[, array<string|int, mixed> $dataPrefix = [] ]) : iterable<string|int, VariableInterface|DeferredVariable>
Parameters
- $root : ElementParserInterface
-
This allows an element parser to parse subtypes that it itself doesn't know.
- $questionConfig : array<string|int, mixed>
- $surveyConfiguration : SurveyConfiguration
- $dataPrefix : array<string|int, mixed> = []
Return values
iterable<string|int, VariableInterface|DeferredVariable>parseJson()
public
parseJson(string $json) : VariableSetInterface
Parameters
- $json : string
Return values
VariableSetInterfaceparseSurveyStructure()
public
parseSurveyStructure(array<string|int, mixed> $structure) : VariableSetInterface
Parameters
- $structure : array<string|int, mixed>
Return values
VariableSetInterfacesetDefaultParser()
Sets the default parser
public
setDefaultParser(ElementParserInterface $parser) : void
Parameters
- $parser : ElementParserInterface
setParser()
Sets the parser for a specific question, removes all other registered parser for this question parser.
public
setParser(string $type, ElementParserInterface $parser) : void
Parameters
- $type : string
- $parser : ElementParserInterface
getParser()
private
getParser(string $type) : ElementParserInterface
Parameters
- $type : string
Return values
ElementParserInterfaceparseElement()
private
parseElement(array<string|int, mixed> $config, SurveyConfiguration $surveyConfiguration[, array<int, string> $dataPrefix = [] ]) : iterable<string|int, VariableInterface|DeferredVariable>
Parameters
- $config : array<string|int, mixed>
- $surveyConfiguration : SurveyConfiguration
- $dataPrefix : array<int, string> = []
Return values
iterable<string|int, VariableInterface|DeferredVariable>parsePage()
private
parsePage(array<string|int, mixed> $structure, SurveyConfiguration $surveyConfiguration) : iterable<string|int, VariableInterface|DeferredVariable>
Parameters
- $structure : array<string|int, mixed>
- $surveyConfiguration : SurveyConfiguration