feature symfony#18322 [DomCrawler] Attach label to form fields (carlosV2)

fabpot · fabpot · commit 5c91f6e67142 · 2016-06-14T08:40:06.000+02:00
This PR was squashed before being merged into the 3.2-dev branch (closes symfony#18322). Discussion ---------- [DomCrawler] Attach label to form fields | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | While building a software to extract information from a webpage, I need to fill a form with hints on the fields labels. Example: ```html <form> ... <label for="my_field">Input the result of 3 + 4:</label> <input type="text" id="my_field" name="my_field" /> ... </form> ``` I thought it would be handy to have the field labels attached to each field. So given the previous form you could now do: ```php $form->get('my_field')->getLabel()->textContent; ``` Commits ------- 82ef55b [DomCrawler] Attach label to form fields
diff --git a/src/Symfony/Component/DomCrawler/Field/FormField.php b/src/Symfony/Component/DomCrawler/Field/FormField.php
@@ -57,6 +57,30 @@ public function __construct(\DOMElement $node)
         $this->initialize();
     }
 
+    /**
+     * Returns the label tag associated to the field or null if none.
+     *
+     * @return \DOMElement|null
+     */
+    public function getLabel()
+    {
+        $xpath = new \DOMXPath($this->node->ownerDocument);
+
+        if ($this->node->hasAttribute('id')) {
+            $labels = $xpath->query(sprintf('descendant::label[@for="%s"]', $this->node->getAttribute('id')));
+            if ($labels->length > 0) {
+                return $labels->item(0);
+            }
+        }
+
+        $labels = $xpath->query('ancestor::label[1]', $this->node);
+        if ($labels->length > 0) {
+            return $labels->item(0);
+        }
+
+        return;
+    }
+
     /**
      * Returns the name of the field.
      *
diff --git a/src/Symfony/Component/DomCrawler/Tests/Field/FormFieldTest.php b/src/Symfony/Component/DomCrawler/Tests/Field/FormFieldTest.php
@@ -35,4 +35,38 @@ public function testGetSetHasValue()
 
         $this->assertTrue($field->hasValue(), '->hasValue() always returns true');
     }
+
+    public function testLabelReturnsNullIfNoneIsDefined()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><form><input type="text" id="foo" name="foo" value="foo" /><input type="submit" /></form></html>');
+
+        $field = new InputFormField($dom->getElementById('foo'));
+        $this->assertNull($field->getLabel(), '->getLabel() returns null if no label is defined');
+    }
+
+    public function testLabelIsAssignedByForAttribute()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><form>
+            <label for="foo">Foo label</label>
+            <input type="text" id="foo" name="foo" value="foo" />
+            <input type="submit" />
+        </form></html>');
+
+        $field = new InputFormField($dom->getElementById('foo'));
+        $this->assertEquals('Foo label', $field->getLabel()->textContent, '->getLabel() returns the associated label');
+    }
+
+    public function testLabelIsAssignedByParentingRelation()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('<html><form>
+            <label for="foo">Foo label<input type="text" id="foo" name="foo" value="foo" /></label>
+            <input type="submit" />
+        </form></html>');
+
+        $field = new InputFormField($dom->getElementById('foo'));
+        $this->assertEquals('Foo label', $field->getLabel()->textContent, '->getLabel() returns the parent label');
+    }
 }
