Ver código fonte

[Config] Tweak type hints & phpDoc for the builders

Victor Berchet 14 anos atrás
pai
commit
6d37218db1

+ 14 - 14
src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php

@@ -26,9 +26,9 @@ class ExprBuilder
     /**
      * Constructor
      *
-     * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent The parent node
+     * @param NodeBuilder $parent The parent node
      */
-    public function __construct($parent)
+    public function __construct(NodeBuilder $parent)
     {
         $this->parent = $parent;
     }
@@ -36,7 +36,7 @@ class ExprBuilder
     /**
      * Mark the expression as being always used.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function always()
     {
@@ -51,7 +51,7 @@ class ExprBuilder
      * The default one tests if the value is true.
      *
      * @param \Closure $closure
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifTrue(\Closure $closure = null)
     {
@@ -67,7 +67,7 @@ class ExprBuilder
     /**
      * Tests if the value is a string.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifString()
     {
@@ -79,7 +79,7 @@ class ExprBuilder
     /**
      * Tests if the value is null.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifNull()
     {
@@ -91,7 +91,7 @@ class ExprBuilder
     /**
      * Tests if the value is an array.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifArray()
     {
@@ -105,7 +105,7 @@ class ExprBuilder
      *
      * @param array $array
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifInArray(array $array)
     {
@@ -119,7 +119,7 @@ class ExprBuilder
      *
      * @param array $array
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function ifNotInArray(array $array)
     {
@@ -133,7 +133,7 @@ class ExprBuilder
      *
      * @param \Closure $closure
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function then(\Closure $closure)
     {
@@ -145,7 +145,7 @@ class ExprBuilder
     /**
      * Sets a closure returning an empty array.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function thenEmptyArray()
     {
@@ -161,7 +161,7 @@ class ExprBuilder
      *
      * @param string $message
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function thenInvalid($message)
     {
@@ -173,7 +173,7 @@ class ExprBuilder
     /**
      * Sets a closure unsetting this key of the array at validation time.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function thenUnset()
     {
@@ -185,7 +185,7 @@ class ExprBuilder
     /**
      * Returns the parent node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function end()
     {

+ 5 - 5
src/Symfony/Component/Config/Definition/Builder/MergeBuilder.php

@@ -25,9 +25,9 @@ class MergeBuilder
     /**
      * Constructor
      *
-     * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent The parent node
+     * @param NodeBuilder $parent The parent node
      */
