如何从Symfony2中的服务中解析yaml文件

时间:2012-01-10 17:19:51

标签: symfony yaml

我想从我的一个服务中的yaml文件中获取一个数组,我对如何注入要在services.yml中使用的文件感到困惑。

# /path/to/app/src/Bundle/Resources/config/services.yml
parameters:
    do_something: Bundle\DoSomething
    yaml.parser.class: Symfony\Component\Yaml\Parser
    yaml.config_file: "/Resources/config/config.yml" # what do I put here to win!

services:
    yaml_parser:
        class: %yaml.parser.class%

    do_parsing:
        class: %do_something%
        arguments: [ @yaml_parser, %yaml.config_file% ]

在我的服务中我有

# /path/to/app/src/Bundle/DoSomething.php

<?php

namespace Bundle;

use \Symfony\Component\Yaml\Parser;

class DoSemething
{
    protected $parser;
    protected $parsed_yaml_file;

    public function __construct(Parser $parser, $file_path)
    {
       $this->parsed_yaml_file = $parser->parse(file_get_contents(__DIR__ . $file_path));
    }

    public function useParsedFile()
    {
        foreach($parsed_yaml_file as $k => $v)
        {
            // ...  etc etc 
        }
    }
}

这可能是完全错误的做法,如果我应该做其他事情,请告诉我!

4 个答案:

答案 0 :(得分:8)

首先,我将解释为什么我为您实施我的解决方案以确定此案例是否适合您。

我需要一种方法来轻松地在我的包中加载自定义.yml文件(对于许多包),因此为每个文件添加一个单独的行到app / config.yml似乎对每个设置都很麻烦。

此外,我希望默认情况下已经加载了大部分配置,因此最终用户甚至不需要担心大部分时间的配置,尤其是不检查每个配置文件是否设置正确。

如果这对您而言类似,请继续阅读。如果没有,只需使用Kris解决方案,也是一个很好的解决方案!


当我遇到需要这个功能时,Symfony2并没有提供一种简单的方法来实现这一点,所以我在这里解决了这个问题:

首先我创建了一个本地YamlFileLoader类,它基本上是一个愚蠢的Symfony2:

<?php

namespace Acme\DemoBundle\Loader;

use Symfony\Component\Yaml\Yaml;
use Symfony\Component\Config\Loader\FileLoader;

/**
 * YamlFileLoader loads Yaml routing files.
 */
class YamlFileLoader extends FileLoader
{
    /**
     * Loads a Yaml file.
     *
     * @param string $file A Yaml file path
     *
     * @return array
     *
     * @throws \InvalidArgumentException When config can't be parsed
     */
    public function load($file, $type = null)
    {
        $path = $this->locator->locate($file);

        $config = Yaml::parse($path);

        // empty file
        if (null === $config) {
            $config = array();
        }

        // not an array
        if (!is_array($config)) {
            throw new \InvalidArgumentException(sprintf('The file "%s" must contain a YAML array.', $file));
        }

        return $config;
    }

    /**
     * Returns true if this class supports the given resource.
     *
     * @param mixed  $resource A resource
     * @param string $type     The resource type
     *
     * @return Boolean True if this class supports the given resource, false otherwise
     *
     * @api
     */
    public function supports($resource, $type = null)
    {
        return is_string($resource) && 'yml' === pathinfo($resource, PATHINFO_EXTENSION) && (!$type || 'yaml' === $type);
    }
}

然后我为我的软件包更新了DIC扩展(如果你让Symfony2创建完整的软件包架构,它通常是自动生成的,如果不是在你的软件包目录中创建一个DependencyInjection/<Vendor&BundleName>Extension.php文件,其中包含以下内容:

<?php

namespace Acme\DemoBundle\DependencyInjection;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\Loader;

use Acme\DemoBundle\Loader\YamlFileLoader;

/**
 * This is the class that loads and manages your bundle configuration
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
 */
class AcmeDemoExtension extends Extension
{
    /**
     * {@inheritDoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

        $loader->load('services.xml');

        // until here everything is default config (for your DIC services)

        $ymlLoader = new YamlFileLoader(new FileLocator(__DIR__.'/../Resources/config'));
        $container->setParameter('param_name', $ymlLoader->load('yaml_file_name'))); // load yml file contents as an array
    }
}

现在您可以访问/传递您的yaml配置作为简单的服务参数(即%param_name% for services.yml)

答案 1 :(得分:6)

我这样解决了:

Services.yml

#/path/to/app/src/Bundle/Resources/config/services.yml

parameters:
    example.class: Path\To\Bundle\Service\Class
    example.yaml_config_file: "%kernel.root_dir%/../src/Path/To/Bundle/Resources/config/config.yml"

services:
    example_service:
        class: %example.class%
        arguments: [%example.yaml_config_file% ]

服务类

# /path/to/app/src/Bundle/Service/Example.php

<?php

namespace Bundle\Service;

use \Symfony\Component\Yaml\Yaml;

class Example
{
    private $parsed_yaml_file;

    public function __construct($yaml_config_file)
    {
       $this->parsed_yaml_file = Yaml::parse($yaml_config_file);
    }
}

答案 2 :(得分:3)

您可以使用kernel.root_dir参数:

parameters:
    yaml.config_file: "%kernel.root_dir%/../src/Path/To/MyBundle/Resources/config/config.yml"

答案 3 :(得分:0)

如果您使用的是Symfony 3.3或更高版本,则现在还可以使用新的kernel.project_dir参数。

此参数指向包含作曲家文件的最高目录。