Add soft @return type declarations to interfaces and base classes

Author: mpdude

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog for FriendsOfBehat/MinkExtension
+
+## Version 2.8.0
+
+* Added soft `@return` type hints to the `MinkAwareContext` and `DriverFactory` interfaces and to all methods in `MinkContext` and `RawMinkContext`.
+  If you implement or extend these classes or any of the drivers shipped here, make sure to add _real_ corresponding return types to your 
+  implementations now. Signatures will be changed to include return types in the next major version.

src/Behat/MinkExtension/Context/MinkAwareContext.php

@@ -24,13 +24,17 @@ interface MinkAwareContext extends Context
      * Sets Mink instance.
      *
      * @param Mink $mink Mink session manager
+     *
+     * @return void
      */
     public function setMink(Mink $mink);
 
     /**
      * Sets parameters provided for Mink.
      *
      * @param array $parameters
+     *
+     * @return void
      */
     public function setMinkParameters(array $parameters);
 }

src/Behat/MinkExtension/Context/MinkContext.php

@@ -29,6 +29,8 @@ class MinkContext extends RawMinkContext implements TranslatableContext
      *
      * @Given /^(?:|I )am on (?:|the )homepage$/
      * @When /^(?:|I )go to (?:|the )homepage$/
+     *
+     * @return void
      */
     public function iAmOnHomepage()
     {
@@ -43,6 +45,8 @@ public function iAmOnHomepage()
      *
      * @Given /^(?:|I )am on "(?P<page>[^"]+)"$/
      * @When /^(?:|I )go to "(?P<page>[^"]+)"$/
+     *
+     * @return void
      */
     public function visit($page)
     {
@@ -55,6 +59,8 @@ public function visit($page)
      * Example: And I reload the page
      *
      * @When /^(?:|I )reload the page$/
+     *
+     * @return void
      */
     public function reload()
     {
@@ -66,6 +72,8 @@ public function reload()
      * Example: When I move backward one page
      *
      * @When /^(?:|I )move backward one page$/
+     *
+     * @return void
      */
     public function back()
     {
@@ -77,6 +85,8 @@ public function back()
      * Example: And I move forward one page
      *
      * @When /^(?:|I )move forward one page$/
+     *
+     * @return void
      */
     public function forward()
     {
@@ -89,6 +99,8 @@ public function forward()
      * Example: And I press "Log In"
      *
      * @When /^(?:|I )press "(?P<button>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function pressButton($button)
     {
@@ -102,6 +114,8 @@ public function pressButton($button)
      * Example: And I follow "Log In"
      *
      * @When /^(?:|I )follow "(?P<link>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function clickLink($link)
     {
@@ -117,6 +131,8 @@ public function clickLink($link)
      * @When /^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)"$/
      * @When /^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with:$/
      * @When /^(?:|I )fill in "(?P<value>(?:[^"]|\\")*)" for "(?P<field>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function fillField($field, $value)
     {
@@ -135,6 +151,8 @@ public function fillField($field, $value)
      *              | password | iLoveBats123 |
      *
      * @When /^(?:|I )fill in the following:$/
+     *
+     * @return void
      */
     public function fillFields(TableNode $fields)
     {
@@ -149,6 +167,8 @@ public function fillFields(TableNode $fields)
      * Example: And I select "Bats" from "user_fears"
      *
      * @When /^(?:|I )select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function selectOption($select, $option)
     {
@@ -163,6 +183,8 @@ public function selectOption($select, $option)
      * Example: And I additionally select "Deceased" from "parents_alive_status"
      *
      * @When /^(?:|I )additionally select "(?P<option>(?:[^"]|\\")*)" from "(?P<select>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function additionallySelectOption($select, $option)
     {
@@ -177,6 +199,8 @@ public function additionallySelectOption($select, $option)
      * Example: And I check "Pearl Necklace"
      *
      * @When /^(?:|I )check "(?P<option>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function checkOption($option)
     {
@@ -190,6 +214,8 @@ public function checkOption($option)
      * Example: And I uncheck "Broadway Plays"
      *
      * @When /^(?:|I )uncheck "(?P<option>(?:[^"]|\\")*)"$/
+     *
+     * @return void
      */
     public function uncheckOption($option)
     {

src/Behat/MinkExtension/Context/RawMinkContext.php

@@ -66,6 +66,8 @@ public function getMinkParameters()
      * Sets parameters provided for Mink.
      *
      * @param array $parameters
+     *
+     * @return void
      */
     public function setMinkParameters(array $parameters)
     {
@@ -90,6 +92,8 @@ public function getMinkParameter($name)
      *
      * @param string $name  The key of the parameter
      * @param string $value The value of the parameter
+     *
+     * @return void
      */
     public function setMinkParameter($name, $value)
     {
@@ -125,6 +129,8 @@ public function assertSession($name = null)
      *
      * @param string      $path
      * @param string|null $sessionName
+     *
+     * @return void
      */
     public function visitPath($path, $sessionName = null)
     {
@@ -153,6 +159,8 @@ public function locatePath($path)
      *                         <browser_name>_<ISO 8601 date>_<randomId>.png
      * @param string $filepath Desired filepath, defaults to
      *                         upload_tmp_dir, falls back to sys_get_temp_dir()
+     *
+     * @return void
      */
     public function saveScreenshot($filename = null, $filepath = null)
     {

src/Behat/MinkExtension/Listener/FailureShowListener.php

@@ -62,6 +62,8 @@ public static function getSubscribedEvents()
      * @param AfterStepTested $event
      *
      * @throws \RuntimeException if show_cmd is not configured
+     *
+     * @return void
      */
     public function showFailedStepResponse(AfterStepTested $event)
     {

src/Behat/MinkExtension/Listener/SessionsListener.php

@@ -79,6 +79,8 @@ public static function getSubscribedEvents()
      * @param ScenarioLikeTested $event
      *
      * @throws ProcessingException when the @javascript tag is used without a javascript session
+     *
+     * @return void
      */
     public function prepareDefaultMinkSession(ScenarioLikeTested $event)
     {
@@ -109,6 +111,8 @@ public function prepareDefaultMinkSession(ScenarioLikeTested $event)
 
     /**
      * Stops all started Mink sessions.
+     *
+     * @return void
      */
     public function tearDownMinkSessions()
     {

src/Behat/MinkExtension/ServiceContainer/Driver/DriverFactory.php

@@ -38,6 +38,8 @@ public function supportsJavascript();
      * Setups configuration for the driver factory.
      *
      * @param ArrayNodeDefinition $builder
+     *
+     * @return void
      */
     public function configure(ArrayNodeDefinition $builder);