-    public function __construct($parent)
+    public function __construct(NodeBuilder $parent)
     {
         $this->parent = $parent;
         $this->allowFalse = false;
@@ -38,7 +38,7 @@ class MergeBuilder
      * Sets whether the node can be unset.
      *
      * @param Boolean $allow
-     * @return Symfony\Component\Config\Definition\Builder\MergeBuilder
+     * @return MergeBuilder
      */
     public function allowUnset($allow = true)
     {
@@ -52,7 +52,7 @@ class MergeBuilder
      *
      * @param Boolean $deny Whether the overwriting is forbidden or not
      *
-     * @return Symfony\Component\Config\Definition\Builder\MergeBuilder
+     * @return MergeBuilder
      */
     public function denyOverwrite($deny = true)
     {
@@ -64,7 +64,7 @@ class MergeBuilder
     /**
      * Returns the parent node.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function end()
     {

+ 31 - 31
src/Symfony/Component/Config/Definition/Builder/NodeBuilder.php

@@ -50,7 +50,7 @@ class NodeBuilder
      *
      * @param string      $name   the name of the node
      * @param string      $type   The type of the node
-     * @param NodeBuilder $parent
+     * @param mixed       $parent Either a NodeBuilder or a TreeBuilder instance
      */
     public function __construct($name, $type, $parent = null)
     {
@@ -92,7 +92,7 @@ class NodeBuilder
      * @param string $name The name of the node
      * @param string $type The type of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node
+     * @return NodeBuilder The builder of the child node
      */
     public function node($name, $type)
     {
@@ -129,7 +129,7 @@ class NodeBuilder
      *
      * @param string $name The name of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node
+     * @return NodeBuilder The builder of the child node
      */
     public function arrayNode($name)
     {
@@ -141,7 +141,7 @@ class NodeBuilder
      *
      * @param string $name the name of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node
+     * @return NodeBuilder The builder of the child node
      */
     public function scalarNode($name)
     {
@@ -153,7 +153,7 @@ class NodeBuilder
      *
      * @param string $name The name of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node
+     * @return NodeBuilder The builder of the child node
      */
     public function booleanNode($name)
     {
@@ -165,7 +165,7 @@ class NodeBuilder
      *
      * @param string $name The name of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder The builder of the child node
+     * @return NodeBuilder The builder of the child node
      */
     public function variableNode($name)
     {
@@ -177,7 +177,7 @@ class NodeBuilder
      *
      * @param mixed $value The default value
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function defaultValue($value)
     {
@@ -190,7 +190,7 @@ class NodeBuilder
     /**
      * Sets the node as required.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function isRequired()
     {
@@ -202,7 +202,7 @@ class NodeBuilder
     /**
      * Requires the node to have at least one element.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function requiresAtLeastOneElement()
     {
@@ -216,7 +216,7 @@ class NodeBuilder
      *
      * @param mixed $value
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function treatNullLike($value)
     {
@@ -230,7 +230,7 @@ class NodeBuilder
      *
      * @param mixed $value
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function treatTrueLike($value)
     {
@@ -244,7 +244,7 @@ class NodeBuilder
      *
      * @param mixed $value
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function treatFalseLike($value)
     {
@@ -256,7 +256,7 @@ class NodeBuilder
     /**
      * Sets null as the default value.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function defaultNull()
     {
@@ -266,7 +266,7 @@ class NodeBuilder
     /**
      * Sets true as the default value.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function defaultTrue()
     {
@@ -276,7 +276,7 @@ class NodeBuilder
     /**
      * Sets false as the default value.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function defaultFalse()
     {
@@ -286,7 +286,7 @@ class NodeBuilder
     /**
      * Adds the default value if the node is not set in the configuration.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function addDefaultsIfNotSet()
     {
@@ -300,7 +300,7 @@ class NodeBuilder
      *
      * If used all keys have to be defined in the same configuration file.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function disallowNewKeysInSubsequentConfigs()
     {
@@ -312,7 +312,7 @@ class NodeBuilder
     /**
      * Gets the builder for normalization rules.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NormalizationBuilder
+     * @return NormalizationBuilder
      */
     protected function normalization()
     {
@@ -326,7 +326,7 @@ class NodeBuilder
     /**
      * Sets an expression to run before the normalization.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function beforeNormalization()
     {
@@ -339,7 +339,7 @@ class NodeBuilder
      * @param string $singular The key to remap
      * @param string $plural   The plural of the key for irregular plurals
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function fixXmlConfig($singular, $plural = null)
     {
@@ -372,7 +372,7 @@ class NodeBuilder
      * @param string $name The name of the key
      * @param Boolean $removeKeyItem Whether or not the key item should be removed.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function useAttributeAsKey($name, $removeKeyItem = true)
     {
@@ -385,7 +385,7 @@ class NodeBuilder
     /**
      * Gets the builder for merging rules.
      *
-     * @return Symfony\Component\Config\Definition\Builder\MergeBuilder
+     * @return MergeBuilder
      */
     protected function merge()
     {
@@ -401,7 +401,7 @@ class NodeBuilder
      *
      * @param Boolean $deny Whether the overwriting is forbidden or not
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function cannotBeOverwritten($deny = true)
     {
@@ -413,7 +413,7 @@ class NodeBuilder
     /**
      * Denies the node value being empty.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function cannotBeEmpty()
     {
@@ -427,7 +427,7 @@ class NodeBuilder
      *
      * @param Boolean $allow
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function canBeUnset($allow = true)
     {
@@ -441,7 +441,7 @@ class NodeBuilder
      *
      * @param string $type the type of node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function prototype($type)
     {
@@ -451,7 +451,7 @@ class NodeBuilder
     /**
      * Disables the deep merging of the node.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function performNoDeepMerging()
     {
@@ -463,7 +463,7 @@ class NodeBuilder
     /**
      * Gets the builder for validation rules.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ValidationBuilder
+     * @return ValidationBuilder
      */
     protected function validation()
     {
@@ -481,7 +481,7 @@ class NodeBuilder
      * modify it.
      * An exception should be thrown when the node is not valid.
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder
+     * @return ExprBuilder
      */
     public function validate()
     {
@@ -491,7 +491,7 @@ class NodeBuilder
     /**
      * Returns the parent node.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function end()
     {
@@ -506,7 +506,7 @@ class NodeBuilder
      * in special cases where you want to send an entire configuration
      * array through a special tree that processes only part of the array.
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function ignoreExtraKeys()
     {

+ 4 - 4
src/Symfony/Component/Config/Definition/Builder/NormalizationBuilder.php

@@ -25,9 +25,9 @@ class NormalizationBuilder
     /**
      * Constructor
      *
-     * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent
+     * @param NodeBuilder $parent
      */
-    public function __construct($parent)
+    public function __construct(NodeBuilder $parent)
     {
         $this->parent = $parent;
 
@@ -44,7 +44,7 @@ class NormalizationBuilder
      * @param string $key    The key to remap
      * @param string $plural The plural of the key in case of irregular plural
      *
-     * @return Symfony\Component\Config\Definition\Builder\NormalizationBuilder
+     * @return NormalizationBuilder
      */
     public function remap($key, $plural = null)
     {
@@ -62,7 +62,7 @@ class NormalizationBuilder
      *
      * @param \Closure $closure
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder|Symfony\Component\Config\Definition\Builder\NormalizationBuilder
+     * @return ExprBuilder|NormalizationBuilder
      */
     public function before(\Closure $closure = null)
     {

+ 1 - 1
src/Symfony/Component/Config/Definition/Builder/TreeBuilder.php

@@ -32,7 +32,7 @@ class TreeBuilder
      * @param string $name The name of the node
      * @param string $type The type of the node
      *
-     * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+     * @return NodeBuilder
      */
     public function root($name, $type)
     {

+ 3 - 3
src/Symfony/Component/Config/Definition/Builder/ValidationBuilder.php

@@ -24,9 +24,9 @@ class ValidationBuilder
     /**
      * Constructor
      *
-     * @param Symfony\Component\Config\Definition\Builder\NodeBuilder $parent
+     * @param NodeBuilder $parent
      */
-    public function __construct($parent)
+    public function __construct(NodeBuilder $parent)
     {
         $this->parent = $parent;
 
@@ -38,7 +38,7 @@ class ValidationBuilder
      *
      * @param \Closure $closure
      *
-     * @return Symfony\Component\Config\Definition\Builder\ExprBuilder|Symfony\Component\Config\Definition\Builder\ValidationBuilder
+     * @return ExprBuilder|ValidationBuilder
      */
     public function rule(\Closure $closure = null)
     {