datasift / storyplayer

src/php/DataSift/Storyplayer/ConfigLib/ActiveConfig.php

Doc Comments +6 added lines

@@ -105,11 +105,17 @@
         $activeConfig->roles = $rolesTable->$testEnvName;
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeStoryplayerConfig($injectables, $spConf)
 	{
 		$this->mergeData('storyplayer', $spConf);
 	}
 
+	/**
+	 * @param Injectables $injectables
+	 */
 	public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
 	{
         // do we have a system under test?

Indentation +27 added lines, -27 removed lines

@@ -75,43 +75,43 @@ 
  */
 class ActiveConfig extends WrappedConfig
 {
-	public function init(Injectables $injectables)
-	{
-		// we start off with the built-in config
-		$this->mergeData('storyplayer', $injectables->defaultConfig);
-
-		// these are the initial variables we want
-		$this->setData('storyplayer.ipAddress', $this->getHostIpAddress());
-		$this->setData('storyplayer.currentDir', getcwd());
-		$this->setData('storyplayer.user.home', getenv('HOME'));
-
-		// we also want to link in the hosts and roles tables, to make
-		// it a lot easier for Prose modules
-		$activeConfig         = $this->getConfig();
+    public function init(Injectables $injectables)
+    {
+        // we start off with the built-in config
+        $this->mergeData('storyplayer', $injectables->defaultConfig);
+
+        // these are the initial variables we want
+        $this->setData('storyplayer.ipAddress', $this->getHostIpAddress());
+        $this->setData('storyplayer.currentDir', getcwd());
+        $this->setData('storyplayer.user.home', getenv('HOME'));
+
+        // we also want to link in the hosts and roles tables, to make
+        // it a lot easier for Prose modules
+        $activeConfig         = $this->getConfig();
         $runtimeConfig        = $injectables->getRuntimeConfig();
         $runtimeConfigManager = $injectables->getRuntimeConfigManager();
         $testEnvName          = $injectables->activeTestEnvironmentName;
 
-		$hostsTable = $runtimeConfigManager->getTable($runtimeConfig, 'hosts');
+        $hostsTable = $runtimeConfigManager->getTable($runtimeConfig, 'hosts');
         if (!isset($hostsTable->$testEnvName)) {
             $hostsTable->$testEnvName = new BaseObject;
         }
         $activeConfig->hosts = $hostsTable->$testEnvName;
 
-		$rolesTable = $runtimeConfigManager->getTable($runtimeConfig, 'roles');
+        $rolesTable = $runtimeConfigManager->getTable($runtimeConfig, 'roles');
         if (!isset($rolesTable->$testEnvName)) {
             $rolesTable->$testEnvName = new BaseObject;
         }
         $activeConfig->roles = $rolesTable->$testEnvName;
-	}
+    }
 
-	public function mergeStoryplayerConfig($injectables, $spConf)
-	{
-		$this->mergeData('storyplayer', $spConf);
-	}
+    public function mergeStoryplayerConfig($injectables, $spConf)
+    {
+        $this->mergeData('storyplayer', $spConf);
+    }
 
-	public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
-	{
+    public function mergeSystemUnderTestConfig($injectables, SystemUnderTestConfig $sutConfig = null)
+    {
         // do we have a system under test?
         if (!isset($injectables->activeSystemUnderTestName) || $sutConfig === null) {
             $this->setData('systemundertest', null);
@@ -123,7 +123,7 @@ 
 
         // merge in the loaded config
         $this->mergeData('systemundertest', $sutConfig->getConfig());
-	}
+    }
 
     /**
      *
@@ -131,8 +131,8 @@ 
      * @param  \DataSift\Storyplayer\TestEnvironmentsLib\TestEnvironmentsConfig|\DataSift\Storyplayer\DefinitionLib\TestEnvironment_Definition $envConfig
      * @return void
      */
-	public function mergeTestEnvironmentConfig($injectables, $envConfig = null)
-	{
+    public function mergeTestEnvironmentConfig($injectables, $envConfig = null)
+    {
         // do we have a test environment?
         if (!isset($injectables->activeTestEnvironmentName) || $envConfig === null) {
             $this->setData('target', null);
@@ -143,8 +143,8 @@ 
         $this->setData('target.name', $injectables->activeTestEnvironmentName);
 
         // merge in the loaded config
-		$this->mergeData('target', $envConfig->getConfig());
-	}
+        $this->mergeData('target', $envConfig->getConfig());
+    }
 
     protected function getHostIpAddress()
     {

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
 
 		// we also want to link in the hosts and roles tables, to make
 		// it a lot easier for Prose modules
-		$activeConfig         = $this->getConfig();
+		$activeConfig = $this->getConfig();
         $runtimeConfig        = $injectables->getRuntimeConfig();
         $runtimeConfigManager = $injectables->getRuntimeConfigManager();
         $testEnvName          = $injectables->activeTestEnvironmentName;
@@ -179,7 +179,7 @@ 
                 // does the adapter have an IP address?
                 try {
                     $ipAddress = $netifaces->getIpAddress($adapterToTest);
-                } catch(NetifacesException $e){
+                } catch (NetifacesException $e) {
                     // We couldn't get an IP address
                     $ipAddress = null;
                 }
@@ -213,7 +213,7 @@ 
             // this sucks
             throw new NetifacesException("Unable to determine IP address");
 
-        } catch (NetifacesException $e){
+        } catch (NetifacesException $e) {
             throw new Exception("could not determine IP address of host machine");
         }
     }

Braces +4 added lines, -2 removed lines

@@ -179,7 +179,8 @@ 
                 // does the adapter have an IP address?
                 try {
                     $ipAddress = $netifaces->getIpAddress($adapterToTest);
-                } catch(NetifacesException $e){
+                }
+                catch(NetifacesException $e) {
                     // We couldn't get an IP address
                     $ipAddress = null;
                 }
@@ -213,7 +214,8 @@ 
             // this sucks
             throw new NetifacesException("Unable to determine IP address");
 
-        } catch (NetifacesException $e){
+        }
+        catch (NetifacesException $e) {
             throw new Exception("could not determine IP address of host machine");
         }
     }

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

Doc Comments +5 added lines, -2 removed lines

@@ -83,6 +83,8 @@ 
 
     /**
      * constructor
+     * @param string $configType
+     * @param string[] $searchFolders
      */
     public function __construct($configType, $searchFolders)
     {
@@ -195,6 +197,7 @@ 
     /**
      * build a list of the config files in the $searchFolder
      *
+     * @param string $searchPattern
      * @return array<string>
      */
     protected function findConfigFilenames($searchPattern)
@@ -329,7 +332,7 @@ 
     /**
      * returns our list of all known configs
      *
-     * @return array
+     * @return SystemUnderTestConfig[]
      */
     public function getEntries()
     {
@@ -339,7 +342,7 @@ 
     /**
      * returns the names of all of the entries in our list
      *
-     * @return array<string>
+     * @return integer[]
      */
     public function getEntryNames()
     {

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);
         }
     }

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/GroupDefinition.php

Doc Comments +2 added lines, -2 removed lines

@@ -220,7 +220,7 @@ 
     /**
      * how should we provision this environment?
      *
-     * @return array<ProvisioningAdapters>
+     * @return ProvisioningAdapter[]
      */
     public function getProvisioningAdapters()
     {
@@ -265,7 +265,7 @@ 
     /**
      * what hosts exist in this group?
      *
-     * @return array<TestEnvironment_HostDefinition>
+     * @return TestEnvironmentHost[]
      */
     public function getHosts()
     {

src/php/DataSift/Storyplayer/DefinitionLib/TestEnvironment/HostDefinition.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
      */
     protected $storySettings;
 
+    /**
+     * @param string $hostId
+     */
     public function __construct(TestEnvironment_GroupDefinition $parentGroup, $hostId)
     {
         $this->setParentGroup($parentGroup);

src/php/DataSift/Storyplayer/functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
  * this function avoids reset()ing the array, so it will not mess with
  * any iteration that you may currently be part-way through
  *
- * @param  array $arrayToSearch
+ * @param  Storyplayer\TestEnvironments\ProvisioningAdapter[] $arrayToSearch
  *         the array to get the first element of
  * @return mixed
  *         the first element of $array, or NULL if the array is empty
@@ -95,7 +95,7 @@ 
 /**
  * Create a new test environment object
  *
- * @return TestEnvironment
+ * @return TestEnvironment_Definition
  *         the test environment object to use in the script
  */
 function newTestEnvironment()

Braces +2 added lines, -1 removed lines

@@ -115,7 +115,8 @@
  * @param  callback $callback the action(s) to attempt
  * @return void
  */
-function tryTo($callback) {
+function tryTo($callback)
+{
     try {
         $callback();
     }

src/php/DataSift/Storyplayer/OutputLib/CodeParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
 
     /**
      * @param  string $filename
-     * @return bool
+     * @return null|boolean
      */
     public function buildParseTreeForFile($filename)
     {

Spacing +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
         // we are looking for
         $lastStmt = null;
 
-        foreach($stmts as $stmt) {
+        foreach ($stmts as $stmt) {
             // where are we?
             $currentLine = $stmt->getLine();
             // var_dump($currentLine, $stmt->getType());

Braces +3 added lines, -6 removed lines

@@ -122,8 +122,7 @@ 
         ];
 
         // find the code that is executing
-        foreach ($stackTrace as $index => $stackEntry)
-        {
+        foreach ($stackTrace as $index => $stackEntry) {
             if (!isset($stackEntry['file'])) {
                 continue;
             }
@@ -173,8 +172,7 @@ 
     public function getCodeFor($filename, $lineToFind)
     {
         // do we have a parser tree for this file?
-        if (!isset($this->parserTrees[$filename]))
-        {
+        if (!isset($this->parserTrees[$filename])) {
             // attempt to build a parse tree
             if (!$this->buildParseTreeForFile($filename)) {
 
@@ -240,8 +238,7 @@ 
         // what are we looking at?
         $nodeType = $stmt->getType();
 
-        switch ($nodeType)
-        {
+        switch ($nodeType) {
             case 'Arg':
                 // this is an argument to an expression
                 //

src/php/DataSift/Storyplayer/PlayerLib/StoryTeller.php

Doc Comments +12 added lines, -1 removed lines

@@ -438,6 +438,7 @@ 
     }
 
     /**
+     * @param Prose_Loader $proseLoader
      * @return void
      */
     public function setProseLoader($proseLoader)
@@ -454,6 +455,9 @@ 
         return $this->phaseLoader;
     }
 
+    /**
+     * @param Phase_Loader $phaseLoader
+     */
     public function setPhaseLoader($phaseLoader)
     {
         $this->phaseLoader = $phaseLoader;
@@ -483,11 +487,17 @@ 
         return $this->codeParser;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\CodeParser $codeParser
+     */
     public function setCodeParser($codeParser)
     {
         $this->codeParser = $codeParser;
     }
 
+    /**
+     * @param \DataSift\Storyplayer\OutputLib\DataFormatter $dataFormatter
+     */
     public function setDataFormatter($dataFormatter)
     {
         $this->dataFormatter = $dataFormatter;
@@ -520,6 +530,7 @@ 
     }
 
     /**
+     * @param \DataSift\Storyplayer\ConfigLib\ActiveConfig $config
      * @return void
      */
     public function setConfig($config)
@@ -783,7 +794,7 @@ 
      *
      * @param  string $methodName
      * @param  array  $methodArgs
-     * @return mixed
+     * @return \Prose\Prose
      */
     public function __call($methodName, $methodArgs)
     {

Spacing +2 added lines, -2 removed lines

@@ -962,7 +962,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }
@@ -1001,7 +1001,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }

Braces +20 added lines, -14 removed lines

@@ -281,7 +281,8 @@ 
      *
      * @return Action_Logger
      */
-    public function getActionLogger() {
+    public function getActionLogger()
+    {
         return $this->actionLogger;
     }
 
@@ -291,7 +292,8 @@ 
      * @param Action_Logger $actionLogger
      * @return StoryTeller
      */
-    public function setActionLogger(Action_Logger $actionLogger) {
+    public function setActionLogger(Action_Logger $actionLogger)
+    {
         $this->actionLogger = $actionLogger;
 
         return $this;
@@ -302,7 +304,8 @@ 
      *
      * @return Story_Checkpoint
      */
-    public function getCheckpoint() {
+    public function getCheckpoint()
+    {
         return $this->checkpoint;
     }
 
@@ -312,7 +315,8 @@ 
      * @param Story_Checkpoint $checkpoint
      * @return StoryTeller
      */
-    public function setCheckpoint(Story_Checkpoint $checkpoint) {
+    public function setCheckpoint(Story_Checkpoint $checkpoint)
+    {
         $this->checkpoint = $checkpoint;
 
         return $this;
@@ -323,7 +327,8 @@ 
      *
      * @return PageContext
      */
-    public function getPageContext() {
+    public function getPageContext()
+    {
         return $this->pageContext;
     }
 
@@ -333,7 +338,8 @@ 
      * @param PageContext $pageContext
      * @return StoryTeller
      */
-    public function setPageContext(PageContext $pageContext) {
+    public function setPageContext(PageContext $pageContext)
+    {
         $this->pageContext = $pageContext;
 
         return $this;
@@ -393,7 +399,8 @@ 
      *
      * @return RuntimeConfigManager
      */
-    public function getRuntimeConfigManager() {
+    public function getRuntimeConfigManager()
+    {
         return $this->runtimeConfigManager;
     }
 
@@ -403,7 +410,8 @@ 
      * @param RuntimeConfigManager $runtimeConfigManager
      * @return StoryTeller
      */
-    public function setRuntimeConfigManager(RuntimeConfigManager $runtimeConfigManager) {
+    public function setRuntimeConfigManager(RuntimeConfigManager $runtimeConfigManager)
+    {
         $this->runtimeConfigManager = $runtimeConfigManager;
 
         return $this;
@@ -906,13 +914,11 @@ 
      */
     public function getRunningDevice()
     {
-        if (!is_object($this->deviceAdapter))
-        {
+        if (!is_object($this->deviceAdapter)) {
             $this->startDevice();
         }
 
-        if (!is_object($this->deviceAdapter))
-        {
+        if (!is_object($this->deviceAdapter)) {
             throw new E5xx_CannotStartDevice();
         }
 
@@ -962,7 +968,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }
@@ -1001,7 +1007,7 @@ 
             // we do not need to wrap these in a TRY/CATCH block,
             // as we are already running inside one of the story's
             // phases
-            foreach ($callbacks as $callback){
+            foreach ($callbacks as $callback) {
                 call_user_func($callback, $this);
             }
         }

src/php/DataSift/Storyplayer/Reports/TapReport.php

Doc Comments -1 removed lines

@@ -177,7 +177,6 @@
     }
 
     /**
-     * @param integer $level
      * @param string $msg
      * @return void
      */

src/php/Prose/BaseCleanup.php

Doc Comments +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      * __construct
      *
      * @param StoryTeller $st The StoryTeller object
-     * @param array $args Any arguments to be used in this Prose module
+     * @param string[] $args Any arguments to be used in this Prose module
      *
      * @return parent::__construct
      */