Codeception / Codeception

src/Codeception/Module/Db.php

Doc Comments +11 added lines

@@ -402,6 +402,9 @@ 
         return $lastInsertId;
     }
     
+    /**
+     * @param string $table
+     */
     public function _insertInDatabase($table, array $data)
     {
         $query = $this->driver->insert($table, $data);
@@ -420,6 +423,10 @@ 
         return $lastInsertId;
     }
 
+    /**
+     * @param string $table
+     * @param integer $id
+     */
     private function addInsertedRow($table, array $row, $id)
     {
         $primaryKey = $this->driver->getPrimaryKey($table);
@@ -510,6 +517,10 @@ 
         return (int) $this->proceedSeeInDatabase($table, 'count(*)', $criteria);
     }
 
+    /**
+     * @param string $table
+     * @param string $column
+     */
     protected function proceedSeeInDatabase($table, $column, $criteria)
     {
         $query = $this->driver->select($column, $table, $criteria);

src/Codeception/Lib/Driver/PostgreSql.php

Doc Comments +3 added lines

@@ -85,6 +85,9 @@
         return true;
     }
 
+    /**
+     * @param string $query
+     */
     public function sqlQuery($query)
     {
         if (strpos(trim($query), 'COPY ') === 0) {

src/Codeception/Test/Metadata.php

Doc Comments +7 added lines, -7 removed lines

@@ -47,7 +47,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getSkip()
     {
@@ -63,7 +63,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getIncomplete()
     {
@@ -80,7 +80,7 @@ 
 
     /**
      * @param string|null $key
-     * @return mixed
+     * @return string
      */
     public function getCurrent($key = null)
     {
@@ -164,7 +164,7 @@ 
     }
 
     /**
-     * @param $service
+     * @param string $service
      * @return array
      * @throws InjectionException
      */
@@ -194,8 +194,8 @@ 
     }
 
     /**
-     * @param $type
-     * @param $report
+     * @param string $type
+     * @param string $report
      */
     public function addReport($type, $report)
     {
@@ -206,7 +206,7 @@ 
      * Returns test params like: env, group, skip, incomplete, etc
      * Can return by annotation or return all if no key passed
      *
-     * @param null $key
+     * @param string $key
      * @return array|mixed|null
      */
     public function getParam($key = null)

src/Codeception/Lib/Driver/Db.php

Doc Comments +6 added lines

@@ -33,6 +33,9 @@ 
      */
     protected $primaryKeys = [];
 
+    /**
+     * @param string $dsn
+     */
     public static function connect($dsn, $user, $password, $options = null)
     {
         $dbh = new \PDO($dsn, $user, $password, $options);
@@ -339,6 +342,9 @@ 
         return empty($this->primaryKeys);
     }
 
+    /**
+     * @param string $table
+     */
     public function update($table, array $data, array $criteria)
     {
         if (empty($data)) {

src/Codeception/Lib/InnerBrowser.php

Doc Comments +34 added lines, -6 removed lines

@@ -110,7 +110,7 @@ 
      * @param array $files
      * @param array $server
      * @param null $content
-     * @return mixed|Crawler
+     * @return string
      * @throws ExternalUrlException
      * @see `_loadPage`
      */
@@ -195,6 +195,9 @@ 
         return $this->redirectIfNecessary($result, $maxRedirects, 0);
     }
 
+    /**
+     * @param string|false $domain
+     */
     protected function isInternalDomain($domain)
     {
         if ($this->internalDomains === null) {
@@ -266,6 +269,9 @@ 
         return $this->client;
     }
 
+    /**
+     * @param string $filename
+     */
     public function _savePageSource($filename)
     {
         file_put_contents($filename, $this->_getResponseContent());
@@ -381,7 +387,7 @@ 
 
     /**
      * @param $link
-     * @return bool
+     * @return boolean|null
      */
     protected function clickByLocator($link)
     {
@@ -615,6 +621,9 @@ 
         $this->proceedSeeInFormFields($formSelector, $params, true);
     }
 
+    /**
+     * @param boolean $assertNot
+     */
     protected function proceedSeeInFormFields($formSelector, array $params, $assertNot)
     {
         $form = $this->match($formSelector)->first();
@@ -859,6 +868,9 @@ 
         $this->forms = [];
     }
 
+    /**
+     * @param string $selector
+     */
     public function submitForm($selector, array $params, $button = null)
     {
         $form = $this->match($selector)->first();
@@ -1224,7 +1236,7 @@ 
      *
      * ```
      *
-     * @param $method
+     * @param string $method
      * @param $uri
      * @param $params
      */
@@ -1394,6 +1406,9 @@ 
         $this->fail("Element $nodes is not a form field or does not contain a form field");
     }
 
+    /**
+     * @param string $name
+     */
     public function setCookie($name, $val, array $params = [])
     {
         $cookies = $this->client->getCookieJar();
@@ -1611,18 +1626,27 @@ 
         $this->assertNotContains($title, $nodes->first()->text(), "page title contains $title");
     }
 
+    /**
+     * @param Crawler $nodes
+     */
     protected function assertDomContains($nodes, $message, $text = '')
     {
         $constraint = new CrawlerConstraint($text, $this->_getCurrentUri());
         $this->assertThat($nodes, $constraint, $message);
     }
 
+    /**
+     * @param Crawler $nodes
+     */
     protected function assertDomNotContains($nodes, $message, $text = '')
     {
         $constraint = new CrawlerNotConstraint($text, $this->_getCurrentUri());
         $this->assertThat($nodes, $constraint, $message);
     }
 
+    /**
+     * @param string $needle
+     */
     protected function assertPageContains($needle, $message = '')
     {
         $constraint = new PageConstraint($needle, $this->_getCurrentUri());
@@ -1633,6 +1657,9 @@ 
         );
     }
 
+    /**
+     * @param string $needle
+     */
     protected function assertPageNotContains($needle, $message = '')
     {
         $constraint = new PageConstraint($needle, $this->_getCurrentUri());
@@ -1664,8 +1691,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $form
+     * @param string|null $name
+     * @param Form $form
      * @param $dynamicField
      * @return FormField
      */
@@ -1733,7 +1760,8 @@ 
     }
 
     /**
-     * @param $result
+     * @param Crawler|null $result
+     * @param integer $redirectCount
      * @return mixed
      */
     protected function redirectIfNecessary($result, $maxRedirects, $redirectCount)

src/Codeception/Module/Yii2.php

Doc Comments +3 added lines, -3 removed lines

@@ -535,7 +535,7 @@ 
      * $mailer = $I->grabComponent('mailer');
      * ```
      *
-     * @param $component
+     * @param string $component
      * @return mixed
      * @throws ModuleException
      */
@@ -656,7 +656,7 @@ 
     /**
      * Returns a list of regex patterns for recognized domain names
      *
-     * @return array
+     * @return string[]
      */
     public function getInternalDomains()
     {
@@ -683,7 +683,7 @@ 
     /**
      * Sets a cookie and, if validation is enabled, signs it.
      * @param string $name The name of the cookie
-     * @param string $value The value of the cookie
+     * @param string $val The value of the cookie
      * @param array $params Additional cookie params like `domain`, `path`, `expires` and `secure`.
      */
     public function setCookie($name, $val, array $params = [])

src/Codeception/Module/WebDriver.php

Doc Comments +48 added lines, -6 removed lines

@@ -634,7 +634,7 @@ 
      * Returns URL of a host.
      *
      * @api
-     * @return mixed
+     * @return string
      * @throws ModuleConfigException
      */
     public function _getUrl()
@@ -685,6 +685,9 @@ 
         return Uri::retrieveUri($url);
     }
 
+    /**
+     * @param string $filename
+     */
     public function _saveScreenshot($filename)
     {
         if (!isset($this->webDriver)) {
@@ -705,7 +708,7 @@ 
 
     /**
      * Saves HTML source of a page to a file
-     * @param $filename
+     * @param string $filename
      */
     public function _savePageSource($filename)
     {
@@ -840,6 +843,9 @@ 
         return $this->webDriver->getPageSource();
     }
 
+    /**
+     * @param Cookie[] $cookies
+     */
     protected function filterCookies($cookies, $params = [])
     {
         foreach (['domain', 'path', 'name'] as $filter) {
@@ -848,6 +854,10 @@ 
             }
             $cookies = array_filter(
                 $cookies,
+
+                /**
+                 * @param Cookie[] $item
+                 */
                 function ($item) use ($filter, $params) {
                     return $item[$filter] == $params[$filter];
                 }
@@ -1111,7 +1121,7 @@ 
 
     /**
      * @param string $url
-     * @param $nodes
+     * @param RemoteWebElement[] $nodes
      * @return array
      */
     private function filterNodesByHref($url, $nodes)
@@ -1208,6 +1218,9 @@ 
         $this->proceedSeeInFormFields($formSelector, $params, true);
     }
 
+    /**
+     * @param boolean $assertNot
+     */
     protected function proceedSeeInFormFields($formSelector, array $params, $assertNot)
     {
         $form = $this->match($this->baseElement, $formSelector);
@@ -1593,6 +1606,9 @@ 
         return $els;
     }
 
+    /**
+     * @param WebDriverElement $option
+     */
     public function checkOption($option)
     {
         $field = $this->findCheckable($this->webDriver, $option);
@@ -1605,6 +1621,9 @@ 
         $field->click();
     }
 
+    /**
+     * @param WebDriverElement $option
+     */
     public function uncheckOption($option)
     {
         $field = $this->findCheckable($this->baseElement, $option);
@@ -1617,6 +1636,9 @@ 
         $field->click();
     }
 
+    /**
+     * @param WebDriverElement $field
+     */
     public function fillField($field, $value)
     {
         $el = $this->findField($field);
@@ -1969,6 +1991,9 @@ 
         $this->debug($this->_getCurrentUri());
     }
 
+    /**
+     * @return integer
+     */
     protected function getSubmissionFormFieldName($name)
     {
         if (substr($name, -2) === '[]') {
@@ -2374,7 +2399,7 @@ 
      * Try not to use this command on a regular basis.
      * If Codeception lacks a feature you need, please implement it and submit a patch.
      *
-     * @param callable $function
+     * @param \Closure $function
      */
     public function executeInSelenium(\Closure $function)
     {
@@ -2492,7 +2517,7 @@ 
      * $I->executeJS("window.alert(arguments[0])", ['Hello world']);
      * ```
      *
-     * @param $script
+     * @param string $script
      * @param array $arguments
      * @return mixed
      */
@@ -2834,16 +2859,25 @@ 
         return $keys;
     }
 
+    /**
+     * @param string $selector
+     */
     protected function assertNodesContain($text, $nodes, $selector = null)
     {
         $this->assertThat($nodes, new WebDriverConstraint($text, $this->_getCurrentUri()), $selector);
     }
 
+    /**
+     * @param string $selector
+     */
     protected function assertNodesNotContain($text, $nodes, $selector = null)
     {
         $this->assertThat($nodes, new WebDriverConstraintNot($text, $this->_getCurrentUri()), $selector);
     }
 
+    /**
+     * @param string $needle
+     */
     protected function assertPageContains($needle, $message = '')
     {
         $this->assertThat(
@@ -2853,6 +2887,9 @@ 
         );
     }
 
+    /**
+     * @param string $needle
+     */
     protected function assertPageNotContains($needle, $message = '')
     {
         $this->assertThatItsNot(
@@ -3037,7 +3074,7 @@ 
     /**
      * Check if the cookie domain matches the config URL.
      *
-     * @param array|Cookie $cookie
+     * @param Cookie $cookie
      * @return bool
      */
     private function cookieDomainMatchesConfigUrl($cookie)
@@ -3162,6 +3199,11 @@ 
         $this->switchToNextTab(0 - $offset);
     }
 
+    /**
+     * @param integer $offset
+     *
+     * @return string
+     */
     protected function getRelativeTabHandle($offset)
     {
         if ($this->isPhantom()) {

src/Codeception/Subscriber/Console.php

Doc Comments +6 added lines

@@ -360,6 +360,9 @@ 
         $this->printExceptionTrace($fail);
     }
 
+    /**
+     * @param string $cause
+     */
     public function printException($e, $cause = null)
     {
         if ($e instanceof \PHPUnit\Framework\SkippedTestError or $e instanceof \PHPUnit\Framework_IncompleteTestError) {
@@ -404,6 +407,9 @@ 
         $message->writeln();
     }
 
+    /**
+     * @param \Exception $fail
+     */
     public function printScenarioFail(ScenarioDriven $failedTest, $fail)
     {
         if ($this->conditionalFails) {

src/Codeception/Suite.php

Doc Comments +3 added lines

@@ -28,6 +28,9 @@
         $this->tests = $queue;
     }
 
+    /**
+     * @param \PHPUnit\Framework\TestCase $test
+     */
     protected function getDependencies($test)
     {
         if (!$test instanceof Dependent) {