Added types and tweaked PHPdoc of clickLink() and submitForm() methods

javiereguiluz · javiereguiluz · commit 48aa504155b9 · 2018-07-15T10:36:30.000+02:00
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -291,17 +291,13 @@ public function click(Link $link)
     }
 
     /**
-     * Finds link by given text and then clicks on it.
+     * Clicks the first link (or clickable image) that contains the given text.
      *
-     * @param string $value The link text
-     *
-     * @return Crawler
+     * @param string $linkText The text of the link or the alt attribute of a clickable image
      */
-    public function clickLink($value)
+    public function clickLink(string $linkText): Crawler
     {
-        $link = $this->getCrawler()->selectLink($value)->link();
-
-        return $this->click($link);
+        return $this->click($this->getCrawler()->selectLink($linkText)->link());
     }
 
     /**
@@ -322,18 +318,17 @@ public function submit(Form $form, array $values = array()/*, array $serverParam
     }
 
     /**
-     * Finds a form by submit button text and then submits it.
+     * Finds the first form that contains a button with the given content and
+     * uses it to submit the given form field values.
      *
-     * @param string $button The button text
-     * @param array  $values An array of form field values
-     * @param string $method The method for the form
-     *
-     * @return Crawler
+     * @param string $button      The text content, id, value or name of the form <button> or <input type="submit">
+     * @param array  $fieldValues Use this syntax: array('my_form[name]' => '...', 'my_form[email]' => '...')
+     * @param string $method      The HTTP method used to submit the form
      */
-    public function submitForm($button, $values, $method)
+    public function submitForm(string $button, array $fieldValues, string $method = 'POST'): Crawler
     {
         $buttonNode = $this->getCrawler()->selectButton($button);
-        $form = $buttonNode->form($values, $method);
+        $form = $buttonNode->form($fieldValues, $method);
 
         return $this->submit($form);
     }

Original file line number	Diff line number	Diff line change
`@@ -291,17 +291,13 @@ public function click(Link $link)`
`291`	`291`	`}`
`292`	`292`
`293`	`293`	`/**`
`294`		`- * Finds link by given text and then clicks on it.`
	`294`	`+ * Clicks the first link (or clickable image) that contains the given text.`
`295`	`295`	`*`
`296`		`- * @param string $value The link text`
`297`		`- *`
`298`		`- * @return Crawler`
	`296`	`+ * @param string $linkText The text of the link or the alt attribute of a clickable image`
`299`	`297`	`*/`
`300`		`- public function clickLink($value)`
	`298`	`+ public function clickLink(string $linkText): Crawler`
`301`	`299`	`{`
`302`		`- $link = $this->getCrawler()->selectLink($value)->link();`
`303`		`-`
`304`		`- return $this->click($link);`
	`300`	`+ return $this->click($this->getCrawler()->selectLink($linkText)->link());`
`305`	`301`	`}`
`306`	`302`
`307`	`303`	`/**`
`@@ -322,18 +318,17 @@ public function submit(Form $form, array $values = array()/*, array $serverParam`
`322`	`318`	`}`
`323`	`319`
`324`	`320`	`/**`
`325`		`- * Finds a form by submit button text and then submits it.`
	`321`	`+ * Finds the first form that contains a button with the given content and`
	`322`	`+ * uses it to submit the given form field values.`
`326`	`323`	`*`
`327`		`- * @param string $button The button text`
`328`		`- * @param array $values An array of form field values`
`329`		`- * @param string $method The method for the form`
`330`		`- *`
`331`		`- * @return Crawler`
	`324`	`+ * @param string $button The text content, id, value or name of the form <button> or <input type="submit">`
	`325`	`+ * @param array $fieldValues Use this syntax: array('my_form[name]' => '...', 'my_form[email]' => '...')`
	`326`	`+ * @param string $method The HTTP method used to submit the form`
`332`	`327`	`*/`
`333`		`- public function submitForm($button, $values, $method)`
	`328`	`+ public function submitForm(string $button, array $fieldValues, string $method = 'POST'): Crawler`
`334`	`329`	`{`
`335`	`330`	`$buttonNode = $this->getCrawler()->selectButton($button);`
`336`		`- $form = $buttonNode->form($values, $method);`
	`331`	`+ $form = $buttonNode->form($fieldValues, $method);`
`337`	`332`
`338`	`333`	`return $this->submit($form);`
`339`	`334`	`}`