ci-bonfire / Sprint

application/helpers/markdown_helper.php

Doc Comments +18 added lines

@@ -1122,6 +1122,10 @@ 
 
     var $list_level = 0;
 
+    /**
+     * @param string $list_str
+     * @param string $marker_any_re
+     */
     function processListItems($list_str, $marker_any_re)
     {
         #
@@ -1234,6 +1238,9 @@ 
         return "\n\n" . $this->hashBlock($codeblock) . "\n\n";
     }
 
+    /**
+     * @param string $code
+     */
     function makeCodeSpan($code)
     {
         #
@@ -1751,6 +1758,9 @@ 
     # hanlde UTF-8 if the default function does not exist.
     var $utf8_strlen = 'mb_strlen';
 
+    /**
+     * @param string $text
+     */
     function detab($text)
     {
         #
@@ -2340,6 +2350,11 @@ 
         return array($parsed, $text);
     }
 
+    /**
+     * @param string $text
+     * @param string $hash_method
+     * @param boolean $md_attr
+     */
     function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr)
     {
         #
@@ -3078,6 +3093,9 @@ 
         return $this->hashBlock($result) . "\n\n";
     }
 
+    /**
+     * @return string
+     */
     function processDefListItems($list_str)
     {
         #

Braces +3 added lines, -1 removed lines

@@ -1636,8 +1636,10 @@
                 $r = ($seed * (1 + $key)) % 100; # Pseudo-random function.
                 # roughly 10% raw, 45% hex, 45% dec
                 # '@' *must* be encoded. I insist.
-                if ($r > 90 && $char != '@') /* do nothing */ {
+                if ($r > 90 && $char != '@') {
+                	/* do nothing */ {
                     ;
+                }
                 } else if ($r < 45) {
                     $chars[$key] = '&#x' . dechex($ord) . ';';
                 } else {

application/libraries/Migration.php

Doc Comments +2 added lines, -2 removed lines

@@ -321,7 +321,7 @@ 
      *
      * @param string $type  Any key from _migration_paths, or {module_name}
      *
-     * @return bool|string
+     * @return false|string
      */
     public function get_latest($type='app')
     {
@@ -465,7 +465,7 @@ 
 	/**
 	 * Based on the 'type', determines the correct migration path.
 	 *
-	 * @param $type
+	 * @param string $type
 	 * @param bool $create
 	 *
 	 * @return null|string

Braces +3 added lines, -6 removed lines

@@ -208,8 +208,7 @@ 
         if ($this->_migration_type === 'sequential')
         {
             $target_version = sprintf('%03d', $target_version);
-        }
-        else
+        } else
         {
             $target_version = (string) $target_version;
         }
@@ -226,8 +225,7 @@ 
         {
             // Moving Up
             $method = 'up';
-        }
-        else
+        } else
         {
             // Moving Down, apply in reverse order
             $method = 'down';
@@ -437,8 +435,7 @@ 
         if ($this->_migration_type == 'timestamp')
         {
             $prefix = date('YmdHis');
-        }
-        else
+        } else
         {
             $prefix = str_pad($this->get_version() + 1, 3, '0', STR_PAD_LEFT);
         }

application/models/User_model.php

Doc Comments +1 added lines, -1 removed lines

@@ -292,7 +292,7 @@
      * @param $user_id
      * @param $key
      *
-     * @return bool
+     * @return false|null
      */
     public function removeMetaFromUser($user_id, $key)
     {

Braces +3 added lines, -6 removed lines

@@ -203,8 +203,7 @@ 
                 if ($query->num_rows() == 0)
                 {
                     $this->db->insert('user_meta', $obj);
-                }
-                else if ($query->num_rows() > 0)
+                } else if ($query->num_rows() > 0)
                 {
                     $this->db->where('user_id', $data['id'])
                              ->where('meta_key', $key)
@@ -304,8 +303,7 @@ 
 	    if (is_array($key))
 	    {
 		    $this->db->where_in('meta_key', $key);
-	    }
-	    else
+	    } else
 	    {
 		    $this->db->where('meta_key', $key);
 	    }
@@ -351,8 +349,7 @@ 
         if (is_object($data['fields']))
         {
             $data['fields']->meta = (object)$meta;
-        }
-        else
+        } else
         {
             $data['fields']['meta']= $meta;
         }

application/third_party/HMVC/Loader.php

Doc Comments +6 added lines, -6 removed lines

@@ -107,7 +107,7 @@ 
      * @param	string	the name of the class
      * @param	mixed	the optional parameters
      * @param	string	an optional object name
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function library($library = '', $params = NULL, $object_name = NULL) {
         if (is_array($library)) {
@@ -147,7 +147,7 @@ 
      * @param	string	the name of the class
      * @param	string	name for the model
      * @param	bool	database connection
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function model($model, $name = '', $db_conn = FALSE) {
         if (is_array($model)) {
@@ -232,7 +232,7 @@ 
      * @param	string
      * @param	bool
      * @param 	bool
-     * @return	void
+     * @return	boolean|null
      */
     public function config($file = '', $use_sections = FALSE, $fail_gracefully = FALSE) {
         // Detect module
@@ -263,7 +263,7 @@ 
      * This function loads the specified helper file.
      *
      * @param	mixed
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function helper($helper = array()) {
         if (is_array($helper)) {
@@ -300,7 +300,7 @@ 
      *
      * @param	array
      * @param	string
-     * @return	void
+     * @return	null|HMVC_Loader
      */
     public function language($file = array(), $lang = '') {
         if (is_array($file)) {
@@ -517,7 +517,7 @@ 
      * Searches a given module name. Returns the path if found, FALSE otherwise
      *
      * @param string $module
-     * @return string|boolean
+     * @return string|false
      */
     private function find_module($module) {
         $config = & $this->_ci_get_component('config');

Braces +2 added lines, -1 removed lines

@@ -29,8 +29,9 @@
  *
  */
 
-if (!defined("BASEPATH"))
+if (!defined("BASEPATH")) {
     exit("No direct script access allowed");
+}
 
 class HMVC_Loader extends CI_Loader {
 

build/lib/BaseBuilder.php

Doc Comments +8 added lines, -4 removed lines

@@ -21,8 +21,8 @@ 
 	 * Copies the entire contents of a single folder
 	 * into a source folder, recursively.
 	 *
-	 * @param $source
-	 * @param $destination
+	 * @param string $source
+	 * @param string $destination
 	 */
 	public function copyFolder($source, $destination)
 	{
@@ -71,8 +71,8 @@ 
 	 * Deletes all files and folders, recursively, within $path,
 	 * except for any files listed in the $leave_files array.
 	 *
-	 * @param $path
-	 * @param array $leave_files
+	 * @param string $path
+	 * @param string[] $leave_files
 	 */
 	public function cleanFolder($path, $leave_files=[])
 	{
@@ -97,6 +97,10 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $source
+	 * @param string $destination
+	 */
 	public function compressFolder($source, $destination, $include_dir=false)
 	{
 		if (! extension_loaded('zip') ) {

Braces +7 added lines, -10 removed lines

@@ -37,8 +37,7 @@ 
 				if ( is_dir($source .'/'. $file) )
 				{
 					$this->copyFolder($source .'/'. $file, $destination .'/'. $file);
-				}
-				else {
+				} else {
 					copy($source .'/'. $file, $destination .'/'. $file);
 				}
 			}
@@ -87,8 +86,7 @@ 
 			{
 				$this->cleanFolder($file, $leave_files);
 				rmdir($file);
-			}
-			else
+			} else
 			{
 				unlink($file);
 			}
@@ -147,22 +145,21 @@ 
 				$file = str_replace('\\', '/', $file);
 
 				// Ignore "." and ".." folders
-				if( in_array(substr($file, strrpos($file, '/')+1), array('.', '..', '.DS_Store')) )
-					continue;
+				if( in_array(substr($file, strrpos($file, '/')+1), array('.', '..', '.DS_Store')) ) {
+									continue;
+				}
 
 				$file = realpath($file);
 
 				if (is_dir($file) === true)
 				{
 					$zip->addEmptyDir(str_replace($source . '/', '', $file . '/'));
-				}
-				else if (is_file($file) === true)
+				} else if (is_file($file) === true)
 				{
 					$zip->addFromString(str_replace($source . '/', '', $file), file_get_contents($file));
 				}
 			}
-		}
-		else if (is_file($source) === true)
+		} else if (is_file($source) === true)
 		{
 			$zip->addFromString(basename($source), file_get_contents($source));
 		}

myth/_generators/Api/ApiGenerator.php

Doc Comments +17 added lines, -10 removed lines

@@ -103,7 +103,7 @@ 
 	 * Quickly creates boilerplate code for a new API resource.
 	 *
 	 * @param $segments
-	 * @param $quiet
+	 * @param boolean $quiet
 	 */
 	private function scaffold( $segments, $quiet )
 	{
@@ -220,6 +220,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	private function detectModel($name)
 	{
 		$model_name = ucfirst($name) .'_model.php';
@@ -242,8 +245,8 @@ 
     /**
      * Creates the new APIController - based resource with basic CRUD.
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      *
      * @return $this
@@ -271,8 +274,8 @@ 
     /**
      * Creates the language file to accompany the controller.
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      *
      * @return $this
@@ -297,8 +300,8 @@ 
      * Creates the API Blueprint file for that resource in
      * APPPATH/docs/api
      *
-     * @param $single
-     * @param $plural
+     * @param string $single
+     * @param string $plural
      * @param $version
      * @param $model
      *
@@ -349,7 +352,7 @@ 
      * Modifies the _toc.ini file (or creates) for the specified Blueprint docs.
      *
      * @param $plural
-     * @param $version
+     * @param string $version
      *
      * @return $this|bool
      */
@@ -385,7 +388,7 @@ 
      * Creates a generic representation of the object from the database
      * table.
      *
-     * @param $model
+     * @param string $model
      *
      * @return string
      */
@@ -537,6 +540,10 @@ 
 	//--------------------------------------------------------------------
 
 
+	/**
+	 * @param string $tpl
+	 * @param string $name
+	 */
 	private function makeMigration( $tpl, $name )
 	{
 		// Create the migration
@@ -561,7 +568,7 @@ 
 	/**
 	 * Modifies the config/api.php file and sets the Auth type
 	 *
-	 * @param $type
+	 * @param string $type
 	 */
 	private function setAuthType( $type )
 	{

Braces +3 added lines, -6 removed lines

@@ -228,8 +228,7 @@ 
 		{
 			CLI::write("\nUnable to find model named: {$model_name}");
 			$model_name = CLI::prompt('Model filename');
-		}
-		else
+		} else
 		{
 			CLI::write("Using model: ". CLI::color($model_name, 'yellow') );
 		}
@@ -423,12 +422,10 @@ 
             if ($field->name == 'email')
             {
                 $obj .= "\"someone@example.com\",\n";
-            }
-            else if (strpos('name', $field->name) !== false)
+            } else if (strpos('name', $field->name) !== false)
             {
                 $obj .= "\"Lefty\",\n";
-            }
-            else if (in_array($field->type, ['char', 'varchar', 'text']))
+            } else if (in_array($field->type, ['char', 'varchar', 'text']))
             {
                 $obj .= "\"Some default string\",\n";
             }

myth/_generators/Controller/ControllerGenerator.php

Doc Comments +7 added lines

@@ -97,6 +97,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	protected function quietSetOptions( $name )
 	{
 		$options = CLI::getOptions();
@@ -120,6 +123,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	protected function collectOptions( $name )
 	{
 		$options = CLI::getOptions();
@@ -159,6 +165,7 @@ 
 
 	/**
 	 * Generates the standard views for our CRUD methods.
+	 * @param string $name
 	 */
 	protected function createViews( $name )
 	{

Braces +2 added lines, -4 removed lines

@@ -62,8 +62,7 @@ 
 		if ( $quiet === FALSE )
 		{
 			$this->collectOptions( $name );
-		}
-		else
+		} else
 		{
 			$this->quietSetOptions( $name );
 		}
@@ -212,8 +211,7 @@ 
                 {
                     return NULL;
                 }
-            }
-            else
+            } else
             {
                 return NULL;
             }

myth/_generators/Migration/MigrationGenerator.php

Doc Comments +5 added lines, -2 removed lines

@@ -159,7 +159,7 @@ 
 	 *  'create_user_table'         action = 'create', table = 'user'
 	 *  'add_name_to_user_table     action = 'add', table = 'user'
 	 *
-	 * @param $name
+	 * @param string $name
 	 */
 	public function detectAction($name)
 	{
@@ -199,6 +199,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $name
+	 */
 	public function collectOptions($name, $quiet=false)
 	{
 		$options = CLI::getOptions();
@@ -308,7 +311,7 @@ 
 	 * Reads the fields from an existing table and fills out our
 	 * $fields array and $primary key information.
 	 *
-	 * @param $table
+	 * @param string $table
 	 */
 	protected function readTable($table)
 	{

Braces +5 added lines, -5 removed lines

@@ -278,8 +278,7 @@ 
 			if (! empty($size))
 			{
 				$f['constraint'] = (int)$size;
-			}
-			else if (array_key_exists($type, $this->defaultSizes))
+			} else if (array_key_exists($type, $this->defaultSizes))
 			{
 				$f['constraint'] = $this->defaultSizes[$type];
 			}
@@ -342,14 +341,15 @@ 
 			if (! empty($field->max_length))
 			{
 				$f['constraint'] = $field->max_length;
-			}
-			else if (array_key_exists($field->type, $this->defaultSizes))
+			} else if (array_key_exists($field->type, $this->defaultSizes))
 			{
 				$f['constraint'] = $this->defaultSizes[ $field->type ];
 			}
 
 			// Default
-			if (! empty($field->default)) $f['default'] = $field->default;
+			if (! empty($field->default)) {
+				$f['default'] = $field->default;
+			}
 
 			// Primary Key?
 			if (! empty($field->primary_key) && $field->primary_key == 1)

myth/_generators/Model/ModelGenerator.php

Doc Comments +7 added lines

@@ -107,6 +107,10 @@ 
 	/*
 	 * Customizes our settings
 	 */
+
+	/**
+	 * @param string $model_name
+	 */
 	protected function collectOptions( $model_name, $options=[] )
 	{
 		$this->load->helper( 'inflector' );
@@ -180,6 +184,9 @@ 
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * @param string $model_name
+	 */
 	protected function quietSetOptions( $model_name, $options=[] )
 	{
 		$this->load->helper( 'inflector' );

Braces +2 added lines, -4 removed lines

@@ -79,8 +79,7 @@ 
 		if ( $quiet === false )
 		{
 			$this->collectOptions( $name, $options );
-		}
-		else
+		} else
 		{
 			$this->quietSetOptions( $name, $options );
 		}
@@ -219,8 +218,7 @@ 
             }
 
             $fields = $this->parseFieldString($options['fields']);
-		}
-        else
+		} else
         {
             $fields = $this->db->field_data( $table_name );
         }