Caution: You are browsing the legacy symfony 1.x part of this website.

YAMLフォーマット

Symfony version
Language

symfonyフレームワーク内のほとんどの設定ファイルはYAMLフォーマットです。 YAMLの公式サイトによれば、YAMLは"すべてのプログラミング言語用に人間にとっての可読性に最適化された標準となるデータシリアライゼーション"です。

YAMLはデータを記述するシンプルな言語です。PHPのように、文字列、ブール型、浮動小数点、整数のようなシンプルなデータ型のための構文を持ちます。 しかしPHPとは異なり、配列(シーケンス)とハッシュ(マッピング)のあいだに違いがあります。

YAMLフォーマットは複雑なネストしたデータ構造を記述することもできますが、この章ではYAMLをsymfonyの設定ファイルとして使うために必要である最小限の内容のみを説明します。

スカラー

スカラー用の構文はPHP構文と似ています。

文字列

A string in YAML
'A singled-quoted string in YAML'

tip

シングルクォートで囲まれた文字列では、シングルクォートの'は2つ重ねなければなりません:

'A single quote '' in a single-quoted string'
"A double-quoted string in YAML\n"

文字列が1つ以上の適切なスペースで始まるもしくは終わるときにクォートスタイル(引用符で囲む方法)は便利です。

tip

ダブルクォートスタイルは\エスケープシーケンスを使用して任意の文字列を表現する方法も提供します。 文字列に\nもしくはUnicodeを埋め込むことが必要なときにとても便利です。

文字列が改行を含むとき、パイプ(|)によって示されるリテラルスタイルを使うことができます。 これは複数行にわたる文字列を示します。 リテラルでは、改行は維持されます:

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

代わりの方法として、文字列を>で示される折りたたみスタイルで書くことができます。 それぞれの改行はスペースに置き換えられます:

>
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  without carriage returns.

note

上記の例ではそれぞれの行の前にある2つのスペースに注目してください。 これらは出力結果のPHP文字列には現れません。

数字

# an integer
12
# an octal
014
# an hexadecimal
0xC
# a float
13.4
# an exponential number
1.2e+34
# infinity
.inf

null

YAMLでのnullはnullもしくはチルダ(~)で表現されます。

ブール型

YAMLでのブール型はtrueとfalseで表現されます。

note

Symfony YAMLパーサーはon、off、yesとnoも認識しますがYAML 1.2の仕様から除外されているのでこれらは非推奨です。

日付

YAMLは日付の表現にISO-8601標準を使います:

2001-12-14t21:59:43.10-05:00
# simple date
2002-12-14

コレクション

シンプルなスカラーを記述するためにYAMLファイルが使われることはめったにありません。 たいていの場合、コレクションを記述することになります。 コレクションは要素のシーケンスもしくはマッピングになります。 シーケンスとマッピングは両方ともPHP配列に変換されます。

シーケンスはダッシュ(-)の直後にスペースを使います:

- PHP
- Perl
- Python

上記のYAMLファイルは次のPHPコードと同等です:

array('PHP', 'Perl', 'Python');

それぞれのキー/値の組を記すためにマッピングはコロン(:)とスペースを使います:

PHP: 5.2
MySQL: 5.1
Apache: 2.2.20

上記のコードは次のPHPコードと同等です:

array('PHP' => 5.2, 'MySQL' => 5.1, 'Apache' => '2.2.20');

note

マッピングにおいて、キーは有効なYAMLスカラーになります。

少なくともスペースが1つ入っていれば、コロンと値のあいだのスペースの数は問題ありません:

PHP:    5.2
MySQL:  5.1
Apache: 2.2.20

ネストしたコレクションを記述するためにYAMLは1つもしくは複数のスペースによるインデントを使います:

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

上記のYAMLは次のPHPコードと同等です:

array(
  'symfony 1.0' => array(
    'PHP'    => 5.0,
    'Propel' => 1.2,
  ),
  'symfony 1.2' => array(
    'PHP'    => 5.2,
    'Propel' => 1.3,
  ),
);

YAMLファイルでインデントを使うときに覚えておくことが1つあります: インデントは1つか複数のスペースで行い、タブを使ってはなりません。

次のようにシーケンスとマッピングをネストできます:

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

スコープを表現するためにインデントよりも明示的なインジケーターを使って、YAMLはコレクション用にフロースタイルを使うこともできます。

シーケンスは角かっこ([])の範囲内のカンマで区切られたリストとして記述できます:

[PHP, Perl, Python]

マッピングは波かっこ({})の範囲内のカンマで区切られたキー/値として記述されます:

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

より見やすくするためにスタイルを混ぜることができます:

'Chapter 1': [Introduction, Event Types]
'Chapter 2': [Introduction, Helpers]
"symfony 1.0": { PHP: 5.0, Propel: 1.2 }
"symfony 1.2": { PHP: 5.2, Propel: 1.3 }

コメント

コメントの先頭にハッシュ記号(#)をつけることでYAMLにコメントを追加できます:

# Comment on a line
"symfony 1.0": { PHP: 5.0, Propel: 1.2 } # Comment at the end of a line
"symfony 1.2": { PHP: 5.2, Propel: 1.3 }

note

コメントはYAMLパーサーによって無視されコレクションのネストの現在のレベルにしたがってインデントされます。

動的なYAMLファイル

symfonyにおいて、解析直前に評価されるYAMLファイルにPHPコードを含めることができます:

1.0:
  version: <?php echo file_get_contents('1.0/VERSION')."\n" ?>
1.1:
  version: "<?php echo file_get_contents('1.1/VERSION') ?>"

インデントで散らからないように気をつけてください。 YAMLファイルにPHPコードを追加するとき次のシンプルなティップスを思い出してください:

  • <?php ?>ステートメントは行で始めるもしくは値に埋め込まなければなりません。

  • <?php ?>ステートメントが1行で終わるとき、改行("\n")を明示的に出力する必要があります。

すべての例

次の例はこのドキュメントで説明したほとんどのYAML表記を記述しています:

"symfony 1.0":
  end_of_maintainance: 2010-01-01
  is_stable:           true
  release_manager:     "Grégoire Hubert"
  description: >
    This stable version is the right choice for projects
    that need to be maintained for a long period of time.
  latest_beta:         ~
  latest_minor:        1.0.20
  supported_orms:      [Propel]
  archives:            { source: [zip, tgz], sandbox: [zip, tgz] }
 
"symfony 1.2":
  end_of_maintainance: 2008-11-01
  is_stable:           true
  release_manager:     'Fabian Lange'
  description: >
    This stable version is the right choice
    if you start a new project today.
  latest_beta:         null
  latest_minor:        1.2.5
  supported_orms:
    - Propel
    - Doctrine
  archives:
    source:
      - zip
      - tgz
    sandbox:
      - zip
      - tgz

This work is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License license.