Wadslog

[zend framework][Yaml] Zend_Config_Yamlのようなものを考えてみる２

May 18, 2008

前回に引き続きZend_Config_Yaml.phpのようなものを考えてみました。 Yamlのパーサは前回挙げたPHP拡張モジュール SyckとPHPライブラリのspycに対応しています。 Zend_Config_Iniでは継承を示すトークンに「:(コロン)」を使っていましたが、Yamlで「:」は特別な意味を持っているので[<]を使いました。 実装は以下のようになっています。

< ?php
require\_once 'Zend/Config.php';

class Wads\_Config\_Yaml extends Zend\_Config
{
    /**
     * String that symbol extended section
     */
    protected $\_extendsSection = ';extends';

    /**
     * constructor
     *
     * @param string $filename
     * @param mixed $section
     * @param boolean $allowModifications
     * @throws Zend\_Config\_Exception
     */
    public function \_\_construct($filename, $section = null, $allowModifications = false)
    {
        if (empty($filename)) {
            /\*\* @see Zend\_Config\_Exception \*/
            require\_once 'Zend/Config/Exception.php';
            throw new Zend\_Config\_Exception('Filename is not set');
        }

        $yamlArray = $this->\_parse\_yaml\_file($filename);

        $preProcessedArray = array();
        foreach ($yamlArray as $key => $data)
        {
            $bits = explode('< ', $key);
            $numberOfBits = count($bits);
            $thisSection = trim($bits\[0\]);
            switch (count($bits)) {
                case 1:
                    $preProcessedArray\[$thisSection\] = $data;
                    break;

                case 2:
                    $extendedSection = trim($bits\[1\]);
                    if(!is\_array($data)) {
                        $data = array($data);
                    }
                    $preProcessedArray\[$thisSection\] = array\_merge(array($this->\_extendsSection=>$extendedSection), $data);
                    break;

                default:
                    /\*\* @see Zend\_Config\_Exception \*/
                    require\_once 'Zend/Config/Exception.php';
                    throw new Zend\_Config\_Exception("Section '$thisSection' may not extend multiple sections in $filename");
            }
        }

        if (null === $section) {
            $dataArray = array();
            foreach ($preProcessedArray as $sectionName => $sectionData) {
                $dataArray\[$sectionName\] = $this->\_processExtends($preProcessedArray, $sectionName);
            }
            parent::\_\_construct($dataArray, $allowModifications);
        } elseif (is\_array($section)) {
            $dataArray = array();
            foreach ($section as $sectionName) {
                if (!isset($preProcessedArray\[$sectionName\])) {
                    /\*\* @see Zend\_Config\_Exception \*/
                    require\_once 'Zend/Config/Exception.php';
                    throw new Zend\_Config\_Exception("Section '$sectionName' cannot be found in $filename");
                }
                $dataArray = array\_merge($this->\_processExtends($preProcessedArray, $sectionName), $dataArray);

            }
            parent::\_\_construct($dataArray, $allowModifications);
        } else {
            if (!isset($preProcessedArray\[$section\])) {
                /\*\* @see Zend\_Config\_Exception \*/
                require\_once 'Zend/Config/Exception.php';
                throw new Zend\_Config\_Exception("Section '$section' cannot be found in $filename");
            }
            parent::\_\_construct($this->\_processExtends($preProcessedArray, $section), $allowModifications);
        }

        $this->\_loadedSection = $section;
    }

    /**
     * Loads a YAML file and parse data to PHP array
     *
     * @param string $filename
     * @throws Zend\_Config\_Exception
     * @return array
     */
    protected function \_parse\_yaml\_file($filename)
    {
        if (extension\_loaded('syck') && in\_array('syck\_load', get\_extension\_funcs('syck'))) {
            $yamlArray = syck\_load(file\_get\_contents($filename));
            return $yamlArray;
        } elseif (class\_exists('spyc') && is\_callable(array('Spyc', 'YAMLLoad'))) {
            $yamlArray = Spyc::YAMLLoad($filename);
            return $yamlArray;
        }

        require\_once 'Zend/Config/Exception.php';
        throw new Zend\_Config\_Exception('YAML loader function not found');
    }


    /**
     * Helper function to process each element in the section and handle
     * the "extends" inheritance keyword.
     *
     * @param array $yamlArray
     * @param string $section
     * @param array $config
     * @throws Zend\_Config\_Exception
     * @return array
     */
    protected function \_processExtends($yamlArray, $section, $config = array())
    {
        $thisSection = $yamlArray\[$section\];

        if(!is\_array($thisSection)) {
            return $thisSection;
        }

        foreach ($thisSection as $key => $value) {
            if (strtolower($key) == $this->\_extendsSection) {
                if (isset($yamlArray\[$value\])) {
                    $this->\_assertValidExtend($section, $value);
                    $config = $this->\_processExtends($yamlArray, $value, $config);
                } else {
                    /\*\* @see Zend\_Config\_Exception \*/
                    require\_once 'Zend/Config/Exception.php';
                    throw new Zend\_Config\_Exception("Section '$section' cannot be found");
                }
            } else {
                if(is\_int($key) && array\_key\_exists($key, $config)) {
                    $config\[\] = $value;
                } else {
                    $config\[$key\] = $value;
                }
            }
        }
        return $config;
    }

}

Yamlデータのパースはコンストラクタの_parse_yaml_file()関数で行っています。この関数でSyckもしくはspycの関数を呼び出して処理しています。実はこの関数の実装は書いている途中で見つけたいしなおさんのページのものをそのまま使わせていただきました。 使い方はZend_Config_Xml/Iniと同じです。継承のところは、たとえば以下のようなデータがあったとき

(config.yaml)
extended :
 foo:foo
 bar:bar


extending ＜ extended :
 hoge:hoge
 piyo:piyo
```]

以下のようにできます。

require_once “Zend_Config_Yaml.php”;

$config = new Zend_Config_Yaml("./config.yaml");

echo $config->extending->foo; // foo echo $config->extending->bar; // bar echo $config->extending->hoge; // hoge echo $config->extending->piyo; // piyo


[リストのハッシュ](http://ja.wikipedia.org/wiki/YAML#.E3.83.AA.E3.82.B9.E3.83.88.E3.81.AE.E3.83.8F.E3.83.83.E3.82.B7.E3.83.A5)の形式の場合はちょっと微妙です。

(config.yaml) extended :

  • foo
  • bar

extending ＜ extended :

  • hoge
  • piyo

のようなとき、

require_once “Zend_Config_Yaml.php”;

$config = new Zend_Config_Yaml("./config.yaml");

echo $config->extending->{0}; // foo echo $config->extending->{1}; // bar echo $config->extending->{2}; // hoge echo $config->extending->{3}; // piyo


のようになります。foreachなどでループで処理するだけなら問題ありませんが、インデックスに意味があるような場合は使えません。もしこれでも役に立ちそうであれば、使ってみてください。

**参考URL**

* [Zend\_Config\_Yaml野良版 - いしなお!](http://tdiary.ishinao.net/20070406.html#p02)

**・2008/06/24 追記** クラスのプリフィックスにZend_を使うのはいけないということなので、Zend_の部分をWads_に変更しました。
comments powered by Disqus