Support @ignore annotation in $builder->add to prevent implicit label (#87)

* Support @ignore annotation in $builder->add to prevent implicit label

In some cases it is inconvenient that FormTypeLabelImplicit adds label when it does not see custom label in the definition (even if it can be added but not in implicit way). Example of such use case is using generator function (or merging option arrays).

Example code:
```
$getFieldOptions = function() { return ['label' => false] };
$builder->add('something', TextType::class, $getFieldOptions())
```
Phrase "something" is added to dictionary.


My proposed change allows usage of /** @ignore */ annotation to prevent this implicit add as in the example code below:
```
$builder->add(/** @ignore */'something', TextType::class, $getFieldOptions())
```

After that change phrase "something" is not added into the dictionary

* tests for issue87 - support for Ignore annotation in FormTypeLabelImplicit visitor

* cs

* cs

Author: noofaq

src/Visitor/Php/Symfony/FormTypeLabelExplicit.php

@@ -28,11 +28,14 @@ public function enterNode(Node $node)
         }
         parent::enterNode($node);
 
-        // we could have chosen to traverse specifically the buildForm function or ->add()
-        // we will probably miss some easy to catch instances when the actual array of options
-        // is provided statically or through another function.
-        // I don't see any disadvantages now to simply parsing arrays and JMSTranslationBundle has
-        // been doing it like this for quite some time without major problems.
+        /*
+         * We could have chosen to traverse specifically the buildForm function or ->add()
+         * we will probably miss some easy to catch instances when the actual array of options
+         * is provided statically or through another function.
+         *
+         * I don't see any disadvantages now to simply parsing arrays and JMSTranslationBundle has
+         * been doing it like this for quite some time without major problems.
+         */
         if (!$node instanceof Node\Expr\Array_) {
             return;
         }

src/Visitor/Php/Symfony/FormTypeLabelImplicit.php

@@ -61,13 +61,23 @@ public function enterNode(Node $node)
                         }
                     }
                 }
-                // actually there's another case here.. if the 3rd argument is anything else, it could well be
-                // that label is set through a static array. This will not be a common use-case so yeah in this case
-                // it may be the translation is double.
+                /*
+                 * Actually there's another case here.. if the 3rd argument is anything else, it could well be
+                 * that label is set through a static array. This will not be a common use-case so yeah in this case
+                 * it may be the translation is double.
+                 */
             }
 
             // only if no custom label was found, proceed
             if (false === $skipLabel && false !== $domain) {
+                /*
+                 * Pass DocComment (if available) from first argument (name of Form field) allowing usage of Ignore
+                 * annotation to disable implicit add; use case: when form options are generated by external method.
+                 */
+                if ($node->args[0]->getDocComment()) {
+                    $node->setDocComment($node->args[0]->getDocComment());
+                }
+
                 $label = $node->args[0]->value->value;
                 if (!empty($label)) {
                     if (null !== $location = $this->getLocation($label, $node->getAttribute('startLine'), $node, ['domain' => $domain])) {

tests/Functional/Visitor/Php/Symfony/FormTypeLabelImplicitTest.php

@@ -24,9 +24,12 @@ public function testExtract()
     {
         $collection = $this->getSourceLocations(new FormTypeLabelImplicit(), Resources\Php\Symfony\ImplicitLabelType::class);
 
-        $this->assertCount(3, $collection, print_r($collection, true));
+        $this->assertCount(4, $collection, print_r($collection, true));
         $this->assertEquals('find1', $collection->get(0)->getMessage());
         $this->assertEquals('bigger_find2', $collection->get(1)->getMessage());
         $this->assertEquals('camelFind3', $collection->get(2)->getMessage());
+
+        //issue87: support for Ignore annotation
+        $this->assertEquals('issue87-willBeAdded', $collection->get(3)->getMessage());
     }
 }

tests/Resources/Php/Symfony/ImplicitLabelType.php

@@ -15,5 +15,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
         $builder->add(function () { return 'skip3'; });
         // Symfony will throw an error I guess, but at least extractions skip it
         $builder->add('');
+		
+		//issue87: support for Ignore annotation
+		$generateOptions = function() { return ['label' => false]; };
+        $builder->add('issue87-willBeAdded', null, $generateOptions);
+        $builder->add(/** @Ignore */'issue87-shouldNotBeAdded', null, $generateOptions);
     }
 }