feature #26308 [Config] Introduce BuilderAwareInterface (ro0NL)

nicolas-grekas · nicolas-grekas · commit 6059bdc80ef1 · 2018-03-19T17:48:53.000+01:00
This PR was squashed before being merged into the 4.1-dev branch (closes #26308). Discussion ---------- [Config] Introduce BuilderAwareInterface | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  Split `ParentNodeDefinitionInterface` into `BuilderAwareInterface`. Use case is custom node definition (extended from VariableNodeDef) with a corresponding prototyped array node. To set the actual prototype i need the builder at definition level, provided by `ParentNodeDefinitionInterface`. However i don't implement `children()` + `append()`, i solely need the builder scope. To go after #26297 Commits ------- 1353694 [Config] Introduce BuilderAwareInterface
diff --git a/src/Symfony/Component/Config/Definition/Builder/BuilderAwareInterface.php b/src/Symfony/Component/Config/Definition/Builder/BuilderAwareInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Config\Definition\Builder;
+
+/**
+ * An interface that can be implemented by nodes which build other nodes.
+ *
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+interface BuilderAwareInterface
+{
+    public function setBuilder(NodeBuilder $builder);
+}
diff --git a/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php b/src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php
@@ -179,7 +179,7 @@ public function node($name, $type)
      */
     public function append(NodeDefinition $node)
     {
-        if ($node instanceof ParentNodeDefinitionInterface) {
+        if ($node instanceof BuilderAwareInterface) {
             $builder = clone $this;
             $builder->setParent(null);
             $node->setBuilder($builder);
diff --git a/src/Symfony/Component/Config/Definition/Builder/ParentNodeDefinitionInterface.php b/src/Symfony/Component/Config/Definition/Builder/ParentNodeDefinitionInterface.php
@@ -18,14 +18,12 @@
  *
  * @method NodeDefinition[] getChildNodeDefinitions() should be implemented since 4.1
  */
-interface ParentNodeDefinitionInterface
+interface ParentNodeDefinitionInterface extends BuilderAwareInterface
 {
     /**
      * @return NodeBuilder
      */
     public function children();
 
     public function append(NodeDefinition $node);
-
-    public function setBuilder(NodeBuilder $builder);
 }

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public function node($name, $type)`
`179`	`179`	`*/`
`180`	`180`	`public function append(NodeDefinition $node)`
`181`	`181`	`{`
`182`		`- if ($node instanceof ParentNodeDefinitionInterface) {`
	`182`	`+ if ($node instanceof BuilderAwareInterface) {`
`183`	`183`	`$builder = clone $this;`
`184`	`184`	`$builder->setParent(null);`
`185`	`185`	`$node->setBuilder($builder);`
Original file line number	Diff line number	Diff line change
`@@ -18,14 +18,12 @@`
`18`	`18`	`*`
`19`	`19`	`* @method NodeDefinition[] getChildNodeDefinitions() should be implemented since 4.1`
`20`	`20`	`*/`
`21`		`-interface ParentNodeDefinitionInterface`
	`21`	`+interface ParentNodeDefinitionInterface extends BuilderAwareInterface`
`22`	`22`	`{`
`23`	`23`	`/**`
`24`	`24`	`* @return NodeBuilder`
`25`	`25`	`*/`
`26`	`26`	`public function children();`
`27`	`27`
`28`	`28`	`public function append(NodeDefinition $node);`
`29`		`-`
`30`		`- public function setBuilder(NodeBuilder $builder);`
`31`	`29`	`}`