parameters.ymlファイルにパラメーターを作成しました。
parameters:
category:
var: test
でこのパラメーターにアクセスするにはどうすればよいconfig.ymlですか? たとえば、このパラメーターをすべての twig ファイルにグローバル twig 変数として渡したいとします。
twig:
globals:
my_var: %category.var% # throws ParameterNotFoundException
私が見たすべての symfony 設定ファイルで、'parameters:' の下のエントリは常に完全修飾されていました。これがなぜなのか完全にはわかりませんが、次のように parameters.yml にエントリを記述すると役立つ場合があります。
category1.var1: xxx
category1.var2: yyy
category1.var3. zzz
category2.subcategory1.var1: 5
category2.subcategory1.var2: 10
category2.subcategory2.var1: foo
category2.subcategory2.var2: bar
... 等々。
プロジェクトの1つで、質問からネストされたパラメーターをparameters.local.ymlに貼り付けようとし、簡単な単体テストを実行して、コンテナーからそれと完全修飾パラメーターを取得しました。
$testUserEmail = $container->getParameter('test.user.email');
$this->assertEquals('dahlia.flower@randomtest.com', $testUserEmail);
$testParam = $container->getParameter('category.var');
$this->assertEquals('test', $testParam);
完全修飾パラメーターは問題ありませんでしたが、ネストされたパラメーターを取得しようとすると、InvalidArgumentException次の結果になりました: パラメーターcategory.varを定義する必要があります。パラメータをネストで定義できるとは思いません。
または、ネストされたパラメーターを動的に実装できる単純な ParameterBag を作成できます (構成値の重複なし)。
<?php
namespace Your\Namespace;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
class ParameterBagNested extends ParameterBag
{
/**
* wire $this->set() logic into add() too
*
* @param array $parameters
*/
public function add( array $parameters )
{
foreach ( $parameters as $name => $value ) {
$this->set( $name, $value );
}
}
/**
* sets all levels of nested array parameters with dot notation
* - loggly[host: loggly.com] will be translated this way:
* - loggly: [host: loggly.com] - standard array parameter will be left as is
* - loggly.host: loggly.com - nested variables ar translated so you can access them directly too as parent.variable
*
* @param string $name
* @param mixed $value
*/
public function set( $name, $value )
{
if ( $this->has( $name ) ) {
// this is required because of array values
// we can have arrays defined there, so we need to remove them first
// otherwise some subvalues would to remain in the system and as a result, arrays would be merged, not overwriten by set()
$this->remove( $name );
}
$this->setNested( $name, $value );
}
/**
* remove checks even if name is not array
*
* @param string $name
*/
public function remove( $name )
{
$value = $this->get( $name );
if ( is_array( $value ) ) {
foreach ( $value as $k => $v ) {
$this->remove( $name . '.' . $k, $v );
}
}
if ( strpos( $name, '.' ) !== FALSE ) {
$parts = explode( '.', $name );
$nameTopLevel = reset( $parts );
array_shift( $parts );
$topLevelData = $this->removeKeyByAddress( $this->get( $nameTopLevel ), $parts );
ksort( $topLevelData );
$this->setNested( $nameTopLevel, $topLevelData );
}
parent::remove( $name );
}
/**
* @param array $data
* @param array $addressParts
*
* @return array
*/
private function removeKeyByAddress( $data, $addressParts )
{
$updatedLevel = & $data;
$i = 1;
foreach ( $addressParts as $part ) {
if ( $i === count( $addressParts ) ) {
unset( $updatedLevel[$part] );
} else {
$updatedLevel = & $updatedLevel[$part];
$i++;
}
}
return $data;
}
/**
* @see set()
*
* @param string $name
* @param mixed $value
*/
private function setNested( $name, $value )
{
if ( is_array( $value ) ) {
foreach ( $value as $k => $v ) {
$this->setNested( $name . '.' . $k, $v );
}
}
parent::set( $name, $value );
}
}
phpunit テスト:
<?php
namespace Your\Namespace;
use Symfony\Component\DependencyInjection\Tests\ParameterBag\ParameterBagTest;
/**
* its essential to use ParameterBagNested as ParameterBag because this way we run even parent class tests upon it
* parent class is part of Symfony DIC standard test suite and we use it here just for check if our parameter bag is still ok
*/
use SBKS\DependencyInjection\ParameterBag\ParameterBagNested as ParameterBag;
/**
* testing basic and even added ParameterBag functionality
*/
class ParameterBagNestedTest extends ParameterBagTest
{
public function testConstructorNested()
{
$bag = new ParameterBag(
array(
'foo' => array( 'foo1' => 'foo' ),
'bar' => 'bar',
)
);
$this->assertEquals(
array(
'foo.foo1' => 'foo',
'foo' => array(
'foo1' => 'foo',
),
'bar' => 'bar',
),
$bag->all(),
'__construct() takes an array of parameters as its first argument'
);
}
public function testRemoveNested()
{
$bag = new ParameterBag(
array(
'foo' => array(
'foo1' => array(
'foo11' => 'foo',
'foo12' => 'foo',
),
'foo2' => 'foo',
),
'bar' => 'bar',
)
);
$bag->remove( 'foo.foo1.foo11' );
$this->assertEquals(
array(
'foo' => array(
'foo1' => array(
'foo12' => 'foo',
),
'foo2' => 'foo',
),
'foo.foo1' => array( 'foo12' => 'foo' ),
'foo.foo1.foo12' => 'foo',
'foo.foo2' => 'foo',
'bar' => 'bar',
),
$bag->all(),
'->remove() removes a parameter'
);
$bag->remove( 'foo' );
$this->assertEquals(
array(
'bar' => 'bar',
),
$bag->all(),
'->remove() removes a parameter'
);
}
public function testSetNested()
{
$bag = new ParameterBag(
array(
'foo' => array(
'foo1' => array(
'foo11' => 'foo',
'foo12' => 'foo',
),
'foo2' => 'foo',
),
)
);
$bag->set( 'foo', 'foo' );
$this->assertEquals( array( 'foo' => 'foo' ), $bag->all(), '->set() sets the value of a new parameter' );
}
public function testHasNested()
{
$bag = new ParameterBag(
array(
'foo' => array(
'foo1' => array(
'foo11' => 'foo',
'foo12' => 'foo',
),
'foo2' => 'foo',
),
)
);
$this->assertTrue( $bag->has( 'foo' ), '->has() returns true if a parameter is defined' );
$this->assertTrue( $bag->has( 'foo.foo1' ), '->has() returns true if a parameter is defined' );
$this->assertTrue( $bag->has( 'foo.foo1.foo12' ), '->has() returns true if a parameter is defined' );
$this->assertTrue( $bag->has( 'foo.foo2' ), '->has() returns true if a parameter is defined' );
}
}
次に、 Parameter バッグを ContainerBuilder に注入することで使用できます。
$parameterBag = new \Your\Namespace\ParameterBagNested();
$container = new ContainerBuilder($parameterBag);
これで、Symfony DI コンテナーでドット表記のネストされたパラメーターを使用できるようになりました。
phpstorm で Symfony プラグインを使用している場合、ネストされた属性もドット表記でオートコンプリートされます。
少し遅れましたが、ここに私のために働いた解決策があります。
# app/config/config.yml
twig:
globals:
my_var: category['var']
パラメータ ファイルをファイルにインポートすると、パラメータ ファイルapp/config/config.ymlで定義されているすべての変数に自動的にアクセスできます。
構造を使用するときは、次の点に注意してください。
# app/config/parameters.yml
parameters:
category:
var: test
それ自体がキーと値として含まれるキーとcategory値のペアの配列である値で呼び出されるパラメーターを定義しています。vartest
symfony の新しいバージョン (3.4 - 4.2) では、次のことができるようになりました:
# app/config/config.yml
twig:
globals:
custom_categories: '%categories%'
このパラメーターを設定すると、次のようになります。
# app/config/parameters.yml
parameters:
categories:
- category_A
- category_B
ここで注意すべきこと: - parameters.yml のカテゴリは配列です
小枝テンプレートで使用するには、次のようなことができるはずです。
<ul>
{% for category in categories %}
<li> {{ category }} </li>
{% endfor %}
</ul>
オブジェクトを使用した別の例:
# app/config/parameters.yml
parameters:
marketplace:
name: 'My Store'
address: '...'
小枝変数の設定:
# app/config/config.yml
twig:
globals:
marketplace: '%marketplace%'
小枝でそれを使用する：
...
<p>{{marketplace.name}}</p>
<p>{{marketplace.address}}</p>
...
お役に立てれば！:)
セッターから値を削除する必要のない別のアプローチを提供するために、代わりにゲッター メソッドをオーバーライドします。
namespace NameSpaceFor\ParameterBags;
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
class ParameterBagParser extends ParameterBag
{
/**
* {@inheritDoc}
*/
public function get($name, $parent = null)
{
if (null === $parent) {
$parent = $this->parameters;
}
$name = strtolower($name);
if (!array_key_exists($name, $parent)) {
if (!$name) {
throw new ParameterNotFoundException($name);
}
if (false !== strpos($name, '.')) {
$parts = explode('.', $name);
$key = array_shift($parts);
if (isset($parent[$key])) {
return $this->get(implode('.', $parts), $parent[$key]);
}
}
$alternatives = [];
foreach ($parent as $key => $parameterValue) {
$lev = levenshtein($name, $key);
if ($lev <= strlen($name) / 3 || false !== strpos($key, $name)) {
$alternatives[] = $key;
}
}
throw new ParameterNotFoundException($name, null, null, null, $alternatives);
}
return $parent[$name];
}
}
すべてのドット表記がチェックされるまで、名前を再帰的にトラバースします。
したがって、配列とスカラー値で機能します。
config.yml:
parameters:
my_param:
- test
my_inherited: '%my_param.0%' #test
コンテナ対応:
$container->getParameter('my_param')[0]; //test