Parser
Parser
class Parser
Parser parses YAML strings to convert them to PHP arrays.
Constants
BLOCK_SCALAR_HEADER_PATTERN | |
FOLDED_SCALAR_PATTERN |
Methods
__construct(int $offset, int|null $totalNumberOfLines = null, array $skippedLineNumbers = array()) Constructor. | ||
mixed | parse(string $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false) Parses a YAML string to a PHP value. | |
static | preg_match($pattern, $subject, $matches = null, $flags, $offset) A local wrapper for |
Details
__construct(int $offset, int|null $totalNumberOfLines = null, array $skippedLineNumbers = array())
Constructor.
Parameters
int | $offset | The offset of YAML document (used for line numbers in error messages) |
int|null | $totalNumberOfLines | The overall number of lines being parsed |
array | $skippedLineNumbers | Number of comment lines that have been skipped by the parser |
mixed parse(string $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false)
Parses a YAML string to a PHP value.
Parameters
string | $value | A YAML string |
bool | $exceptionOnInvalidType | true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise |
bool | $objectSupport | true if object support is enabled, false otherwise |
bool | $objectForMap | true if maps should return a stdClass instead of array() |
Return Value
mixed | A PHP value |
Exceptions
ParseException | If the YAML is not valid |
static preg_match($pattern, $subject, $matches = null, $flags, $offset)
A local wrapper for preg_match
which will throw a ParseException if there is an internal error in the PCRE engine.
This avoids us needing to check for "false" every time PCRE is used in the YAML engine
Parameters
$pattern | ||
$subject | ||
$matches | ||
$flags | ||
$offset |
Exceptions
ParseException | on a PCRE internal error |
See also
preg_last_error() |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Yaml/Parser.html