datasift / storyplayer

src/php/DataSift/Storyplayer/ConfigLib/ConfigList.php

Braces +1 added lines, -2 removed lines

@@ -356,8 +356,7 @@
     {
         $list = $hardCodedDefaults->getConfigs();
 
-        foreach ($list as $name => $config)
-        {
+        foreach ($list as $name => $config) {
             $this->addEntry($name, $config);
         }
     }

Doc Comments +8 added lines, -3 removed lines

@@ -90,6 +90,9 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
+     * @param ConfigFinder[] $configFinders
      */
     public function __construct($configType, $searchFolders, $configFinders)
     {
@@ -186,6 +189,7 @@ 
     /**
      * load a SPv2.0-style JSON configs
      *
+     * @param string $filename
      * @return object
      */
     protected function loadJsonConfig($filename)
@@ -204,7 +208,8 @@ 
      * @todo we need (at some point) to move the check for a return value
      *       out to somewhere else
      *
-     * @return object
+     * @param string $filename
+     * @return TestEnvironment_Definition
      */
     protected function loadPhpConfig($filename)
     {
@@ -360,7 +365,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -370,7 +375,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

src/php/DataSift/Storyplayer/ConfigLib/HardCodedList.php

Indentation +23 added lines, -23 removed lines

@@ -55,10 +55,10 @@ 
  */
 class HardCodedList
 {
-	/**
-	 * our list of configs
-	 * @var array<object>
-	 */
+    /**
+     * our list of configs
+     * @var array<object>
+     */
     private $configs = [];
 
     /**
@@ -76,7 +76,7 @@ 
      */
     public function __construct($configType)
     {
-    	$this->setConfigType($configType);
+        $this->setConfigType($configType);
     }
 
     /**
@@ -86,7 +86,7 @@ 
      */
     public function getConfigType()
     {
-    	return $this->configType;
+        return $this->configType;
     }
 
     /**
@@ -99,11 +99,11 @@ 
      */
     public function setConfigType($configType)
     {
-    	if (!class_exists($configType)) {
-    		throw new E4xx_NoSuchConfigClass($configType);
-    	}
+        if (!class_exists($configType)) {
+            throw new E4xx_NoSuchConfigClass($configType);
+        }
 
-    	$this->configType = $configType;
+        $this->configType = $configType;
     }
 
     /**
@@ -118,15 +118,15 @@ 
      */
     public function newConfig($name)
     {
-    	// create our return object
-    	$classname = $this->configType;
-    	$obj = new $classname();
-    	$obj->setName($name);
+        // create our return object
+        $classname = $this->configType;
+        $obj = new $classname();
+        $obj->setName($name);
 
-    	// add this to the list
-    	$this->addConfig($obj);
+        // add this to the list
+        $this->addConfig($obj);
 
-    	return $obj;
+        return $obj;
     }
 
     /**
@@ -137,13 +137,13 @@ 
      */
     public function addConfig($config)
     {
-    	// make sure the config is compatible first
-    	if (! $config instanceof $this->configType) {
-    		throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
-    	}
+        // make sure the config is compatible first
+        if (! $config instanceof $this->configType) {
+            throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
+        }
 
-    	// if we get here, then we're good to go
-    	$name = $config->getName();
+        // if we get here, then we're good to go
+        $name = $config->getName();
         $this->configs[$name] = $config;
 
         // keep the list sorted

Spacing +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
     public function addConfig($config)
     {
     	// make sure the config is compatible first
-    	if (! $config instanceof $this->configType) {
+    	if (!$config instanceof $this->configType) {
     		throw new E4xx_IncompatibleConfigClass($this->configType, get_class($config));
     	}
 

src/php/DataSift/Storyplayer/ConfigLib/StoryplayerConfig.php

Spacing +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
             throw new E4xx_StoryplayerDefaultsSectionMustBeAnArray($this->getFilename());
         }
 
-        foreach($config->defaults as $defaultValue) {
+        foreach ($config->defaults as $defaultValue) {
             if (!is_string($defaultValue)) {
                 throw new E4xx_StoryplayerDefaultsMustBeStrings($this->getFilename());
             }

src/php/DataSift/Storyplayer/Console/Console.php

Indentation +2 added lines, -2 removed lines

@@ -422,8 +422,8 @@
         if ($trace !== null) {
             $this->write(PHP_EOL . "-----" . PHP_EOL, $this->writer->commentStyle);
             $this->write("This is the stack trace for this failure:"
-                 . PHP_EOL . PHP_EOL
-                 . CodeFormatter::indentBySpaces($trace, 4) . PHP_EOL . PHP_EOL);
+                    . PHP_EOL . PHP_EOL
+                    . CodeFormatter::indentBySpaces($trace, 4) . PHP_EOL . PHP_EOL);
         }
 
         // all done

Braces +3 added lines, -6 removed lines

@@ -112,11 +112,9 @@ 
 
         // this is our opportunity to tell the user how our story(ies)
         // went in detail
-        foreach ($this->results as $result)
-        {
+        foreach ($this->results as $result) {
             // so what happened?
-            switch ($result->resultCode)
-            {
+            switch ($result->resultCode) {
                 case PhaseGroup_Result::OKAY:
                     // this is a good result
                     $succeededGroups[] = $result;
@@ -303,8 +301,7 @@ 
 
         // does the phase have an exception?
         $e = $phaseResult->getException();
-        if ($e)
-        {
+        if ($e) {
             $stackTrace = $e->getTrace();
             $trace = $e->getTraceAsString();
         }

Doc Comments +2 added lines, -1 removed lines

@@ -92,7 +92,8 @@
     /**
      * called when Storyplayer exits
      *
-     * @return void
+     * @param boolean $summary
+     * @return integer
      */
     public function writeFinalReport($duration, $summary)
     {

src/php/DataSift/Storyplayer/Console/DevModeConsole.php

Indentation +2 added lines, -2 removed lines

@@ -270,8 +270,8 @@
     public function logCliErrorWithException($msg, $e)
     {
         $this->write("*** error: $msg" . PHP_EOL . PHP_EOL
-             . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
-             . $e->getTraceAsString() . PHP_EOL);
+                . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
+                . $e->getTraceAsString() . PHP_EOL);
     }
 
     /**

Spacing +2 added lines, -2 removed lines

@@ -60,7 +60,7 @@ 
  */
 class DevModeConsole extends Console
 {
-    protected $resultStrings  = array();
+    protected $resultStrings = array();
 
     public function __construct()
     {
@@ -124,7 +124,7 @@ 
         //$this->write('-------------------------------------------------------------' . PHP_EOL, $this->writer->commentStyle);
         $this->write('----' . PHP_EOL, $this->writer->commentStyle);
         $this->write("Result: ");
-        if ($result->getPhaseGroupSucceeded()){
+        if ($result->getPhaseGroupSucceeded()) {
             $this->write($resultString, $this->writer->successStyle);
         }
         else if ($result->getPhaseGroupFailed()) {

Braces +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
         //$this->write('-------------------------------------------------------------' . PHP_EOL, $this->writer->commentStyle);
         $this->write('----' . PHP_EOL, $this->writer->commentStyle);
         $this->write("Result: ");
-        if ($result->getPhaseGroupSucceeded()){
+        if ($result->getPhaseGroupSucceeded()) {
             $this->write($resultString, $this->writer->successStyle);
         }
         else if ($result->getPhaseGroupFailed()) {

src/php/DataSift/Storyplayer/Console/ScriptConsole.php

Indentation +2 added lines, -2 removed lines

@@ -209,8 +209,8 @@
     public function logCliErrorWithException($msg, $e)
     {
         echo "*** error: $msg" . PHP_EOL . PHP_EOL
-             . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
-             . $e->getTraceAsString();
+                . "This was caused by an unexpected exception " . get_class($e) . PHP_EOL . PHP_EOL
+                . $e->getTraceAsString();
     }
 
     /**

src/php/DataSift/Storyplayer/DefinitionLib/E4xx/DuplicateGroupId.php

Indentation +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 {
     public function __construct($testEnvironmentName, $groupId)
     {
-    	$msg = "in test environment {$testEnvironmentName}: attempt to create two or more groups with the same group ID {$groupId}";
+        $msg = "in test environment {$testEnvironmentName}: attempt to create two or more groups with the same group ID {$groupId}";
         parent::__construct(400, $msg, $msg);
     }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/DefinitionLib/E4xx/IllegalHostId.php

Indentation +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 {
     public function __construct($testEnvironmentName, $groupId, $hostId)
     {
-    	$msg = "in test environment {$testEnvironmentName}, group {$groupId}, hostIds must all be strings, at least one " . gettype($hostId) . " found instead";
+        $msg = "in test environment {$testEnvironmentName}, group {$groupId}, hostIds must all be strings, at least one " . gettype($hostId) . " found instead";
         parent::__construct(400, $msg, $msg);
     }
 }
\ No newline at end of file

src/php/DataSift/Storyplayer/DefinitionLib/E4xx/IllegalRole.php

Indentation +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 {
     public function __construct($testEnvironmentName, $groupId, $hostId, $role)
     {
-    	$msg = "in test environment {$testEnvironmentName}, group {$groupId}, host {$hostId}: roles must be an array of strings; contains at least one " . gettype($role) . " instead";
+        $msg = "in test environment {$testEnvironmentName}, group {$groupId}, host {$hostId}: roles must be an array of strings; contains at least one " . gettype($role) . " instead";
         parent::__construct(400, $msg, $msg);
     }
 }
\ No newline at end of file