Spec-Zone.ru › Symfony 2.8

Встроенный

класс Встроенный

Встроенный реализует парсер/думпер YAML для синтаксиса YAML встроенного типа.

Константы

REGEX_QUOTED_STRING

Методы

static mixed parse(string $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false, array $references = array())

Преобразует строку YAML в значение PHP.

static string dump(mixed $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false)

Преобразует данную переменную PHP в строку YAML.

static bool isHash(array $value)

Проверка, является ли заданный массив хэш-массивом или просто обычным индексированным массивом.

static string parseScalar(string $scalar, string[] $delimiters = null, string[] $stringDelimiters = array('"', '\''), int $i, bool $evaluate = true, array $references = array())

Парсит скаляр YAML.

Детали

static mixed parse(string $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false, bool $objectForMap = false, array $references = array())

Преобразует строку YAML в значение PHP.

Параметры

string $value Строка YAML
bool $exceptionOnInvalidType true, если необходимо генерировать исключение при неверных типах (ресурс PHP или объект), иначе false
bool $objectSupport true, если поддержка объектов включена, иначе false
bool $objectForMap true, если карты должны возвращать stdClass вместо array()
array $references Сопоставление имён переменных со значениями

Возвращаемое значение

mixed Значение PHP

Исключения

ParseException

static string dump(mixed $value, bool $exceptionOnInvalidType = false, bool $objectSupport = false)

Преобразует данную переменную PHP в строку YAML.

Параметры

mixed $value Переменная PHP для преобразования
bool $exceptionOnInvalidType true, если необходимо генерировать исключение при неверных типах (ресурс PHP или объект), иначе false
bool $objectSupport true, если поддержка объектов включена, иначе false

Возвращаемое значение

string Строка YAML, представляющая значение PHP

Исключения

DumpException При попытке преобразования ресурса PHP

static bool isHash(array $value)

Проверка, является ли заданный массив хэш-массивом или просто обычным индексированным массивом.

Параметры

array $value Массив PHP для проверки

Возвращаемое значение

bool true, если значение является хэш-массивом, иначе false

static string parseScalar(string $scalar, string[] $delimiters = null, string[] $stringDelimiters = array('"', '\''), int $i, bool $evaluate = true, array $references = array())

Парсит скаляр YAML.

Параметры

string $scalar
string[] $delimiters
string[] $stringDelimiters
int $i &$i
bool $evaluate
array $references

Возвращаемое значение

string

Исключения

ParseException При парсинге некорректной строки YAML встроенного типа

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Yaml/Inline.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API