Скаляры

Синтаксис скаляров аналогичен синтаксису PHP.

1
2
3
4
5

Строка в YAML

'Строка в YAML с одинарными кавычками'

" Строка в YAML с двойными кавычками"

1

'Одинарные кавычку '' внутри строки с одинарными кавычками'

1

"Строка с двойными кавычками в YAML\n"

1
2
3

|
  \/ /| |\/| |
  / / | |  | |__

1
2
3
4
5
6
7
8
9
10

>
  Это очень длинное предложение
  которое занимает несколько строк в YAML.

# Это будет проанализировано следующим образом: (обратите внимание на \n)
# "Это очень длинное предложение, которое занимает несколько строк в YAML.\n"

>-
  Это очень длинное предложение
  которое занимает несколько строк в YAML.

1
2

# целое число
12

1
2

# восьмеричное число
0o14

1
2

# шестнадцатиричное число
0xC

1
2

# плавающее число
13.4

1
2

# экспоненциальное число
1.2e+34

1
2

# бесконечность
.inf

1

2001-12-14T21:59:43.10-05:00

1
2

# simple date
2002-12-14

Коллекции

YAML-файл редко используется для описания простого скаляра. Чаще всего он описывает коллекцию. Коллекции YAML могут быть последовательностью (индексированные массивы в PHP) или отображением элементов (ассоциативные массивы в PHP).

В последовательностях используется тире, за которым следует пробел:

1
2
3

- PHP
- Perl
- Python

Предыдущий YAML-файл эквивалентен следующему PHP-коду:

1

['PHP', 'Perl', 'Python'];

В сопоставлениях для обозначения каждой пары ключ/значение используется двоеточие, за которым следует пробел (:):

1
2
3

PHP: 5.2
MySQL: 5.1
Apache: 2.2.20

что эквивалентно этому PHP-коду:

1

['PHP' => 5.2, 'MySQL' => 5.1, 'Apache' => '2.2.20'];

Количество пробелов между двоеточием и значением не имеет значения:

1
2
3

PHP:    5.2
MySQL:  5.1
Apache: 2.2.20

В YAML используются отступы с одним или несколькими пробелами для описания вложенных коллекций:

1
2
3
4
5
6

'symfony 1.0':
  PHP:    5.0
  Propel: 1.2
'symfony 1.2':
  PHP:    5.2
  Propel: 1.3

Приведенный выше YAML эквивалентен следующему PHP-коду:

1
2
3
4
5
6
7
8
9
10

[
    'symfony 1.0' => [
        'PHP'    => 5.0,
        'Propel' => 1.2,
    ],
    'symfony 1.2' => [
        'PHP'    => 5.2,
        'Propel' => 1.3,
    ],
];

Есть одна важная вещь, которую нужно помнить при использовании отступов в YAML-файле: Отступы должны быть сделаны с помощью одного или нескольких пробелов, но никогда с помощью табуляции.

Вы можете вложить последовательности и сопоставления как угодно:

1
2
3
4
5
6

'Chapter 1':
  - Introduction
  - Event Types
'Chapter 2':
  - Introduction
  - Helpers

YAML также может использовать стили потока для коллекций, используя явные индикаторы, а не отступы для обозначения области видимости.

Последовательность может быть записана в виде списка, разделенного запятыми и заключенного в квадратные скобки ([]):

1

[PHP, Perl, Python]

Отображение может быть записано в виде списка ключей/значений, разделенных запятыми и заключенных в фигурные скобки ({}):

1

{ PHP: 5.2, MySQL: 5.1, Apache: 2.2.20 }

Вы можете смешивать и сочетать стили, чтобы добиться лучшей читабельности:

1
2

'Chapter 1': [Introduction, Event Types]
'Chapter 2': [Introduction, Helpers]

1
2

'symfony 1.0': { PHP: 5.0, Propel: 1.2 }
'symfony 1.2': { PHP: 5.2, Propel: 1.3 }

Комментарии

Комментарии можно добавлять в YAML, добавляя к ним префикс в виде хеш-знака (#):

1
2
3

# Comment on a line
"symfony 1.0": { PHP: 5.0, Propel: 1.2 } # Прокомментировать в конце строки
"symfony 1.2": { PHP: 5.2, Propel: 1.3 }

Явная типизация

Спецификация YAML определяет некоторые теги для явного задания типа любых данных:

1
2
3
4
5
6
7
8
9
10
11
12
13

data:
    # это значение анализируется как строка (не преобразуется в DateTime)
    start_date: !!str 2002-12-14

    # это значение анализируется как плавающее число (будет 3.0 вместо 3)
    price: !!float 3

    # это значение анализируется как бинарные данные, зашифрованные в base64
    picture: !!binary |
        R0lGODlhDAAMAIQAAP//9/X
        17unp5WZmZgAAAOfn515eXv
        Pz7Y6OjuDg4J+fn5OTk6enp
        56enmleECcgggoBADs=

Сепциальные функции Symfony

Компонент Yaml предоставляет некоторые дополнительные функции, которые не являются частью официальной спецификации YAML, но полезны в приложениях Symfony:

• !php/const позволяет получить значение PHP-константы. Этот тег принимает полное имя класса константы в качестве аргумента:

  1
  2

  data:
      page_limit: !php/const App\Pagination\Paginator::PAGE_LIMIT

• !php/object позволяет передать сериализованное представление PHP-объекта (созданного с помощью функции serialize()), который будет десериализован при анализе YAML-файла:

  1
  2

  data:
      my_object: !php/object 'O:8:"stdClass":1:{s:3:"bar";i:2;}'

• !php/enum позволяет использовать регистр PHP enum. Этот тег принимает имя класса регистра исчисления в качестве аргумента:

  1
  2
  3
  4
  5

  data:
      # Вы можете использовать типизированный случай enum...
      operator_type: !php/enum App\Operator\Enum\Type::Or
      # ... или вы также можете использовать "->value" напрямую, используя значение случая BackedEnum
      operator_type: !php/enum App\Operator\Enum\Type::Or->value

  Этот тег позволяет опустить случай исчисления и предоставить только исчисление FQCN, чтобы вернуть массив всех доступных исчислений:

  1
  2

  data:
      operator_types: !php/enum App\Operator\Enum\Type

  7.1

  Поддержка использования исчисления FQCN без указания случая была введена в Symfony 7.

Неподдерживаемые функци YAML

Компонент Symfony Yaml не поддерживает следующие функции YAML:

• Мультидокументы (маркеры --- и ...);
• Сложные ключи отображения и сложные значения, начинающиеся с ?;
• Тегированные значения в качестве ключей;
• Следующие теги и типы: !!set, !!omap, !!pairs, !!seq, !!bool, !!int, !!merge, !!null, !!timestamp, !!value, !!yaml;
• Теги (директива TAG; пример: %TAG ! tag:example.com,2000:app/) и ссылки на теги (пример: !<tag:example.com,2000:app/foo>);
• Использование синтаксиса, похожего на последовательность, для отображения элементов (пример: {foo, bar}; используйте {foo: ~, bar: ~} вместо этого).