magium / Magium

lib/AbstractTestCase.php

Doc Comments +20 added lines, -2 removed lines

@@ -251,6 +251,9 @@ 
         }
     }
 
+    /**
+     * @param null|string $selector
+     */
     public function assertElementClickable($selector, $by = WebDriver::BY_ID)
     {
         $this->elementAssertion($selector, $by, Clickable::ASSERTION);
@@ -268,6 +271,9 @@ 
         $this->testCaseConfiguration = $class;
     }
 
+    /**
+     * @param string $namespace
+     */
     public static function addBaseNamespace($namespace)
     {
         if (!in_array($namespace, self::$baseNamespaces)) {
@@ -275,6 +281,9 @@ 
         }
     }
 
+    /**
+     * @param string $prefix
+     */
     public static function resolveClass( $class, $prefix = null)
     {
         $origClass = $class;
@@ -306,6 +315,9 @@ 
 
     }
 
+    /**
+     * @return string
+     */
     protected function normalizeClassRequest($class)
     {
         return str_replace('/', '\\', $class);
@@ -398,7 +410,7 @@ 
      *
      * Options: 1s (1 second), 1ms (1 millisecond), 1us (1 microsecond), 1ns (1 nanosecond)
      *
-     * @param $time
+     * @param string $time
      */
 
     public function sleep($time)
@@ -600,7 +612,7 @@ 
     }
 
     /**
-     * @param $xpath
+     * @param string $xpath
      * @return \Facebook\WebDriver\Remote\RemoteWebElement
      */
 
@@ -629,6 +641,12 @@ 
         return $this->webdriver->byCssSelector($selector);
     }
 
+    /**
+     * @param string $xpathTemplate
+     * @param string $text
+     * @param string $specificNodeType
+     * @param string $parentElementSelector
+     */
     protected function getElementByTextXpath($xpathTemplate, $text, $specificNodeType = null, $parentElementSelector = null)
     {
 

lib/Cli/Command/AbstractApiEnablement.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 {
 
     abstract function getApiName();
+
+    /**
+     * @return string
+     */
     abstract function getApiDescription();
     abstract function getValue();
 

Unused Use Statements -4 removed lines

@@ -2,13 +2,9 @@
 
 namespace Magium\Cli\Command;
 
-use Magium\InvalidConfigurationException;
-use Magium\NotFoundException;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 abstract class AbstractApiEnablement extends Command

lib/Cli/Command/ApiEnable.php

Unused Use Statements -7 removed lines

@@ -2,14 +2,7 @@
 
 namespace Magium\Cli\Command;
 
-use Magium\InvalidConfigurationException;
-use Magium\NotFoundException;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
 
 class ApiEnable extends AbstractApiEnablement
 {

lib/Cli/Command/ApiPing.php

Unused Use Statements -5 removed lines

@@ -4,14 +4,9 @@
 
 use Guzzle\Http\Client;
 use Magium\Cli\Command\Test\TestSkeleton;
-use Magium\InvalidConfigurationException;
-use Magium\NotFoundException;
 use Magium\Util\Api\ApiConfiguration;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ApiPing extends Command

Spacing +11 added lines, -11 removed lines

@@ -33,21 +33,21 @@ 
         $api->setEnabled(true); // Gotta force this for this test
 
         $output->writeln('Sending un-authenticated payload...');
-        $client = new Client('http://' . $api->getApiHostname(). '/api/ping');
+        $client = new Client('http://' . $api->getApiHostname() . '/api/ping');
         $request = $client->get();
         $response = $request->send();
         $output->writeln(
             'Checking for 200 status message... '
-            . ($response->getStatusCode() == '200'?'OK':'Failed')
+            . ($response->getStatusCode() == '200' ? 'OK' : 'Failed')
         );
         $output->writeln(
             'Checking for application/json content type... '
-            . (stripos($response->getContentType(), 'application/json') !== false?'OK':'Failed')
+            . (stripos($response->getContentType(), 'application/json') !== false ? 'OK' : 'Failed')
         );
         $content = json_decode($response->getBody(), true);
         $output->writeln(
             'Checking for successful response... '
-            . (is_array($content) && isset($content['status']) && $content['status'] === 'success'?'OK':'Failed')
+            . (is_array($content) && isset($content['status']) && $content['status'] === 'success' ? 'OK' : 'Failed')
         );
 
         $output->writeln('');
@@ -59,16 +59,16 @@ 
 
         $output->writeln(
             'Checking for 200 status message... '
-            . ($response->getStatusCode() == '200'?'OK':'Failed')
+            . ($response->getStatusCode() == '200' ? 'OK' : 'Failed')
         );
         $output->writeln(
             'Checking for application/json content type... '
-            . (stripos($response->getContentType(), 'application/json') !== false?'OK':'Failed')
+            . (stripos($response->getContentType(), 'application/json') !== false ? 'OK' : 'Failed')
         );
         $content = $request->getPayload($response);
         $output->writeln(
             'Checking for successful response... '
-            . (is_array($content) && isset($content['status']) && $content['status'] === 'success'?'OK':'Failed')
+            . (is_array($content) && isset($content['status']) && $content['status'] === 'success' ? 'OK' : 'Failed')
         );
 
 
@@ -79,20 +79,20 @@ 
         $response = $request->push('/api/echo-authed', ['message' => 'hello world']);
         $output->writeln(
             'Checking for 200 status message... '
-            . ($response->getStatusCode() == '200'?'OK':'Failed')
+            . ($response->getStatusCode() == '200' ? 'OK' : 'Failed')
         );
         $output->writeln(
             'Checking for application/json content type... '
-            . (stripos($response->getContentType(), 'application/json') !== false?'OK':'Failed')
+            . (stripos($response->getContentType(), 'application/json') !== false ? 'OK' : 'Failed')
         );
         $content = $request->getPayload($response);
         $output->writeln(
             'Checking for successful response... '
-            . (is_array($content) && isset($content['status']) && $content['status'] === 'success'?'OK':'Failed')
+            . (is_array($content) && isset($content['status']) && $content['status'] === 'success' ? 'OK' : 'Failed')
         );
         $output->writeln(
             'Checking for matching echo message... '
-            . (is_array($content) && isset($content['message']) && $content['message'] === 'hello world'?'OK':'Failed')
+            . (is_array($content) && isset($content['message']) && $content['message'] === 'hello world' ? 'OK' : 'Failed')
         );
     }
     

lib/Util/Api/Clairvoyant/Clairvoyant.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
     }
 
     /**
-     * @return mixed
+     * @return string
      */
     public function getProjectId()
     {

lib/Cli/Command/ApiDisable.php

Unused Use Statements -7 removed lines

@@ -2,14 +2,7 @@
 
 namespace Magium\Cli\Command;
 
-use Magium\InvalidConfigurationException;
-use Magium\NotFoundException;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\ArrayInput;
-use Symfony\Component\Console\Input\InputArgument;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\OutputInterface;
 
 class ApiEnable extends AbstractApiEnablement
 {