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)
     {
         #

Spacing +198 added lines, -198 removed lines

@@ -58,7 +58,7 @@ 
 #
     # Setup static parser variable.
     static $parser;
-    if (!isset($parser)) {
+    if ( ! isset($parser)) {
         $parser_class = MARKDOWN_PARSER_CLASS;
         $parser       = new $parser_class;
     }
@@ -108,14 +108,14 @@ 
     function mdwp_MarkdownPost($text)
     {
         static $parser;
-        if (!$parser) {
+        if ( ! $parser) {
             $parser_class = MARKDOWN_PARSER_CLASS;
             $parser       = new $parser_class;
         }
         if (is_single() || is_page() || is_feed()) {
             $parser->fn_id_prefix = "";
         } else {
-            $parser->fn_id_prefix = get_the_ID() . ".";
+            $parser->fn_id_prefix = get_the_ID().".";
         }
         return $parser->transform($text);
     }
@@ -136,14 +136,14 @@ 
         add_filter('get_comment_excerpt', 'mdwp_strip_p', 7);
 
         global $mdwp_hidden_tags, $mdwp_placeholders;
-        $mdwp_hidden_tags  = explode(
+        $mdwp_hidden_tags = explode(
             ' ',
             '<p> </p> <pre> </pre> <ol> </ol> <ul> </ul> <li> </li>'
         );
         $mdwp_placeholders = explode(
             ' ',
             str_rot13(
-                'pEj07ZbbBZ U1kqgh4w4p pre2zmeN6K QTi31t9pre ol0MP1jzJR ' .
+                'pEj07ZbbBZ U1kqgh4w4p pre2zmeN6K QTi31t9pre ol0MP1jzJR '.
                 'ML5IjmbRol ulANi1NsGY J7zRLJqPul liA8ctl16T K9nhooUHli'
             )
         );
@@ -151,8 +151,8 @@ 
 
     function mdwp_add_p($text)
     {
-        if (!preg_match('{^$|^<(p|ul|ol|dl|pre|blockquote)>}i', $text)) {
-            $text = '<p>' . $text . '</p>';
+        if ( ! preg_match('{^$|^<(p|ul|ol|dl|pre|blockquote)>}i', $text)) {
+            $text = '<p>'.$text.'</p>';
             $text = preg_replace('{\n{2,}}', "</p>\n\n<p>", $text);
         }
         return $text;
@@ -279,14 +279,14 @@ 
         $this->prepareItalicsAndBold();
 
         $this->nested_brackets_re =
-            str_repeat('(?>[^\[\]]+|\[', $this->nested_brackets_depth) .
+            str_repeat('(?>[^\[\]]+|\[', $this->nested_brackets_depth).
             str_repeat('\])*', $this->nested_brackets_depth);
 
         $this->nested_url_parenthesis_re =
-            str_repeat('(?>[^()\s]+|\(', $this->nested_url_parenthesis_depth) .
+            str_repeat('(?>[^()\s]+|\(', $this->nested_url_parenthesis_depth).
             str_repeat('(?>\)))*', $this->nested_url_parenthesis_depth);
 
-        $this->escape_chars_re = '[' . preg_quote($this->escape_chars) . ']';
+        $this->escape_chars_re = '['.preg_quote($this->escape_chars).']';
 
         # Sort document, block, and span gamut in ascendent priority order.
         asort($this->document_gamut);
@@ -366,7 +366,7 @@ 
 
         $this->teardown();
 
-        return $text . "\n";
+        return $text."\n";
     }
 
     var $document_gamut = array(
@@ -386,7 +386,7 @@ 
         # Link defs are in the form: ^[id]: url "optional title"
         $text = preg_replace_callback(
             '{
-							^[ ]{0,' . $less_than_tab . '}\[(.+)\][ ]?:	# id = $1
+							^[ ]{0,' . $less_than_tab.'}\[(.+)\][ ]?:	# id = $1
 							  [ ]*
 							  \n?				# maybe *one* newline
 							  [ ]*
@@ -418,7 +418,7 @@ 
         $link_id                = strtolower($matches[1]);
         $url                    = $matches[2] == '' ? $matches[3] : $matches[2];
         $this->urls[$link_id]   = $url;
-        $this->titles[$link_id] =& $matches[4];
+        $this->titles[$link_id] = & $matches[4];
         return ''; # String that will replace the block
     }
 
@@ -444,9 +444,9 @@ 
         # *  List "b" is made of tags which are always block-level;
         #
         $block_tags_a_re = 'ins|del';
-        $block_tags_b_re = 'p|div|h[1-6]|blockquote|pre|table|dl|ol|ul|address|' .
-                           'script|noscript|form|fieldset|iframe|math|svg|' .
-                           'article|section|nav|aside|hgroup|header|footer|' .
+        $block_tags_b_re = 'p|div|h[1-6]|blockquote|pre|table|dl|ol|ul|address|'.
+                           'script|noscript|form|fieldset|iframe|math|svg|'.
+                           'article|section|nav|aside|hgroup|header|footer|'.
                            'figure';
 
         # Regular expression for the content of a block tag.
@@ -465,21 +465,21 @@ 
 			  )*
 			)?
 			';
-        $content           =
+        $content =
             str_repeat(
                 '
 				(?>
 				  [^<]+			# content without tag
 				|
 				  <\2			# nested opening tag
-					' . $attr . '	# attributes
+					' . $attr.'	# attributes
 					(?>
 					  />
 					|
 					  >',
                 $nested_tags_level
-            ) . # end of opening tag
-            '.*?' . # last level nested tag content
+            ).# end of opening tag
+            '.*?'.# last level nested tag content
             str_repeat(
                 '
 					  </\2\s*>	# closing nested tag
@@ -490,7 +490,7 @@ 
 				)*',
                 $nested_tags_level
             );
-        $content2          = str_replace('\2', '\3', $content);
+        $content2 = str_replace('\2', '\3', $content);
 
         # First, look for nested blocks, e.g.:
         # 	<div>
@@ -515,20 +515,20 @@ 
 			  # Match from `\n<tag>` to `</tag>\n`, handling nested tags
 			  # in between.
 
-						[ ]{0,' . $less_than_tab . '}
-						<(' . $block_tags_b_re . ')# start tag = $2
-						' . $attr . '>			# attributes followed by > and \n
-						' . $content . '		# content, support nesting
+						[ ]{0,' . $less_than_tab.'}
+						<(' . $block_tags_b_re.')# start tag = $2
+						' . $attr.'>			# attributes followed by > and \n
+						' . $content.'		# content, support nesting
 						</\2>				# the matching end tag
 						[ ]*				# trailing spaces/tabs
 						(?=\n+|\Z)	# followed by a newline or end of document
 
 			| # Special version for tags of group a.
 
-						[ ]{0,' . $less_than_tab . '}
-						<(' . $block_tags_a_re . ')# start tag = $3
-						' . $attr . '>[ ]*\n	# attributes followed by >
-						' . $content2 . '		# content, support nesting
+						[ ]{0,' . $less_than_tab.'}
+						<(' . $block_tags_a_re.')# start tag = $3
+						' . $attr.'>[ ]*\n	# attributes followed by >
+						' . $content2.'		# content, support nesting
 						</\3>				# the matching end tag
 						[ ]*				# trailing spaces/tabs
 						(?=\n+|\Z)	# followed by a newline or end of document
@@ -536,16 +536,16 @@ 
 			| # Special case just for <hr />. It was easier to make a special
 			  # case than to make the other regex more complicated.
 
-						[ ]{0,' . $less_than_tab . '}
+						[ ]{0,' . $less_than_tab.'}
 						<(hr)				# start tag = $2
-						' . $attr . '			# attributes
+						' . $attr.'			# attributes
 						/?>					# the matching end tag
 						[ ]*
 						(?=\n{2,}|\Z)		# followed by a blank line or end of document
 
 			| # Special case for standalone HTML comments:
 
-					[ ]{0,' . $less_than_tab . '}
+					[ ]{0,' . $less_than_tab.'}
 					(?s:
 						<!-- .*? -->
 					)
@@ -554,7 +554,7 @@ 
 
 			| # PHP and ASP-style processor instructions (<? and <%)
 
-					[ ]{0,' . $less_than_tab . '}
+					[ ]{0,' . $less_than_tab.'}
 					(?s:
 						<([?%])			# $2
 						.*?
@@ -597,7 +597,7 @@ 
 
         # Then hash the block.
         static $i = 0;
-        $key                     = "$boundary\x1A" . ++ $i . $boundary;
+        $key                     = "$boundary\x1A".++ $i.$boundary;
         $this->html_hashes[$key] = $text;
         return $key; # String that will replace the tag.
     }
@@ -668,7 +668,7 @@ 
 				[ ]*		# Tailing spaces
 				$			# End of line.
 			}mx',
-            "\n" . $this->hashBlock("<hr$this->empty_element_suffix") . "\n",
+            "\n".$this->hashBlock("<hr$this->empty_element_suffix")."\n",
             $text
         );
     }
@@ -680,7 +680,7 @@ 
         #
         # Process character escapes, code spans, and inline HTML
         # in one shot.
-        "parseSpan"           => - 30,
+        "parseSpan"           => -30,
         # Process anchor and image tags. Images must come first,
         # because ![foo][f] looks like an anchor.
         "doImages"            => 10,
@@ -738,7 +738,7 @@ 
             '{
 			(					# wrap whole match in $1
 			  \[
-				(' . $this->nested_brackets_re . ')	# link text = $2
+				(' . $this->nested_brackets_re.')	# link text = $2
 			  \]
 
 			  [ ]?				# one optional space
@@ -760,14 +760,14 @@ 
             '{
 			(				# wrap whole match in $1
 			  \[
-				(' . $this->nested_brackets_re . ')	# link text = $2
+				(' . $this->nested_brackets_re.')	# link text = $2
 			  \]
 			  \(			# literal paren
 				[ \n]*
 				(?:
 					<(.+?)>	# href = $3
 				|
-					(' . $this->nested_url_parenthesis_re . ')	# href = $4
+					(' . $this->nested_url_parenthesis_re.')	# href = $4
 				)
 				[ \n]*
 				(			# $5
@@ -808,7 +808,7 @@ 
     {
         $whole_match = $matches[1];
         $link_text   = $matches[2];
-        $link_id     =& $matches[3];
+        $link_id     = & $matches[3];
 
         if ($link_id == "") {
             # for shortcut links like [this][] or [this].
@@ -844,7 +844,7 @@ 
         $whole_match = $matches[1];
         $link_text   = $this->runSpanGamut($matches[2]);
         $url         = $matches[3] == '' ? $matches[4] : $matches[3];
-        $title       =& $matches[7];
+        $title       = & $matches[7];
 
         $url = $this->encodeAttribute($url);
 
@@ -872,7 +872,7 @@ 
             '{
 			(				# wrap whole match in $1
 			  !\[
-				(' . $this->nested_brackets_re . ')		# alt text = $2
+				(' . $this->nested_brackets_re.')		# alt text = $2
 			  \]
 
 			  [ ]?				# one optional space
@@ -896,7 +896,7 @@ 
             '{
 			(				# wrap whole match in $1
 			  !\[
-				(' . $this->nested_brackets_re . ')		# alt text = $2
+				(' . $this->nested_brackets_re.')		# alt text = $2
 			  \]
 			  \s?			# One optional whitespace character
 			  \(			# literal paren
@@ -904,7 +904,7 @@ 
 				(?:
 					<(\S*)>	# src url = $3
 				|
-					(' . $this->nested_url_parenthesis_re . ')	# src url = $4
+					(' . $this->nested_url_parenthesis_re.')	# src url = $4
 				)
 				[ \n]*
 				(			# $5
@@ -957,7 +957,7 @@ 
         $whole_match = $matches[1];
         $alt_text    = $matches[2];
         $url         = $matches[3] == '' ? $matches[4] : $matches[3];
-        $title       =& $matches[7];
+        $title       = & $matches[7];
 
         $alt_text = $this->encodeAttribute($alt_text);
         $url      = $this->encodeAttribute($url);
@@ -1017,15 +1017,15 @@ 
         }
 
         $level = $matches[2]{0} == '=' ? 1 : 2;
-        $block = "<h$level>" . $this->runSpanGamut($matches[1]) . "</h$level>";
-        return "\n" . $this->hashBlock($block) . "\n\n";
+        $block = "<h$level>".$this->runSpanGamut($matches[1])."</h$level>";
+        return "\n".$this->hashBlock($block)."\n\n";
     }
 
     function _doHeaders_callback_atx($matches)
     {
         $level = strlen($matches[1]);
-        $block = "<h$level>" . $this->runSpanGamut($matches[2]) . "</h$level>";
-        return "\n" . $this->hashBlock($block) . "\n\n";
+        $block = "<h$level>".$this->runSpanGamut($matches[2])."</h$level>";
+        return "\n".$this->hashBlock($block)."\n\n";
     }
 
     function doLists($text)
@@ -1050,8 +1050,8 @@ 
             $whole_list_re = '
 				(								# $1 = whole list
 				  (								# $2
-					([ ]{0,' . $less_than_tab . '})	# $3 = number of spaces
-					(' . $marker_re . ')			# $4 = first list item marker
+					([ ]{0,' . $less_than_tab.'})	# $3 = number of spaces
+					(' . $marker_re.')			# $4 = first list item marker
 					[ ]+
 				  )
 				  (?s:.+?)
@@ -1062,13 +1062,13 @@ 
 					  (?=\S)
 					  (?!						# Negative lookahead for another list item marker
 						[ ]*
-						' . $marker_re . '[ ]+
+						' . $marker_re.'[ ]+
 					  )
 					|
 					  (?=						# Lookahead for another kind of list
 					    \n
 						\3						# Must have the same indentation
-						' . $other_marker_re . '[ ]+
+						' . $other_marker_re.'[ ]+
 					  )
 				  )
 				)
@@ -1081,7 +1081,7 @@ 
                 $text = preg_replace_callback(
                     '{
 						^
-						' . $whole_list_re . '
+						' . $whole_list_re.'
 					}mx',
                     array(&$this, '_doLists_callback'),
                     $text
@@ -1090,7 +1090,7 @@ 
                 $text = preg_replace_callback(
                     '{
 						(?:(?<=\n)\n|\A\n?) # Must eat the newline
-						' . $whole_list_re . '
+						' . $whole_list_re.'
 					}mx',
                     array(&$this, '_doLists_callback'),
                     $text
@@ -1116,8 +1116,8 @@ 
         $list .= "\n";
         $result = $this->processListItems($list, $marker_any_re);
 
-        $result = $this->hashBlock("<$list_type>\n" . $result . "</$list_type>");
-        return "\n" . $result . "\n\n";
+        $result = $this->hashBlock("<$list_type>\n".$result."</$list_type>");
+        return "\n".$result."\n\n";
     }
 
     var $list_level = 0;
@@ -1149,7 +1149,7 @@ 
         # change the syntax rules such that sub-lists must start with a
         # starting cardinal number; e.g. "1." or "a.".
 
-        $this->list_level ++;
+        $this->list_level++;
 
         # trim trailing blank lines:
         $list_str = preg_replace("/\n{2,}\\z/", "\n", $list_str);
@@ -1158,35 +1158,35 @@ 
             '{
 			(\n)?							# leading line = $1
 			(^[ ]*)							# leading whitespace = $2
-			(' . $marker_any_re . '				# list marker and space = $3
+			(' . $marker_any_re.'				# list marker and space = $3
 				(?:[ ]+|(?=\n))	# space only required if item is not empty
 			)
 			((?s:.*?))						# list item text   = $4
 			(?:(\n+(?=\n))|\n)				# tailing blank line = $5
-			(?= \n* (\z | \2 (' . $marker_any_re . ') (?:[ ]+|(?=\n))))
+			(?= \n* (\z | \2 (' . $marker_any_re.') (?:[ ]+|(?=\n))))
 			}xm',
             array(&$this, '_processListItems_callback'),
             $list_str
         );
 
-        $this->list_level --;
+        $this->list_level--;
         return $list_str;
     }
 
     function _processListItems_callback($matches)
     {
         $item               = $matches[4];
-        $leading_line       =& $matches[1];
-        $leading_space      =& $matches[2];
+        $leading_line       = & $matches[1];
+        $leading_space      = & $matches[2];
         $marker_space       = $matches[3];
-        $tailing_blank_line =& $matches[5];
+        $tailing_blank_line = & $matches[5];
 
         if ($leading_line || $tailing_blank_line ||
             preg_match('/\n{2,}/', $item)
         ) {
             # Replace marker with the appropriate whitespace indentation
-            $item = $leading_space . str_repeat(' ', strlen($marker_space)) . $item;
-            $item = $this->runBlockGamut($this->outdent($item) . "\n");
+            $item = $leading_space.str_repeat(' ', strlen($marker_space)).$item;
+            $item = $this->runBlockGamut($this->outdent($item)."\n");
         } else {
             # Recursion for sub-lists:
             $item = $this->doLists($this->outdent($item));
@@ -1194,7 +1194,7 @@ 
             $item = $this->runSpanGamut($item);
         }
 
-        return "<li>" . $item . "</li>\n";
+        return "<li>".$item."</li>\n";
     }
 
     function doCodeBlocks($text)
@@ -1207,11 +1207,11 @@ 
 				(?:\n\n|\A\n?)
 				(	            # $1 = the code block -- one or more lines, starting with a space/tab
 				  (?>
-					[ ]{' . $this->tab_width . '}  # Lines must start with a tab or a tab-width of spaces
+					[ ]{' . $this->tab_width.'}  # Lines must start with a tab or a tab-width of spaces
 					.*\n+
 				  )+
 				)
-				((?=^[ ]{0,' . $this->tab_width . '}\S)|\Z)	# Lookahead for non-space at line-start, or end of doc
+				((?=^[ ]{0,' . $this->tab_width.'}\S)|\Z)	# Lookahead for non-space at line-start, or end of doc
 			}xm',
             array(&$this, '_doCodeBlocks_callback'),
             $text
@@ -1231,7 +1231,7 @@ 
         $codeblock = preg_replace('/\A\n+|\n+\z/', '', $codeblock);
 
         $codeblock = "<pre><code>$codeblock\n</code></pre>";
-        return "\n\n" . $this->hashBlock($codeblock) . "\n\n";
+        return "\n\n".$this->hashBlock($codeblock)."\n\n";
     }
 
     function makeCodeSpan($code)
@@ -1280,7 +1280,7 @@ 
                 $token_relist[] = $strong_re;
 
                 # Construct master expression from list.
-                $token_re                                      = '{(' . implode('|', $token_relist) . ')}';
+                $token_re                                      = '{('.implode('|', $token_relist).')}';
                 $this->em_strong_prepared_relist["$em$strong"] = $token_re;
             }
         }
@@ -1307,8 +1307,8 @@ 
             #
             $parts = preg_split($token_re, $text, 2, PREG_SPLIT_DELIM_CAPTURE);
             $text_stack[0] .= $parts[0];
-            $token =& $parts[1];
-            $text  =& $parts[2];
+            $token = & $parts[1];
+            $text  = & $parts[2];
 
             if (empty($token)) {
                 # Reached end of text span: empty stack without emitting.
@@ -1445,7 +1445,7 @@ 
             $bq
         );
 
-        return "\n" . $this->hashBlock("<blockquote>\n$bq\n</blockquote>") . "\n\n";
+        return "\n".$this->hashBlock("<blockquote>\n$bq\n</blockquote>")."\n\n";
     }
 
     function _doBlockQuotes_callback2($matches)
@@ -1470,7 +1470,7 @@ 
         # Wrap <p> tags and unhashify HTML blocks
         #
         foreach ($grafs as $key => $value) {
-            if (!preg_match('/^B\x1A[0-9]+B$/', $value)) {
+            if ( ! preg_match('/^B\x1A[0-9]+B$/', $value)) {
                 # Is a paragraph.
                 $value = $this->runSpanGamut($value);
                 $value = preg_replace('/^([ ]*)/', "<p>", $value);
@@ -1551,7 +1551,7 @@ 
                 '/&(?!#?[xX]?(?:[0-9a-fA-F]+|\w+);)/',
                 '&amp;',
                 $text
-            );;
+            ); ;
         }
         # Encode remaining <'s
         $text = str_replace('<', '&lt;', $text);
@@ -1625,9 +1625,9 @@ 
         #	Based by a filter by Matthew Wickline, posted to BBEdit-Talk.
         #   With some optimizations by Milian Wolff.
         #
-        $addr  = "mailto:" . $addr;
+        $addr  = "mailto:".$addr;
         $chars = preg_split('/(?<!^)(?!$)/', $addr);
-        $seed  = (int)abs(crc32($addr) / strlen($addr)); # Deterministic seed.
+        $seed  = (int) abs(crc32($addr) / strlen($addr)); # Deterministic seed.
 
         foreach ($chars as $key => $char) {
             $ord = ord($char);
@@ -1639,9 +1639,9 @@ 
                 if ($r > 90 && $char != '@') /* do nothing */ {
                     ;
                 } else if ($r < 45) {
-                    $chars[$key] = '&#x' . dechex($ord) . ';';
+                    $chars[$key] = '&#x'.dechex($ord).';';
                 } else {
-                    $chars[$key] = '&#' . $ord . ';';
+                    $chars[$key] = '&#'.$ord.';';
                 }
             }
         }
@@ -1663,7 +1663,7 @@ 
 
         $span_re = '{
 				(
-					\\\\' . $this->escape_chars_re . '
+					\\\\' . $this->escape_chars_re.'
 				|
 					(?<![`\\\\])
 					`+						# code span marker
@@ -1683,7 +1683,7 @@ 
 					<[-a-zA-Z0-9:_]+\s*/> # xml-style empty tag
 				|
 					</[-a-zA-Z0-9:_]+\s*> # closing tag
-			') . '
+			').'
 				)
 				}xs';
 
@@ -1720,11 +1720,11 @@ 
         #
         switch ($token{0}) {
             case "\\":
-                return $this->hashPart("&#" . ord($token{1}) . ";");
+                return $this->hashPart("&#".ord($token{1}).";");
             case "`":
                 # Search for end marker in remaining text.
                 if (preg_match(
-                    '/^(.*?[^`])' . preg_quote($token) . '(?!`)(.*)$/sm',
+                    '/^(.*?[^`])'.preg_quote($token).'(?!`)(.*)$/sm',
                     $str,
                     $matches
                 )) {
@@ -1743,7 +1743,7 @@ 
         #
         # Remove one level of line-leading tabs or spaces
         #
-        return preg_replace('/^(\t|[ ]{1,' . $this->tab_width . '})/m', '', $text);
+        return preg_replace('/^(\t|[ ]{1,'.$this->tab_width.'})/m', '', $text);
     }
 
 
@@ -1783,7 +1783,7 @@ 
             # Calculate amount of space, insert spaces, insert block.
             $amount = $this->tab_width -
                       $strlen($line, 'UTF-8') % $this->tab_width;
-            $line .= str_repeat(" ", $amount) . $block;
+            $line .= str_repeat(" ", $amount).$block;
         }
         return $line;
     }
@@ -1984,11 +1984,11 @@ 
 
         # compose attributes as string
         $attr_str = "";
-        if (!empty($id)) {
-            $attr_str .= ' id="' . $id . '"';
+        if ( ! empty($id)) {
+            $attr_str .= ' id="'.$id.'"';
         }
-        if (!empty($classes)) {
-            $attr_str .= ' class="' . implode(" ", $classes) . '"';
+        if ( ! empty($classes)) {
+            $attr_str .= ' class="'.implode(" ", $classes).'"';
         }
         return $attr_str;
     }
@@ -2004,7 +2004,7 @@ 
         # Link defs are in the form: ^[id]: url "optional title"
         $text = preg_replace_callback(
             '{
-							^[ ]{0,' . $less_than_tab . '}\[(.+)\][ ]?:	# id = $1
+							^[ ]{0,' . $less_than_tab.'}\[(.+)\][ ]?:	# id = $1
 							  [ ]*
 							  \n?				# maybe *one* newline
 							  [ ]*
@@ -2023,7 +2023,7 @@ 
 								[")]
 								[ ]*
 							)?	# title is optional
-					(?:[ ]* ' . $this->id_class_attr_catch_re . ' )?  # $5 = extra id & class attr
+					(?:[ ]* ' . $this->id_class_attr_catch_re.' )?  # $5 = extra id & class attr
 							(?:\n+|\Z)
 			}xm',
             array(&$this, '_stripLinkDefinitions_callback'),
@@ -2037,8 +2037,8 @@ 
         $link_id                  = strtolower($matches[1]);
         $url                      = $matches[2] == '' ? $matches[3] : $matches[2];
         $this->urls[$link_id]     = $url;
-        $this->titles[$link_id]   =& $matches[4];
-        $this->ref_attr[$link_id] = $this->doExtraAttributes("", $dummy =& $matches[5]);
+        $this->titles[$link_id]   = & $matches[4];
+        $this->ref_attr[$link_id] = $this->doExtraAttributes("", $dummy = & $matches[5]);
         return ''; # String that will replace the block
     }
 
@@ -2140,10 +2140,10 @@ 
 				(					# $2: Capture whole tag.
 					</?					# Any opening or closing tag.
 						(?>				# Tag name.
-							' . $this->block_tags_re . '			|
-							' . $this->context_block_tags_re . '	|
-							' . $this->clean_tags_re . '        	|
-							(?!\s)' . $enclosing_tag_re . '
+							' . $this->block_tags_re.'			|
+							' . $this->context_block_tags_re.'	|
+							' . $this->clean_tags_re.'        	|
+							(?!\s)' . $enclosing_tag_re.'
 						)
 						(?:
 							(?=[\s"\'/a-zA-Z0-9])	# Allowed characters after tag name.
@@ -2163,27 +2163,27 @@ 
 				|
 					# Code span marker
 					`+
-				' . (!$span ? ' # If not in span.
+				' . ( ! $span ? ' # If not in span.
 				|
 					# Indented code block
 					(?: ^[ ]*\n | ^ | \n[ ]*\n )
-					[ ]{' . ($indent + 4) . '}[^\n]* \n
+					[ ]{' . ($indent + 4).'}[^\n]* \n
 					(?>
-						(?: [ ]{' . ($indent + 4) . '}[^\n]* | [ ]* ) \n
+						(?: [ ]{' . ($indent + 4).'}[^\n]* | [ ]* ) \n
 					)*
 				|
 					# Fenced code block marker
 					(?<= ^ | \n )
-					[ ]{0,' . ($indent + 3) . '}~{3,}
+					[ ]{0,' . ($indent + 3).'}~{3,}
 									[ ]*
 					(?:
 					\.?[-_:a-zA-Z0-9]+ # standalone class name
 					|
-						' . $this->id_class_attr_nocatch_re . ' # extra attributes
+						' . $this->id_class_attr_nocatch_re.' # extra attributes
 					)?
 					[ ]*
 					\n
-				' : '') . ' # End (if not is span).
+				' : '').' # End (if not is span).
 				)
 			}xs';
 
@@ -2213,7 +2213,7 @@ 
             if ($span) {
                 $void     = $this->hashPart("", ':');
                 $newline  = "$void\n";
-                $parts[0] = $void . str_replace("\n", $newline, $parts[0]) . $void;
+                $parts[0] = $void.str_replace("\n", $newline, $parts[0]).$void;
             }
 
             $parsed .= $parts[0]; # Text before current tag.
@@ -2235,12 +2235,12 @@ 
                 # Find corresponding end marker.
                 $tag_re = preg_quote($tag);
                 if (preg_match(
-                    '{^(?>.+?|\n(?!\n))*?(?<!`)' . $tag_re . '(?!`)}',
+                    '{^(?>.+?|\n(?!\n))*?(?<!`)'.$tag_re.'(?!`)}',
                     $text,
                     $matches
                 )) {
                     # End marker found: pass text unchanged until marker.
-                    $parsed .= $tag . $matches[0];
+                    $parsed .= $tag.$matches[0];
                     $text = substr($text, strlen($matches[0]));
                 } else {
                     # Unmatched marker: just skip it.
@@ -2250,17 +2250,17 @@ 
             #
             # Check for: Fenced code block marker.
             #
-            else if (preg_match('{^\n?([ ]{0,' . ($indent + 3) . '})(~+)}', $tag, $capture)) {
+            else if (preg_match('{^\n?([ ]{0,'.($indent + 3).'})(~+)}', $tag, $capture)) {
                 # Fenced code block marker: find matching end marker.
                 $fence_indent = strlen($capture[1]); # use captured indent in re
                 $fence_re     = $capture[2]; # use captured fence in re
                 if (preg_match(
-                    '{^(?>.*\n)*?[ ]{' . ($fence_indent) . '}' . $fence_re . '[ ]*(?:\n|$)}',
+                    '{^(?>.*\n)*?[ ]{'.($fence_indent).'}'.$fence_re.'[ ]*(?:\n|$)}',
                     $text,
                     $matches
                 )) {
                     # End marker found: pass text unchanged until marker.
-                    $parsed .= $tag . $matches[0];
+                    $parsed .= $tag.$matches[0];
                     $text = substr($text, strlen($matches[0]));
                 } else {
                     # No end marker: just skip it.
@@ -2280,14 +2280,14 @@ 
             #            Opening Context Block tag (like ins and del)
             #               used as a block tag (tag is alone on it's line).
             #
-            else if (preg_match('{^<(?:' . $this->block_tags_re . ')\b}', $tag) ||
-                     (preg_match('{^<(?:' . $this->context_block_tags_re . ')\b}', $tag) &&
+            else if (preg_match('{^<(?:'.$this->block_tags_re.')\b}', $tag) ||
+                     (preg_match('{^<(?:'.$this->context_block_tags_re.')\b}', $tag) &&
                       preg_match($newline_before_re, $parsed) &&
                       preg_match($newline_after_re, $text))
             ) {
                 # Need to parse tag and following text using the HTML parser.
                 list($block_text, $text) =
-                    $this->_hashHTMLBlocks_inHTML($tag . $text, "hashBlock", true);
+                    $this->_hashHTMLBlocks_inHTML($tag.$text, "hashBlock", true);
 
                 # Make sure it stays outside of any paragraph by adding newlines.
                 $parsed .= "\n\n$block_text\n\n";
@@ -2296,13 +2296,13 @@ 
             # Check for: Clean tag (like script, math)
             #            HTML Comments, processing instructions.
             #
-            else if (preg_match('{^<(?:' . $this->clean_tags_re . ')\b}', $tag) ||
+            else if (preg_match('{^<(?:'.$this->clean_tags_re.')\b}', $tag) ||
                      $tag{1} == '!' || $tag{1} == '?'
             ) {
                 # Need to parse tag and following text using the HTML parser.
                 # (don't check for markdown attribute)
                 list($block_text, $text) =
-                    $this->_hashHTMLBlocks_inHTML($tag . $text, "hashClean", false);
+                    $this->_hashHTMLBlocks_inHTML($tag.$text, "hashClean", false);
 
                 $parsed .= $block_text;
             }
@@ -2311,15 +2311,15 @@ 
             #
             else if ($enclosing_tag_re !== '' &&
                      # Same name as enclosing tag.
-                     preg_match('{^</?(?:' . $enclosing_tag_re . ')\b}', $tag)
+                     preg_match('{^</?(?:'.$enclosing_tag_re.')\b}', $tag)
             ) {
                 #
                 # Increase/decrease nested tag count.
                 #
                 if ($tag{1} == '/') {
-                    $depth --;
+                    $depth--;
                 } else if ($tag{strlen($tag) - 2} != '/') {
-                    $depth ++;
+                    $depth++;
                 }
 
                 if ($depth < 0) {
@@ -2327,7 +2327,7 @@ 
                     # Going out of parent element. Clean up and break so we
                     # return to the calling function.
                     #
-                    $text = $tag . $text;
+                    $text = $tag.$text;
                     break;
                 }
 
@@ -2439,7 +2439,7 @@ 
             # Check for: Auto-close tag (like <hr/>)
             #			 Comments and Processing Instructions.
             #
-            if (preg_match('{^</?(?:' . $this->auto_close_tags_re . ')\b}', $tag) ||
+            if (preg_match('{^</?(?:'.$this->auto_close_tags_re.')\b}', $tag) ||
                 $tag{1} == '!' || $tag{1} == '?'
             ) {
                 # Just add the tag to the block as if it was text.
@@ -2449,11 +2449,11 @@ 
                 # Increase/decrease nested tag count. Only do so if
                 # the tag's name match base tag's.
                 #
-                if (preg_match('{^</?' . $base_tag_name_re . '\b}', $tag)) {
+                if (preg_match('{^</?'.$base_tag_name_re.'\b}', $tag)) {
                     if ($tag{1} == '/') {
-                        $depth --;
+                        $depth--;
                     } else if ($tag{strlen($tag) - 2} != '/') {
-                        $depth ++;
+                        $depth++;
                     }
                 }
 
@@ -2462,16 +2462,16 @@ 
                 #
                 if ($md_attr &&
                     preg_match($markdown_attr_re, $tag, $attr_m) &&
-                    preg_match('/^1|block|span$/', $attr_m[2] . $attr_m[3])
+                    preg_match('/^1|block|span$/', $attr_m[2].$attr_m[3])
                 ) {
                     # Remove `markdown` attribute from opening tag.
                     $tag = preg_replace($markdown_attr_re, '', $tag);
 
                     # Check if text inside this tag must be parsed in span mode.
-                    $this->mode = $attr_m[2] . $attr_m[3];
+                    $this->mode = $attr_m[2].$attr_m[3];
                     $span_mode  = $this->mode == 'span' || $this->mode != 'block' &&
                                                            preg_match(
-                                                               '{^<(?:' . $this->contain_span_tags_re . ')\b}',
+                                                               '{^<(?:'.$this->contain_span_tags_re.')\b}',
                                                                $tag
                                                            );
 
@@ -2511,7 +2511,7 @@ 
                     }
 
                     # Append tag content to parsed text.
-                    if (!$span_mode) {
+                    if ( ! $span_mode) {
                         $parsed .= "\n\n$block_text\n\n";
                     } else {
                         $parsed .= "$block_text";
@@ -2560,7 +2560,7 @@ 
             '{
 			(					# wrap whole match in $1
 			  \[
-				(' . $this->nested_brackets_re . ')	# link text = $2
+				(' . $this->nested_brackets_re.')	# link text = $2
 			  \]
 
 			  [ ]?				# one optional space
@@ -2582,14 +2582,14 @@ 
             '{
 			(				# wrap whole match in $1
 			  \[
-				(' . $this->nested_brackets_re . ')	# link text = $2
+				(' . $this->nested_brackets_re.')	# link text = $2
 			  \]
 			  \(			# literal paren
 				[ \n]*
 				(?:
 					<(.+?)>	# href = $3
 				|
-					(' . $this->nested_url_parenthesis_re . ')	# href = $4
+					(' . $this->nested_url_parenthesis_re.')	# href = $4
 				)
 				[ \n]*
 				(			# $5
@@ -2599,7 +2599,7 @@ 
 				  [ \n]*	# ignore any spaces/tabs between closing quote and )
 				)?			# title is optional
 			  \)
-			  (?:[ ]? ' . $this->id_class_attr_catch_re . ' )?	 # $8 = id/class attributes
+			  (?:[ ]? ' . $this->id_class_attr_catch_re.' )?	 # $8 = id/class attributes
 			)
 			}xs',
             array(&$this, '_doAnchors_inline_callback'),
@@ -2631,7 +2631,7 @@ 
     {
         $whole_match = $matches[1];
         $link_text   = $matches[2];
-        $link_id     =& $matches[3];
+        $link_id     = & $matches[3];
 
         if ($link_id == "") {
             # for shortcut links like [this][] or [this].
@@ -2670,8 +2670,8 @@ 
         $whole_match = $matches[1];
         $link_text   = $this->runSpanGamut($matches[2]);
         $url         = $matches[3] == '' ? $matches[4] : $matches[3];
-        $title       =& $matches[7];
-        $attr        = $this->doExtraAttributes("a", $dummy =& $matches[8]);
+        $title       = & $matches[7];
+        $attr        = $this->doExtraAttributes("a", $dummy = & $matches[8]);
 
         $url = $this->encodeAttribute($url);
 
@@ -2700,7 +2700,7 @@ 
             '{
 			(				# wrap whole match in $1
 			  !\[
-				(' . $this->nested_brackets_re . ')		# alt text = $2
+				(' . $this->nested_brackets_re.')		# alt text = $2
 			  \]
 
 			  [ ]?				# one optional space
@@ -2724,7 +2724,7 @@ 
             '{
 			(				# wrap whole match in $1
 			  !\[
-				(' . $this->nested_brackets_re . ')		# alt text = $2
+				(' . $this->nested_brackets_re.')		# alt text = $2
 			  \]
 			  \s?			# One optional whitespace character
 			  \(			# literal paren
@@ -2732,7 +2732,7 @@ 
 				(?:
 					<(\S*)>	# src url = $3
 				|
-					(' . $this->nested_url_parenthesis_re . ')	# src url = $4
+					(' . $this->nested_url_parenthesis_re.')	# src url = $4
 				)
 				[ \n]*
 				(			# $5
@@ -2742,7 +2742,7 @@ 
 				  [ \n]*
 				)?			# title is optional
 			  \)
-			  (?:[ ]? ' . $this->id_class_attr_catch_re . ' )?	 # $8 = id/class attributes
+			  (?:[ ]? ' . $this->id_class_attr_catch_re.' )?	 # $8 = id/class attributes
 			)
 			}xs',
             array(&$this, '_doImages_inline_callback'),
@@ -2789,8 +2789,8 @@ 
         $whole_match = $matches[1];
         $alt_text    = $matches[2];
         $url         = $matches[3] == '' ? $matches[4] : $matches[3];
-        $title       =& $matches[7];
-        $attr        = $this->doExtraAttributes("img", $dummy =& $matches[8]);
+        $title       = & $matches[7];
+        $attr        = $this->doExtraAttributes("img", $dummy = & $matches[8]);
 
         $alt_text = $this->encodeAttribute($alt_text);
         $url      = $this->encodeAttribute($url);
@@ -2820,7 +2820,7 @@ 
         $text = preg_replace_callback(
             '{
 				(^.+?)								# $1: Header text
-				(?:[ ]+ ' . $this->id_class_attr_catch_re . ' )?	 # $3 = id/class attributes
+				(?:[ ]+ ' . $this->id_class_attr_catch_re.' )?	 # $3 = id/class attributes
 				[ ]*\n(=+|-+)[ ]*\n+				# $3: Header footer
 			}mx',
             array(&$this, '_doHeaders_callback_setext'),
@@ -2841,7 +2841,7 @@ 
 				(.+?)		# $2 = Header text
 				[ ]*
 				\#*			# optional closing #\'s (not counted)
-				(?:[ ]+ ' . $this->id_class_attr_catch_re . ' )?	 # $3 = id/class attributes
+				(?:[ ]+ ' . $this->id_class_attr_catch_re.' )?	 # $3 = id/class attributes
 				[ ]*
 				\n+
 			}xm',
@@ -2858,17 +2858,17 @@ 
             return $matches[0];
         }
         $level = $matches[3]{0} == '=' ? 1 : 2;
-        $attr  = $this->doExtraAttributes("h$level", $dummy =& $matches[2]);
-        $block = "<h$level$attr>" . $this->runSpanGamut($matches[1]) . "</h$level>";
-        return "\n" . $this->hashBlock($block) . "\n\n";
+        $attr  = $this->doExtraAttributes("h$level", $dummy = & $matches[2]);
+        $block = "<h$level$attr>".$this->runSpanGamut($matches[1])."</h$level>";
+        return "\n".$this->hashBlock($block)."\n\n";
     }
 
     function _doHeaders_callback_atx($matches)
     {
         $level = strlen($matches[1]);
-        $attr  = $this->doExtraAttributes("h$level", $dummy =& $matches[3]);
-        $block = "<h$level$attr>" . $this->runSpanGamut($matches[2]) . "</h$level>";
-        return "\n" . $this->hashBlock($block) . "\n\n";
+        $attr  = $this->doExtraAttributes("h$level", $dummy = & $matches[3]);
+        $block = "<h$level$attr>".$this->runSpanGamut($matches[2])."</h$level>";
+        return "\n".$this->hashBlock($block)."\n\n";
     }
 
     function doTables($text)
@@ -2889,11 +2889,11 @@ 
             '
 			{
 				^							# Start of a line
-				[ ]{0,' . $less_than_tab . '}	# Allowed whitespace.
+				[ ]{0,' . $less_than_tab.'}	# Allowed whitespace.
 				[|]							# Optional leading pipe (present)
 				(.+) \n						# $1: Header row (at least one pipe)
 
-				[ ]{0,' . $less_than_tab . '}	# Allowed whitespace.
+				[ ]{0,' . $less_than_tab.'}	# Allowed whitespace.
 				[|] ([ ]*[-:]+[-| :]*) \n	# $2: Header underline
 
 				(							# $3: Cells
@@ -2920,10 +2920,10 @@ 
             '
 			{
 				^							# Start of a line
-				[ ]{0,' . $less_than_tab . '}	# Allowed whitespace.
+				[ ]{0,' . $less_than_tab.'}	# Allowed whitespace.
 				(\S.*[|].*) \n				# $1: Header row (at least one pipe)
 
-				[ ]{0,' . $less_than_tab . '}	# Allowed whitespace.
+				[ ]{0,' . $less_than_tab.'}	# Allowed whitespace.
 				([-:]+[ ]*[|][-| :]*) \n	# $2: Header underline
 
 				(							# $3: Cells
@@ -2989,7 +2989,7 @@ 
         $text .= "<thead>\n";
         $text .= "<tr>\n";
         foreach ($headers as $n => $header) {
-            $text .= "  <th$attr[$n]>" . $this->runSpanGamut(trim($header)) . "</th>\n";
+            $text .= "  <th$attr[$n]>".$this->runSpanGamut(trim($header))."</th>\n";
         }
         $text .= "</tr>\n";
         $text .= "</thead>\n";
@@ -3009,14 +3009,14 @@ 
 
             $text .= "<tr>\n";
             foreach ($row_cells as $n => $cell) {
-                $text .= "  <td$attr[$n]>" . $this->runSpanGamut(trim($cell)) . "</td>\n";
+                $text .= "  <td$attr[$n]>".$this->runSpanGamut(trim($cell))."</td>\n";
             }
             $text .= "</tr>\n";
         }
         $text .= "</tbody>\n";
         $text .= "</table>";
 
-        return $this->hashBlock($text) . "\n";
+        return $this->hashBlock($text)."\n";
     }
 
     function doDefLists($text)
@@ -3030,10 +3030,10 @@ 
         $whole_list_re = '(?>
 			(								# $1 = whole list
 			  (								# $2
-				[ ]{0,' . $less_than_tab . '}
+				[ ]{0,' . $less_than_tab.'}
 				((?>.*\S.*\n)+)				# $3 = defined term
 				\n?
-				[ ]{0,' . $less_than_tab . '}:[ ]+ # colon starting definition
+				[ ]{0,' . $less_than_tab.'}:[ ]+ # colon starting definition
 			  )
 			  (?s:.+?)
 			  (								# $4
@@ -3042,13 +3042,13 @@ 
 				  \n{2,}
 				  (?=\S)
 				  (?!						# Negative lookahead for another term
-					[ ]{0,' . $less_than_tab . '}
+					[ ]{0,' . $less_than_tab.'}
 					(?: \S.*\n )+?			# defined term
 					\n?
-					[ ]{0,' . $less_than_tab . '}:[ ]+ # colon starting definition
+					[ ]{0,' . $less_than_tab.'}:[ ]+ # colon starting definition
 				  )
 				  (?!						# Negative lookahead for another definition
-					[ ]{0,' . $less_than_tab . '}:[ ]+ # colon starting definition
+					[ ]{0,' . $less_than_tab.'}:[ ]+ # colon starting definition
 				  )
 			  )
 			)
@@ -3057,7 +3057,7 @@ 
         $text = preg_replace_callback(
             '{
 				(?>\A\n?|(?<=\n\n))
-				' . $whole_list_re . '
+				' . $whole_list_re.'
 			}mx',
             array(&$this, '_doDefLists_callback'),
             $text
@@ -3074,8 +3074,8 @@ 
         # Turn double returns into triple returns, so that we can make a
         # paragraph for the last item in a list, if necessary:
         $result = trim($this->processDefListItems($list));
-        $result = "<dl>\n" . $result . "\n</dl>";
-        return $this->hashBlock($result) . "\n\n";
+        $result = "<dl>\n".$result."\n</dl>";
+        return $this->hashBlock($result)."\n\n";
     }
 
     function processDefListItems($list_str)
@@ -3094,7 +3094,7 @@ 
             '{
 			(?>\A\n?|\n\n+)					# leading line
 			(								# definition terms = $1
-				[ ]{0,' . $less_than_tab . '}	# leading whitespace
+				[ ]{0,' . $less_than_tab.'}	# leading whitespace
 				(?!\:[ ]|[ ])				# negative lookahead for a definition
 											#   mark (colon) or more whitespace.
 				(?> \S.* \n)+?				# actual term (not whitespace).
@@ -3111,13 +3111,13 @@ 
             '{
 			\n(\n+)?						# leading line = $1
 			(								# marker space = $2
-				[ ]{0,' . $less_than_tab . '}	# whitespace before colon
+				[ ]{0,' . $less_than_tab.'}	# whitespace before colon
 				\:[ ]+						# definition mark (colon)
 			)
 			((?s:.+?))						# definition text = $3
 			(?= \n+ 						# stop at next definition mark,
 				(?:							# next term or end of text
-					[ ]{0,' . $less_than_tab . '} \:[ ]	|
+					[ ]{0,' . $less_than_tab.'} \:[ ]	|
 					<dt> | \z
 				)
 			)
@@ -3135,9 +3135,9 @@ 
         $text  = '';
         foreach ($terms as $term) {
             $term = $this->runSpanGamut(trim($term));
-            $text .= "\n<dt>" . $term . "</dt>";
+            $text .= "\n<dt>".$term."</dt>";
         }
-        return $text . "\n";
+        return $text."\n";
     }
 
     function _processDefListItems_callback_dd($matches)
@@ -3148,15 +3148,15 @@ 
 
         if ($leading_line || preg_match('/\n{2,}/', $def)) {
             # Replace marker with the appropriate whitespace indentation
-            $def = str_repeat(' ', strlen($marker_space)) . $def;
-            $def = $this->runBlockGamut($this->outdent($def . "\n\n"));
-            $def = "\n" . $def . "\n";
+            $def = str_repeat(' ', strlen($marker_space)).$def;
+            $def = $this->runBlockGamut($this->outdent($def."\n\n"));
+            $def = "\n".$def."\n";
         } else {
             $def = rtrim($def);
             $def = $this->runSpanGamut($this->outdent($def));
         }
 
-        return "\n<dd>" . $def . "</dd>\n";
+        return "\n<dd>".$def."</dd>\n";
     }
 
     function doFencedCodeBlocks($text)
@@ -3181,7 +3181,7 @@ 
 				(?:
 					\.?([-_:a-zA-Z0-9]+) # 2: standalone class name
 				|
-					' . $this->id_class_attr_catch_re . ' # 3: Extra attributes
+					' . $this->id_class_attr_catch_re.' # 3: Extra attributes
 				)?
 				[ ]* \n # Whitespace and newline following marker.
 
@@ -3205,8 +3205,8 @@ 
 
     function _doFencedCodeBlocks_callback($matches)
     {
-        $classname =& $matches[2];
-        $attrs     =& $matches[3];
+        $classname = & $matches[2];
+        $attrs     = & $matches[3];
         $codeblock = $matches[4];
         $codeblock = htmlspecialchars($codeblock, ENT_NOQUOTES);
         $codeblock = preg_replace_callback(
@@ -3219,7 +3219,7 @@ 
             if ($classname{0} == '.') {
                 $classname = substr($classname, 1);
             }
-            $attr_str = ' class="' . $this->code_class_prefix . $classname . '"';
+            $attr_str = ' class="'.$this->code_class_prefix.$classname.'"';
         } else {
             $attr_str = $this->doExtraAttributes($this->code_attr_on_pre ? "pre" : "code", $attrs);
         }
@@ -3227,7 +3227,7 @@ 
         $code_attr_str = $this->code_attr_on_pre ? '' : $attr_str;
         $codeblock     = "<pre$pre_attr_str><code$code_attr_str>$codeblock</code></pre>";
 
-        return "\n\n" . $this->hashBlock($codeblock) . "\n\n";
+        return "\n\n".$this->hashBlock($codeblock)."\n\n";
     }
 
     function _doFencedCodeBlocks_newlines($matches)
@@ -3280,7 +3280,7 @@ 
 
             # Check if this should be enclosed in a paragraph.
             # Clean tag hashes & block tag hashes are left alone.
-            $is_p = !preg_match('/^B\x1A[0-9]+B|^C\x1A[0-9]+C$/', $value);
+            $is_p = ! preg_match('/^B\x1A[0-9]+B|^C\x1A[0-9]+C$/', $value);
 
             if ($is_p) {
                 $value = "<p>$value</p>";
@@ -3310,7 +3310,7 @@ 
         # Link defs are in the form: [^id]: url "optional title"
         $text = preg_replace_callback(
             '{
-			^[ ]{0,' . $less_than_tab . '}\[\^(.+?)\][ ]?:	# note_id = $1
+			^[ ]{0,' . $less_than_tab.'}\[\^(.+?)\][ ]?:	# note_id = $1
 			  [ ]*
 			  \n?					# maybe *one* newline
 			(						# text = $2 (no blank lines allowed)
@@ -3332,7 +3332,7 @@ 
 
     function _stripFootnotes_callback($matches)
     {
-        $note_id                   = $this->fn_id_prefix . $matches[1];
+        $note_id                   = $this->fn_id_prefix.$matches[1];
         $this->footnotes[$note_id] = $this->outdent($matches[2]);
         return ''; # String that will replace the block
     }
@@ -3343,7 +3343,7 @@ 
         # Replace footnote references in $text [^id] with a special text-token
         # which will be replaced by the actual footnote marker in appendFootnotes.
         #
-        if (!$this->in_anchor) {
+        if ( ! $this->in_anchor) {
             $text = preg_replace('{\[\^(.+?)\]}', "F\x1Afn:\\1\x1A:", $text);
         }
         return $text;
@@ -3360,10 +3360,10 @@ 
             $text
         );
 
-        if (!empty($this->footnotes_ordered)) {
+        if ( ! empty($this->footnotes_ordered)) {
             $text .= "\n\n";
             $text .= "<div class=\"footnotes\">\n";
-            $text .= "<hr" . $this->empty_element_suffix . "\n";
+            $text .= "<hr".$this->empty_element_suffix."\n";
             $text .= "<ol>\n\n";
 
             $attr = " rev=\"footnote\"";
@@ -3379,7 +3379,7 @@ 
             }
             $num = 0;
 
-            while (!empty($this->footnotes_ordered)) {
+            while ( ! empty($this->footnotes_ordered)) {
                 $footnote = reset($this->footnotes_ordered);
                 $note_id  = key($this->footnotes_ordered);
                 unset($this->footnotes_ordered[$note_id]);
@@ -3405,13 +3405,13 @@ 
                 }
                 # Add backlink to last paragraph; create new paragraph if needed.
                 if (preg_match('{</p>$}', $footnote)) {
-                    $footnote = substr($footnote, 0, - 4) . "&#160;$backlink</p>";
+                    $footnote = substr($footnote, 0, - 4)."&#160;$backlink</p>";
                 } else {
                     $footnote .= "\n\n<p>$backlink</p>";
                 }
 
                 $text .= "<li id=\"fn:$note_id\">\n";
-                $text .= $footnote . "\n";
+                $text .= $footnote."\n";
                 $text .= "</li>\n\n";
             }
 
@@ -3423,18 +3423,18 @@ 
 
     function _appendFootnotes_callback($matches)
     {
-        $node_id = $this->fn_id_prefix . $matches[1];
+        $node_id = $this->fn_id_prefix.$matches[1];
 
         # Create footnote marker only if it has a corresponding footnote *and*
         # the footnote hasn't been used by another marker.
         if (isset($this->footnotes[$node_id])) {
-            $num =& $this->footnotes_numbers[$node_id];
-            if (!isset($num)) {
+            $num = & $this->footnotes_numbers[$node_id];
+            if ( ! isset($num)) {
                 # Transfer footnote content to the ordered list and give it its
                 # number
                 $this->footnotes_ordered[$node_id]   = $this->footnotes[$node_id];
                 $this->footnotes_ref_count[$node_id] = 1;
-                $num                                 = $this->footnote_counter ++;
+                $num                                 = $this->footnote_counter++;
                 $ref_count_mark                      = '';
             } else {
                 $ref_count_mark = $this->footnotes_ref_count[$node_id] += 1;
@@ -3456,12 +3456,12 @@ 
             $node_id = $this->encodeAttribute($node_id);
 
             return
-                "<sup id=\"fnref$ref_count_mark:$node_id\">" .
-                "<a href=\"#fn:$node_id\"$attr>$num</a>" .
+                "<sup id=\"fnref$ref_count_mark:$node_id\">".
+                "<a href=\"#fn:$node_id\"$attr>$num</a>".
                 "</sup>";
         }
 
-        return "[^" . $matches[1] . "]";
+        return "[^".$matches[1]."]";
     }
 
     ### Abbreviations ###
@@ -3476,7 +3476,7 @@ 
         # Link defs are in the form: [id]*: url "optional title"
         $text = preg_replace_callback(
             '{
-			^[ ]{0,' . $less_than_tab . '}\*\[(.+?)\][ ]?:	# abbr_id = $1
+			^[ ]{0,' . $less_than_tab.'}\*\[(.+?)\][ ]?:	# abbr_id = $1
 			(.*)					# text = $2 (no blank lines allowed)
 			}xm',
             array(&$this, '_stripAbbreviations_callback'),
@@ -3506,10 +3506,10 @@ 
             // cannot use the /x modifier because abbr_word_re may
             // contain significant spaces:
             $text = preg_replace_callback(
-                '{' .
-                '(?<![\w\x1A])' .
-                '(?:' . $this->abbr_word_re . ')' .
-                '(?![\w\x1A])' .
+                '{'.
+                '(?<![\w\x1A])'.
+                '(?:'.$this->abbr_word_re.')'.
+                '(?![\w\x1A])'.
                 '}',
                 array(&$this, '_doAbbreviations_callback'),
                 $text

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

Spacing +14 added lines, -14 removed lines

@@ -139,7 +139,7 @@ 
 
         // Add trailing slash if not set
         foreach ($this->_migration_paths as $alias => $path) {
-            $this->_migration_paths[$alias] = rtrim($this->_migration_paths[$alias], '/') . '/';
+            $this->_migration_paths[$alias] = rtrim($this->_migration_paths[$alias], '/').'/';
         }
 
         // Load migration language
@@ -200,7 +200,7 @@ 
      *
      * @return	mixed	TRUE if already latest, FALSE if failed, string if upgraded
      */
-    public function version($type='all', $target_version)
+    public function version($type = 'all', $target_version)
     {
         // Note: We use strings, so that timestamp versions work on 32-bit systems
         $current_version = $this->get_version($type);
@@ -265,7 +265,7 @@ 
 
             // Run migrations that are inside the target range
             if (
-                ($method === 'up'   && $number > $current_version && $number <= $target_version) OR
+                ($method === 'up' && $number > $current_version && $number <= $target_version) OR
                 ($method === 'down' && $number <= $current_version && $number > $target_version)
             )
             {
@@ -305,7 +305,7 @@ 
      *
      * @return	mixed	TRUE if already latest, FALSE if failed, string if upgraded
      */
-    public function latest($type='app')
+    public function latest($type = 'app')
     {
         $last_migration = $this->get_latest($type);
 
@@ -323,7 +323,7 @@ 
      *
      * @return bool|string
      */
-    public function get_latest($type='app')
+    public function get_latest($type = 'app')
     {
         $migrations = $this->find_migrations($type);
 
@@ -369,7 +369,7 @@ 
      *
      * @return	array	list of migration file paths sorted by version
      */
-    public function find_migrations($type='app')
+    public function find_migrations($type = 'app')
     {
         $migrations = array();
 
@@ -407,7 +407,7 @@ 
      *
      * @return	string	Current migration version
      */
-    public function get_version($type='app')
+    public function get_version($type = 'app')
     {
         $row = $this->db->select('version')
                         ->where('alias', $type)
@@ -443,7 +443,7 @@ 
             $prefix = str_pad($this->get_version() + 1, 3, '0', STR_PAD_LEFT);
         }
 
-        return $prefix .'_'. ucfirst(strtolower($name)) .'.php';
+        return $prefix.'_'.ucfirst(strtolower($name)).'.php';
     }
 
     //--------------------------------------------------------------------
@@ -470,7 +470,7 @@ 
 	 *
 	 * @return null|string
 	 */
-    public function determine_migration_path($type, $create=false)
+    public function determine_migration_path($type, $create = false)
     {
         $type = strtolower($type);
 
@@ -489,17 +489,17 @@ 
 
 		        if (is_array($folders) && count($folders))
 		        {
-			        $path = $folders[0] . $module .'/migrations';
+			        $path = $folders[0].$module.'/migrations';
 		        }
 	        }
 
-            return rtrim($path, '/') .'/';
+            return rtrim($path, '/').'/';
         }
 
         // Look in our predefined groups.
-        if (! empty($this->_migration_paths[$type]))
+        if ( ! empty($this->_migration_paths[$type]))
         {
-            return rtrim($this->_migration_paths[$type], '/') .'/';
+            return rtrim($this->_migration_paths[$type], '/').'/';
         }
 
         return null;
@@ -561,7 +561,7 @@ 
      * @param	string	$migration	Migration reached
      * @return	mixed	Outputs a report of the migration
      */
-    protected function _update_version($type='all', $migration)
+    protected function _update_version($type = 'all', $migration)
     {
         $this->db->where('alias', $type)
                  ->delete($this->_migration_table);

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)
     {

Spacing +19 added lines, -19 removed lines

@@ -136,11 +136,11 @@ 
 
         // If it's an update, we probably won't have the username/email
         // so grab it so that we can use it.
-        if (! empty($data[ $this->primary_key ]))
+        if ( ! empty($data[$this->primary_key]))
         {
-            if (! isset($data[$field]) )
+            if ( ! isset($data[$field]))
             {
-                $value = $this->get_field( $data['id'], $field );
+                $value = $this->get_field($data['id'], $field);
             }
         }
         // However, if it's an insert, then we should have it, If we don't, leave.
@@ -155,9 +155,9 @@ 
         }
 
         // Still here? then create the hash based on the current realm.
-        if (! empty($data['password']) )
+        if ( ! empty($data['password']))
         {
-            $key = md5($value .':'. config_item('api.realm') .':'. $data['password']);
+            $key = md5($value.':'.config_item('api.realm').':'.$data['password']);
             $data['api_key'] = $key;
         }
 
@@ -228,20 +228,20 @@ 
      *
      * @return object
      */
-    public function saveMetaToUser($user_id, $key, $value=null)
+    public function saveMetaToUser($user_id, $key, $value = null)
     {
-        if (! Events::trigger('beforeAddMetaToUser', [$user_id, $key]))
+        if ( ! Events::trigger('beforeAddMetaToUser', [$user_id, $key]))
         {
             return false;
         }
 
-        $user_id = (int)$user_id;
+        $user_id = (int) $user_id;
 
         // Does this key already exist?
-        $test = $this->db->where([ 'user_id' => $user_id, 'meta_key' => $key ])->get('user_meta');
+        $test = $this->db->where(['user_id' => $user_id, 'meta_key' => $key])->get('user_meta');
 
         // Doesn't exist, so insert it.
-        if (! $test->num_rows())
+        if ( ! $test->num_rows())
         {
             $data = [
                 'user_id'       => $user_id,
@@ -271,12 +271,12 @@ 
      */
     public function getMetaItem($user_id, $key)
     {
-        $query = $this->db->where('user_id', (int)$user_id)
+        $query = $this->db->where('user_id', (int) $user_id)
                           ->where('meta_key', $key)
                           ->select('meta_value')
                           ->get('user_meta');
 
-        if (! $query->num_rows())
+        if ( ! $query->num_rows())
         {
             return null;
         }
@@ -296,7 +296,7 @@ 
      */
     public function removeMetaFromUser($user_id, $key)
     {
-        if (! Events::trigger('beforeRemoveMetaFromUser', [$user_id, $key]))
+        if ( ! Events::trigger('beforeRemoveMetaFromUser', [$user_id, $key]))
         {
             return false;
         }
@@ -310,7 +310,7 @@ 
 		    $this->db->where('meta_key', $key);
 	    }
 
-        $this->db->where('user_id', (int)$user_id)
+        $this->db->where('user_id', (int) $user_id)
                  ->delete('user_meta');
     }
 
@@ -318,7 +318,7 @@ 
 
     public function getMetaForUser($user_id)
     {
-        $query = $this->db->where('user_id', (int)$user_id)
+        $query = $this->db->where('user_id', (int) $user_id)
                           ->select('meta_key, meta_value')
                           ->get('user_meta');
 
@@ -328,9 +328,9 @@ 
 
         if (count($rows))
         {
-            array_walk( $rows, function ( $row ) use ( &$meta )
+            array_walk($rows, function($row) use (&$meta)
             {
-                $meta[ $row->meta_key ] = $row->meta_value;
+                $meta[$row->meta_key] = $row->meta_value;
             } );
         }
 
@@ -350,11 +350,11 @@ 
 
         if (is_object($data['fields']))
         {
-            $data['fields']->meta = (object)$meta;
+            $data['fields']->meta = (object) $meta;
         }
         else
         {
-            $data['fields']['meta']= $meta;
+            $data['fields']['meta'] = $meta;
         }
 
         return $data;

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

Spacing +11 added lines, -11 removed lines

@@ -29,7 +29,7 @@ 
  *
  */
 
-if (!defined("BASEPATH"))
+if ( ! defined("BASEPATH"))
     exit("No direct script access allowed");
 
 class HMVC_Loader extends CI_Loader {
@@ -78,11 +78,11 @@ 
     public function controller($uri, $params = array(), $return = FALSE) {
         // No valid module detected, add current module to uri
         list($module) = $this->detect_module($uri);
-        if (!isset($module)) {
+        if ( ! isset($module)) {
             $router = & $this->_ci_get_component('router');
             if ($router->module) {
                 $module = $router->module;
-                $uri = $module . '/' . $uri;
+                $uri = $module.'/'.$uri;
             }
         }
 
@@ -199,7 +199,7 @@ 
     {
         // Allow application/views/* to override any module
         // views for easier app customization.
-        if (file_exists(APPPATH .'views/'. $view .'.php'))
+        if (file_exists(APPPATH.'views/'.$view.'.php'))
         {
             return parent::view($view, $vars, $return);
         }
@@ -359,7 +359,7 @@ 
             $void = $this->widget($module.'/'.$widget);
 
             // Remove module if widget not found within it
-            if (!$void) {
+            if ( ! $void) {
                 $this->remove_module();
             }
 
@@ -440,13 +440,13 @@ 
         $method = isset($segments[1]) ? $segments[1] : "index";
 
         // Controller not found
-        if (!$class) {
+        if ( ! $class) {
             return;
         }
 
-        if (!array_key_exists(strtolower($class), $this->_ci_controllers)) {
+        if ( ! array_key_exists(strtolower($class), $this->_ci_controllers)) {
             // Determine filepath
-            $filepath = APPPATH . 'controllers/' . $router->fetch_directory() . $class . '.php';
+            $filepath = APPPATH.'controllers/'.$router->fetch_directory().$class.'.php';
 
             // Load the controller file
             if (file_exists($filepath)) {
@@ -454,7 +454,7 @@ 
             }
 
             // Controller class not found, show 404
-            if (!class_exists($class)) {
+            if ( ! class_exists($class)) {
                 show_404("{$class}/{$method}");
             }
 
@@ -465,7 +465,7 @@ 
         $controller = $this->_ci_controllers[strtolower($class)];
 
         // Method does not exists
-        if (!method_exists($controller, $method)) {
+        if ( ! method_exists($controller, $method)) {
             show_404("{$class}/{$method}");
         }
 
@@ -524,7 +524,7 @@ 
 
         // Check all locations for this module
         foreach ($config->item('modules_locations') as $location) {
-            $path = $location . rtrim($module, '/') . '/';
+            $path = $location.rtrim($module, '/').'/';
             if (is_dir($path)) {
                 return $path;
             }

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') ) {

Spacing +20 added lines, -20 removed lines

@@ -10,9 +10,9 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function __construct($ci=null)
+	public function __construct($ci = null)
 	{
-	    $this->ci =& $ci;
+	    $this->ci = & $ci;
 	}
 
 	//--------------------------------------------------------------------
@@ -30,16 +30,16 @@ 
 
 		@$this->ensureFolder($destination);
 
-		while (false !== ( $file = readdir($dir)) )
+		while (false !== ($file = readdir($dir)))
 		{
-			if ( ! in_array($file, $this->ignore_files) )
+			if ( ! in_array($file, $this->ignore_files))
 			{
-				if ( is_dir($source .'/'. $file) )
+				if (is_dir($source.'/'.$file))
 				{
-					$this->copyFolder($source .'/'. $file, $destination .'/'. $file);
+					$this->copyFolder($source.'/'.$file, $destination.'/'.$file);
 				}
 				else {
-					copy($source .'/'. $file, $destination .'/'. $file);
+					copy($source.'/'.$file, $destination.'/'.$file);
 				}
 			}
 		}
@@ -74,7 +74,7 @@ 
 	 * @param $path
 	 * @param array $leave_files
 	 */
-	public function cleanFolder($path, $leave_files=[])
+	public function cleanFolder($path, $leave_files = [])
 	{
 		foreach (glob("{$path}/*") as $file)
 		{
@@ -97,25 +97,25 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function compressFolder($source, $destination, $include_dir=false)
+	public function compressFolder($source, $destination, $include_dir = false)
 	{
-		if (! extension_loaded('zip') ) {
+		if ( ! extension_loaded('zip')) {
 			CLI::error('ZipArchive extension is required.');
 			exit(1);
 		}
 
-		if (! file_exists($source)) {
+		if ( ! file_exists($source)) {
 			CLI::error('Source folder not found for zipping.');
 			exit(1);
 		}
 
 		if (file_exists($destination))
 		{
-			unlink ($destination);
+			unlink($destination);
 		}
 
 		$zip = new ZipArchive();
-		if (! $zip->open($destination, ZIPARCHIVE::CREATE))
+		if ( ! $zip->open($destination, ZIPARCHIVE::CREATE))
 		{
 			CLI::error('Unknown error opening zip file.');
 			exit(1);
@@ -129,12 +129,12 @@ 
 
 			if ($include_dir) {
 
-				$arr = explode("/",$source);
-				$maindir = $arr[count($arr)- 1];
+				$arr = explode("/", $source);
+				$maindir = $arr[count($arr) - 1];
 
 				$source = "";
-				for ($i=0; $i < count($arr) - 1; $i++) {
-					$source .= '/' . $arr[$i];
+				for ($i = 0; $i < count($arr) - 1; $i++) {
+					$source .= '/'.$arr[$i];
 				}
 
 				$source = substr($source, 1);
@@ -147,18 +147,18 @@ 
 				$file = str_replace('\\', '/', $file);
 
 				// Ignore "." and ".." folders
-				if( in_array(substr($file, strrpos($file, '/')+1), array('.', '..', '.DS_Store')) )
+				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 . '/'));
+					$zip->addEmptyDir(str_replace($source.'/', '', $file.'/'));
 				}
 				else if (is_file($file) === true)
 				{
-					$zip->addFromString(str_replace($source . '/', '', $file), file_get_contents($file));
+					$zip->addFromString(str_replace($source.'/', '', $file), file_get_contents($file));
 				}
 			}
 		}

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 )
 	{

Spacing +53 added lines, -53 removed lines

@@ -56,7 +56,7 @@ 
 	 * @param array $segments
 	 * @param bool $quiet
 	 */
-	public function run($segments=[], $quiet=false)
+	public function run($segments = [], $quiet = false)
 	{
 		// Show an index?
 		if (empty($segments[0]))
@@ -75,7 +75,7 @@ 
 				$this->scaffold($segments, $quiet);
 				break;
 			default:
-				if (! $quiet)
+				if ( ! $quiet)
 				{
 					CLI::write('Nothing to do.', 'green');
 				}
@@ -89,8 +89,8 @@ 
 	{
 		CLI::write("\nAvailable API Generators");
 
-		CLI::write( CLI::color('install', 'yellow') .'   install        Creates migrations, alters config file for desired authentication' );
-		CLI::write( CLI::color('scaffold', 'yellow') .'  scaffold <name>  Creates basic CRUD controller, routes, and optionally API Blueprint files' );
+		CLI::write(CLI::color('install', 'yellow').'   install        Creates migrations, alters config file for desired authentication');
+		CLI::write(CLI::color('scaffold', 'yellow').'  scaffold <name>  Creates basic CRUD controller, routes, and optionally API Blueprint files');
 	}
 
 	//--------------------------------------------------------------------
@@ -105,7 +105,7 @@ 
 	 * @param $segments
 	 * @param $quiet
 	 */
-	private function scaffold( $segments, $quiet )
+	private function scaffold($segments, $quiet)
 	{
 		$this->load->helper('inflector');
 
@@ -118,7 +118,7 @@ 
 
 		if (empty($resource))
 		{
-			$resource = strtolower( CLI::prompt('Resource name') );
+			$resource = strtolower(CLI::prompt('Resource name'));
 		}
 
 		// Resources should be plural, but we'll need a singular name also.
@@ -138,27 +138,27 @@ 
 
 		if (empty($model))
 		{
-			$model = $this->detectModel( $resource_single );
+			$model = $this->detectModel($resource_single);
 		}
 
 		/*
 		 * Start Building
 		 */
-		$this->destination = APPPATH .'controllers/';
-		if (! empty($version))
+		$this->destination = APPPATH.'controllers/';
+		if ( ! empty($version))
 		{
-			$this->destination .= $version .'/';
+			$this->destination .= $version.'/';
 		}
 
 		// Controller
-		if (! $this->createController($resource_single, $resource_plural, $version) )
+		if ( ! $this->createController($resource_single, $resource_plural, $version))
 		{
 			CLI::error('Unknown error creating Controller.');
 			exit(1);
 		}
 
 		// Language Files
-		if (! $this->createLanguage($resource_single, $resource_plural, $version, $model) )
+		if ( ! $this->createLanguage($resource_single, $resource_plural, $version, $model))
 		{
 			CLI::error('Unknown error creating Language File.');
 			exit(1);
@@ -167,7 +167,7 @@ 
 		// Blueprint File
 		if ($blueprint)
 		{
-			if (! $this->createBlueprint($resource_single, $resource_plural, $version, $model) )
+			if ( ! $this->createBlueprint($resource_single, $resource_plural, $version, $model))
 			{
 				CLI::error('Unknown error creating Blueprint file.');
 				exit(1);
@@ -175,7 +175,7 @@ 
 		}
 
 		// Modify Routes
-		if (! $this->addRoutes($resource_plural, $version) )
+		if ( ! $this->addRoutes($resource_plural, $version))
 		{
 			CLI::error('Unknown error adding Routes.');
 			exit(1);
@@ -195,7 +195,7 @@ 
 		CLI::write("\nVersions are simply controller folders (i.e. controllers/v1/...)");
 		CLI::write("(Enter 'na' for no version folder)");
 
-		$version = strtolower( CLI::prompt('Version name', 'v1') );
+		$version = strtolower(CLI::prompt('Version name', 'v1'));
 		$version = $version == 'na' ? '' : $version;
 
 		return $version;
@@ -211,7 +211,7 @@ 
 	private function askBlueprint()
 	{
 		CLI::write("\nAPI Blueprint is a plain-text API documentation starter.");
-		CLI::write("See: ". CLI::color('https://apiblueprint.org', 'light_blue'));
+		CLI::write("See: ".CLI::color('https://apiblueprint.org', 'light_blue'));
 
 		$make_blueprint = CLI::prompt('Create Blueprint file?', ['y', 'n']);
 
@@ -222,16 +222,16 @@ 
 
 	private function detectModel($name)
 	{
-		$model_name = ucfirst($name) .'_model.php';
+		$model_name = ucfirst($name).'_model.php';
 
-		if (! file_exists(APPPATH .'models/'. $model_name))
+		if ( ! file_exists(APPPATH.'models/'.$model_name))
 		{
 			CLI::write("\nUnable to find model named: {$model_name}");
 			$model_name = CLI::prompt('Model filename');
 		}
 		else
 		{
-			CLI::write("Using model: ". CLI::color($model_name, 'yellow') );
+			CLI::write("Using model: ".CLI::color($model_name, 'yellow'));
 		}
 
 		return $model_name;
@@ -250,20 +250,20 @@ 
      * @internal param $name
      *
      */
-	private function createController( $single, $plural, $version )
+	private function createController($single, $plural, $version)
 	{
 		$data = [
-			'today'             => date( 'Y-m-d H:ia' ),
-			'model_name'        => strtolower($single) .'_model',
+			'today'             => date('Y-m-d H:ia'),
+			'model_name'        => strtolower($single).'_model',
 			'plural'            => $plural,
 			'single'            => $single,
 			'class_name'        => ucfirst($plural),
 			'version'           => $version
 		];
 
-		$destination = $this->destination . ucfirst($plural) .'.php';
+		$destination = $this->destination.ucfirst($plural).'.php';
 
-		return $this->copyTemplate( 'controller', $destination, $data, $this->overwrite );
+		return $this->copyTemplate('controller', $destination, $data, $this->overwrite);
 	}
 
 	//--------------------------------------------------------------------
@@ -277,7 +277,7 @@ 
      *
      * @return $this
      */
-	private function createLanguage( $single, $plural, $version )
+	private function createLanguage($single, $plural, $version)
 	{
         $data = [
             'plural'            => $plural,
@@ -286,9 +286,9 @@ 
             'uc_plural'         => ucfirst($plural),
         ];
 
-        $destination = APPPATH ."language/english/api_{$plural}_lang.php";
+        $destination = APPPATH."language/english/api_{$plural}_lang.php";
 
-        return $this->copyTemplate( 'lang', $destination, $data, $this->overwrite );
+        return $this->copyTemplate('lang', $destination, $data, $this->overwrite);
 	}
 
 	//--------------------------------------------------------------------
@@ -306,17 +306,17 @@ 
      * @internal param $name
      *
      */
-	private function createBlueprint( $single, $plural, $version, $model )
+	private function createBlueprint($single, $plural, $version, $model)
 	{
 		$version = rtrim($version, '/');
-		if (! empty($version))
+		if ( ! empty($version))
 		{
 			$version .= '/';
 		}
 
 		// Load the model so we can use the correct table to use
-        $model = strtolower( str_replace('.php', '', $model) );
-		$this->load->model( $model, $model, true );
+        $model = strtolower(str_replace('.php', '', $model));
+		$this->load->model($model, $model, true);
 
         $obj = $this->formatObject($model);
 
@@ -331,11 +331,11 @@ 
             'formatted'         => $obj
 		];
 
-		$destination = APPPATH .'docs/api/'. $version . $plural .'.md';
+		$destination = APPPATH.'docs/api/'.$version.$plural.'.md';
 
-		$success = $this->copyTemplate( 'blueprint', $destination, $data, $this->overwrite );
+		$success = $this->copyTemplate('blueprint', $destination, $data, $this->overwrite);
 
-        if (! $this->updateTOC($plural, $version))
+        if ( ! $this->updateTOC($plural, $version))
         {
             CLI::write("\tUnable to modify the toc file.", 'light_red');
         }
@@ -353,21 +353,21 @@ 
      *
      * @return $this|bool
      */
-    private function updateTOC( $plural, $version )
+    private function updateTOC($plural, $version)
     {
-        $path = APPPATH .'docs/_toc.ini';
+        $path = APPPATH.'docs/_toc.ini';
 
         // We need a TOC file to exist if we're going to modify it silly.
-        if (! file_exists($path))
+        if ( ! file_exists($path))
         {
-            if (! $this->copyTemplate('toc', $path))
+            if ( ! $this->copyTemplate('toc', $path))
             {
                 return false;
             }
         }
 
         $version = rtrim($version, '/ ');
-        if (! empty($version))
+        if ( ! empty($version))
         {
             $version .= '/';
         }
@@ -389,7 +389,7 @@ 
      *
      * @return string
      */
-    private function formatObject( $model )
+    private function formatObject($model)
     {
         $fields = $this->db->field_data($this->$model->table_name);
 
@@ -448,14 +448,14 @@ 
      *
      * @return $this
      */
-	private function addRoutes( $plural, $version )
+	private function addRoutes($plural, $version)
 	{
-        $path = APPPATH .'config/routes.php';
+        $path = APPPATH.'config/routes.php';
 
         $version = rtrim($version, ', ');
-        if (! empty($version))
+        if ( ! empty($version))
         {
-            $version .='/';
+            $version .= '/';
         }
 
         $content = "\$routes->resources('{$version}{$plural}');\n";
@@ -476,9 +476,9 @@ 
 	 */
 	private function install( )
 	{
-		CLI::write("Available Auth Types: ". CLI::color('basic, digest, none', 'yellow') );
+		CLI::write("Available Auth Types: ".CLI::color('basic, digest, none', 'yellow'));
 
-		$this->auth_type = trim( CLI::prompt('Auth type') );
+		$this->auth_type = trim(CLI::prompt('Auth type'));
 
 		switch ($this->auth_type)
 		{
@@ -531,24 +531,24 @@ 
 
 		// Update the config setting
 		$content = "config['api.enable_logging']    = true;";
-		$this->injectIntoFile(APPPATH .'config/api.php', $content, ['regex' => "/config\['api.enable_logging']\s+=\s+[a-zA-Z]+;/u"] );
+		$this->injectIntoFile(APPPATH.'config/api.php', $content, ['regex' => "/config\['api.enable_logging']\s+=\s+[a-zA-Z]+;/u"]);
 	}
 
 	//--------------------------------------------------------------------
 
 
-	private function makeMigration( $tpl, $name )
+	private function makeMigration($tpl, $name)
 	{
 		// Create the migration
 		$this->load->library('migration');
 
 		$destination = $this->migration->determine_migration_path('app', true);
 
-		$file = $this->migration->make_name( $name );
+		$file = $this->migration->make_name($name);
 
-		$destination = rtrim($destination, '/') .'/'. $file;
+		$destination = rtrim($destination, '/').'/'.$file;
 
-		if (! $this->copyTemplate( $tpl, $destination, [], true) )
+		if ( ! $this->copyTemplate($tpl, $destination, [], true))
 		{
 			CLI::error('Error creating migration file.');
 		}
@@ -563,11 +563,11 @@ 
 	 *
 	 * @param $type
 	 */
-	private function setAuthType( $type )
+	private function setAuthType($type)
 	{
 		$content = "config['api.auth_type']    = '{$type}';";
 
-		$this->injectIntoFile(APPPATH .'config/api.php', $content, ['regex' => "/config\['api.auth_type']\s+=\s+'[a-zA-Z]+';/u"] );
+		$this->injectIntoFile(APPPATH.'config/api.php', $content, ['regex' => "/config\['api.auth_type']\s+=\s+'[a-zA-Z]+';/u"]);
 	}
 
 	//--------------------------------------------------------------------

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 )
 	{

Spacing +58 added lines, -60 removed lines

@@ -47,49 +47,49 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function run( $segments = [ ], $quiet = FALSE )
+	public function run($segments = [], $quiet = FALSE)
 	{
-		$name = array_shift( $segments );
+		$name = array_shift($segments);
 
-		if ( empty( $name ) )
+		if (empty($name))
 		{
-			$name = CLI::prompt( 'Controller name' );
+			$name = CLI::prompt('Controller name');
 		}
 
 		// Format to CI Standards
-		$name = ucfirst( $name );
+		$name = ucfirst($name);
 
-		if ( $quiet === FALSE )
+		if ($quiet === FALSE)
 		{
-			$this->collectOptions( $name );
+			$this->collectOptions($name);
 		}
 		else
 		{
-			$this->quietSetOptions( $name );
+			$this->quietSetOptions($name);
 		}
 
 		$data = [
 			'controller_name' => $name,
-			'today'           => date( 'Y-m-d H:ia' )
+			'today'           => date('Y-m-d H:ia')
 		];
 
-		$data = array_merge( $data, $this->options );
+		$data = array_merge($data, $this->options);
 
 		if ($data['themed'] == 'y' || $data['themed'] === true)
 		{
 			$data['base_class'] = 'ThemedController';
 		}
 
-		$destination = $this->determineOutputPath( 'controllers' ) . $name . '.php';
+		$destination = $this->determineOutputPath('controllers').$name.'.php';
 
-		if ( ! $this->copyTemplate( 'controller', $destination, $data, $this->overwrite ) )
+		if ( ! $this->copyTemplate('controller', $destination, $data, $this->overwrite))
 		{
-			CLI::error( 'Error creating new files' );
+			CLI::error('Error creating new files');
 		}
 
-		if ( CLI::option( 'create_views' ) && $this->options['themed'] == 'y' )
+		if (CLI::option('create_views') && $this->options['themed'] == 'y')
 		{
-			$this->createViews( $name );
+			$this->createViews($name);
 		}
 
 		return TRUE;
@@ -97,20 +97,20 @@ 
 
 	//--------------------------------------------------------------------
 
-	protected function quietSetOptions( $name )
+	protected function quietSetOptions($name)
 	{
 		$options = CLI::getOptions();
 
-		if ( ! empty( $options['model'] ) )
+		if ( ! empty($options['model']))
 		{
 			$this->options['model'] = $options['model'];
 
 			// Format per CI
-			if ( ! empty( $this->options['model'] ) && substr( $this->options['model'], - 6 ) !== '_model' )
+			if ( ! empty($this->options['model']) && substr($this->options['model'], - 6) !== '_model')
 			{
 				$this->options['model'] .= '_model';
 			}
-			$this->options['model'] = ! empty( $this->options['model'] ) ? ucfirst( $this->options['model'] ) : NULL;
+			$this->options['model'] = ! empty($this->options['model']) ? ucfirst($this->options['model']) : NULL;
 
 			$this->options['themed'] = 'y';
 		}
@@ -120,36 +120,34 @@ 
 
 	//--------------------------------------------------------------------
 
-	protected function collectOptions( $name )
+	protected function collectOptions($name)
 	{
 		$options = CLI::getOptions();
 
 		// Model?
-		$this->options['model'] = empty( $options['model'] ) ?
-			CLI::prompt( 'Model Name? (empty is fine)' ) :
-			$options['model'];
+		$this->options['model'] = empty($options['model']) ?
+			CLI::prompt('Model Name? (empty is fine)') : $options['model'];
 
 		// Format per CI
-		if ( ! empty( $this->options['model'] ) && substr( $this->options['model'], - 6 ) !== '_model' )
+		if ( ! empty($this->options['model']) && substr($this->options['model'], - 6) !== '_model')
 		{
 			$this->options['model'] .= '_model';
 		}
-		$this->options['model'] = ! empty( $this->options['model'] ) ? ucfirst( $this->options['model'] ) : NULL;
+		$this->options['model'] = ! empty($this->options['model']) ? ucfirst($this->options['model']) : NULL;
 
 		// If we're using a model, then force the use of a themed controller.
-		if ( ! empty( $this->options['model'] ) )
+		if ( ! empty($this->options['model']))
 		{
 			$options['themed'] = 'y';
 		}
 
 		// Themed Controller?
-		$this->options['themed'] = empty( $options['themed'] ) ?
-			CLI::prompt( 'Is a Themed Controller?', [ 'y', 'n' ] ) :
-			$options['themed'];
+		$this->options['themed'] = empty($options['themed']) ?
+			CLI::prompt('Is a Themed Controller?', ['y', 'n']) : $options['themed'];
 
 		$this->options['themed'] = $this->options['themed'] == 'y' ? TRUE : FALSE;
 
-		if ( $this->options['themed'] )
+		if ($this->options['themed'])
 		{
 			$this->options['base_class'] = 'ThemedController';
 		}
@@ -160,35 +158,35 @@ 
 	/**
 	 * Generates the standard views for our CRUD methods.
 	 */
-	protected function createViews( $name )
+	protected function createViews($name)
 	{
-		$this->load->helper( 'inflector' );
+		$this->load->helper('inflector');
 
 		$data = [
 			'name'        => $name,
 			'lower_name'  => strtolower($name),
-			'single_name' => singular( $name ),
-			'plural_name' => plural( $name ),
+			'single_name' => singular($name),
+			'plural_name' => plural($name),
 			'fields'      => $this->prepareFields()
 		];
 
-		$subfolder = empty( $this->module ) ? '/' . strtolower($name) : '/'. $data['lower_name'];
+		$subfolder = empty($this->module) ? '/'.strtolower($name) : '/'.$data['lower_name'];
 
 		// Index
-		$destination = $this->determineOutputPath( 'views' . $subfolder ) . 'index.php';
-		$this->copyTemplate( 'view_index', $destination, $data, $this->overwrite );
+		$destination = $this->determineOutputPath('views'.$subfolder).'index.php';
+		$this->copyTemplate('view_index', $destination, $data, $this->overwrite);
 
 		// Create
-		$destination = $this->determineOutputPath( 'views' . $subfolder ) . 'create.php';
-		$this->copyTemplate( 'view_create', $destination, $data, $this->overwrite );
+		$destination = $this->determineOutputPath('views'.$subfolder).'create.php';
+		$this->copyTemplate('view_create', $destination, $data, $this->overwrite);
 
 		// Show
-		$destination = $this->determineOutputPath( 'views' . $subfolder ) . 'show.php';
-		$this->copyTemplate( 'view_show', $destination, $data, $this->overwrite );
+		$destination = $this->determineOutputPath('views'.$subfolder).'show.php';
+		$this->copyTemplate('view_show', $destination, $data, $this->overwrite);
 
 		// Index
-		$destination = $this->determineOutputPath( 'views' . $subfolder ) . 'update.php';
-		$this->copyTemplate( 'view_update', $destination, $data, $this->overwrite );
+		$destination = $this->determineOutputPath('views'.$subfolder).'update.php';
+		$this->copyTemplate('view_update', $destination, $data, $this->overwrite);
 	}
 
 	//--------------------------------------------------------------------
@@ -199,14 +197,14 @@ 
 	 */
 	protected function prepareFields()
 	{
-		$fields = CLI::option( 'fields' );
+		$fields = CLI::option('fields');
 
-		if ( empty( $fields ) )
+		if (empty($fields))
 		{
             // If we have a model, we can get our fields from there
-            if (! empty($this->options['model']))
+            if ( ! empty($this->options['model']))
             {
-                $fields = $this->getFieldsFromModel( $this->options['model'] );
+                $fields = $this->getFieldsFromModel($this->options['model']);
 
                 if (empty($fields))
                 {
@@ -219,15 +217,15 @@ 
             }
 		}
 
-		$fields = explode( ' ', $fields );
+		$fields = explode(' ', $fields);
 
-		$new_fields = [ ];
+		$new_fields = [];
 
-		foreach ( $fields as $field )
+		foreach ($fields as $field)
 		{
-			$pop = [ NULL, NULL, NULL ];
-			list( $field, $type, $size ) = array_merge( explode( ':', $field ), $pop );
-			$type = strtolower( $type );
+			$pop = [NULL, NULL, NULL];
+			list($field, $type, $size) = array_merge(explode(':', $field), $pop);
+			$type = strtolower($type);
 
 			// Ignore list
 			if (in_array($field, ['created_on', 'modified_on']))
@@ -277,16 +275,16 @@ 
 
 	//--------------------------------------------------------------------
 
-    private function getFieldsFromModel( $model )
+    private function getFieldsFromModel($model)
     {
         $this->load->model($model);
 
-        if (! $this->db->table_exists( $this->$model->table() ))
+        if ( ! $this->db->table_exists($this->$model->table()))
         {
             return '';
         }
 
-        $fields = $this->db->field_data( $this->$model->table() );
+        $fields = $this->db->field_data($this->$model->table());
 
         $return = '';
 
@@ -294,14 +292,14 @@ 
         // it would have been passed on the CLI
         foreach ($fields as $field)
         {
-            $temp = $field->name .':'. $field->type;
+            $temp = $field->name.':'.$field->type;
 
-            if (! empty($field->max_length))
+            if ( ! empty($field->max_length))
             {
-                $temp .= ':'. $field->max_length;
+                $temp .= ':'.$field->max_length;
             }
 
-            $return .= ' '. $temp;
+            $return .= ' '.$temp;
         }
 
         return $return;

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)
 	{

Spacing +34 added lines, -35 removed lines

@@ -92,27 +92,27 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function run($segments=[], $quiet=false)
+	public function run($segments = [], $quiet = false)
 	{
-		$name = array_shift( $segments );
+		$name = array_shift($segments);
 
-		if ( empty( $name ) )
+		if (empty($name))
 		{
-			$name = CLI::prompt( 'Migration name' );
+			$name = CLI::prompt('Migration name');
 		}
 
 		// Format to CI Standards
-		$name = str_replace('.php', '', strtolower( $name ) );
+		$name = str_replace('.php', '', strtolower($name));
 
 		$this->detectAction($name);
 
-		$this->collectOptions( $name, $quiet );
+		$this->collectOptions($name, $quiet);
 
 		$data = [
 			'name'              => $name,
 			'clean_name'        => ucwords(str_replace('_', ' ', $name)),
-			'today'             => date( 'Y-m-d H:ia' ),
-			'fields'            => trim( $this->stringify( $this->fields ), ', '),
+			'today'             => date('Y-m-d H:ia'),
+			'fields'            => trim($this->stringify($this->fields), ', '),
 			'raw_fields'        => $this->fields,
 			'action'            => $this->action,
 			'table'             => $this->table,
@@ -120,9 +120,9 @@ 
 			'column'            => $this->column
 		];
 
-		if (! empty($this->column) && array_key_exists($this->column, $this->fields))
+		if ( ! empty($this->column) && array_key_exists($this->column, $this->fields))
 		{
-			$data['column_string'] = trim( $this->stringify($this->fields[$this->column]), ', ');
+			$data['column_string'] = trim($this->stringify($this->fields[$this->column]), ', ');
 		}
 
 		$this->load->library('migration');
@@ -130,17 +130,17 @@ 
 		// todo Allow different migration "types"
 		$type = 'app';
 
-		if (! empty($this->module))
+		if ( ! empty($this->module))
 		{
-			$type = 'mod:'. $this->module;
+			$type = 'mod:'.$this->module;
 		}
 		$destination = $this->migration->determine_migration_path($type, true);
 
 		$file = $this->migration->make_name($name);
 
-		$destination = rtrim($destination, '/') .'/'. $file;
+		$destination = rtrim($destination, '/').'/'.$file;
 
-		if (! $this->copyTemplate( 'migration', $destination, $data, true) )
+		if ( ! $this->copyTemplate('migration', $destination, $data, true))
 		{
 			CLI::error('Error creating seed file.');
 		}
@@ -173,7 +173,7 @@ 
 			$action = $this->actionMap[$action];
 		}
 
-		if (! in_array($action, $this->allowedActions))
+		if ( ! in_array($action, $this->allowedActions))
 		{
 			return;
 		}
@@ -187,7 +187,7 @@ 
 
 			// The name of the table is assumed to be the one
 			// prior to the $index found.
-			$this->table = plural( implode('_', array_slice($segments, 0, $index) ) );
+			$this->table = plural(implode('_', array_slice($segments, 0, $index)));
 		}
 
 		// Are we referencing a column?
@@ -199,12 +199,12 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function collectOptions($name, $quiet=false)
+	public function collectOptions($name, $quiet = false)
 	{
 		$options = CLI::getOptions();
 
 		// Use existing db table?
-		if (array_key_exists('fromdb', $options) )
+		if (array_key_exists('fromdb', $options))
 		{
 			$this->readTable($this->table);
 		}
@@ -217,10 +217,9 @@ 
 				return;
 			}
 
-			$fields = empty( $fields ) ?
-				CLI::prompt( 'Fields? (name:type)' ) :
-				$options['fields'];
-			$this->fields = $this->parseFields( $fields );
+			$fields = empty($fields) ?
+				CLI::prompt('Fields? (name:type)') : $options['fields'];
+			$this->fields = $this->parseFields($fields);
 		}
 	}
 
@@ -244,7 +243,7 @@ 
 		$fields = [];
 		$segments = explode(' ', $str);
 
-		if (! count($segments))
+		if ( ! count($segments))
 		{
 			return $fields;
 		}
@@ -252,7 +251,7 @@ 
 		foreach ($segments as $segment)
 		{
 			$pop = [null, null, null];
-			list($field, $type, $size) = array_merge( explode(':', $segment), $pop);
+			list($field, $type, $size) = array_merge(explode(':', $segment), $pop);
 			$type = strtolower($type);
 
 			// Is type one of our convenience mapped items?
@@ -261,7 +260,7 @@ 
 				$type = $this->map[$type];
 			}
 
-			$f = [ 'type' => $type ];
+			$f = ['type' => $type];
 
 			// Creating a primary key?
 			if ($type == 'id')
@@ -275,9 +274,9 @@ 
 			}
 
 			// Constraint?
-			if (! empty($size))
+			if ( ! empty($size))
 			{
-				$f['constraint'] = (int)$size;
+				$f['constraint'] = (int) $size;
 			}
 			else if (array_key_exists($type, $this->defaultSizes))
 			{
@@ -319,7 +318,7 @@ 
 		}
 
 		// Table exists?
-		if (! $this->db->table_exists($table))
+		if ( ! $this->db->table_exists($table))
 		{
 			return false;
 		}
@@ -327,7 +326,7 @@ 
 		$fields = $this->db->field_data($table);
 
 		// Any fields?
-		if (! is_array($fields) || ! count($fields))
+		if ( ! is_array($fields) || ! count($fields))
 		{
 			return false;
 		}
@@ -336,30 +335,30 @@ 
 
 		foreach ($fields as $field)
 		{
-			$f = [ 'type' => $field->type ];
+			$f = ['type' => $field->type];
 
 			// Constraint
-			if (! empty($field->max_length))
+			if ( ! empty($field->max_length))
 			{
 				$f['constraint'] = $field->max_length;
 			}
 			else if (array_key_exists($field->type, $this->defaultSizes))
 			{
-				$f['constraint'] = $this->defaultSizes[ $field->type ];
+				$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)
+			if ( ! empty($field->primary_key) && $field->primary_key == 1)
 			{
 				$this->primary_key = $field->name;
 				$f['auto_increment'] = true;
 				$f['unsigned'] = true;
 			}
 
-			$new_fields[ $field->name ] = $f;
+			$new_fields[$field->name] = $f;
 		}
 
 		$this->fields = $new_fields;

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

Spacing +61 added lines, -64 removed lines

@@ -56,47 +56,47 @@ 
 
 	//--------------------------------------------------------------------
 
-	public function run( $segments = [ ], $quiet = false )
+	public function run($segments = [], $quiet = false)
 	{
-		$name = array_shift( $segments );
+		$name = array_shift($segments);
 
         $options = CLI::getOptions();
 
-		$this->options['table_name'] = array_shift( $segments );
+		$this->options['table_name'] = array_shift($segments);
 
-		if ( empty( $name ) )
+		if (empty($name))
 		{
-			$name = CLI::prompt( 'Model name' );
+			$name = CLI::prompt('Model name');
 		}
 
 		// Format to CI Standards
-		if ( substr( $name, - 6 ) !== '_model' )
+		if (substr($name, - 6) !== '_model')
 		{
 			$name .= '_model';
 		}
-		$name = ucfirst( $name );
+		$name = ucfirst($name);
 
-		if ( $quiet === false )
+		if ($quiet === false)
 		{
-			$this->collectOptions( $name, $options );
+			$this->collectOptions($name, $options);
 		}
 		else
 		{
-			$this->quietSetOptions( $name, $options );
+			$this->quietSetOptions($name, $options);
 		}
 
 		$data = [
 			'model_name' => $name,
-			'today'      => date( 'Y-m-d H:ia' )
+			'today'      => date('Y-m-d H:ia')
 		];
 
-		$data = array_merge( $data, $this->options );
+		$data = array_merge($data, $this->options);
 
-		$destination = $this->determineOutputPath( 'models' ) . $name . '.php';
+		$destination = $this->determineOutputPath('models').$name.'.php';
 
-		if ( ! $this->copyTemplate( 'model', $destination, $data, $this->overwrite ) )
+		if ( ! $this->copyTemplate('model', $destination, $data, $this->overwrite))
 		{
-			CLI::error( 'Error creating new files' );
+			CLI::error('Error creating new files');
 		}
 
 		return TRUE;
@@ -107,70 +107,67 @@ 
 	/*
 	 * Customizes our settings
 	 */
-	protected function collectOptions( $model_name, $options=[] )
+	protected function collectOptions($model_name, $options = [])
 	{
-		$this->load->helper( 'inflector' );
+		$this->load->helper('inflector');
 
 		// Table Name?
-		if ( empty( $this->options['table_name'] ) )
+		if (empty($this->options['table_name']))
 		{
-			$this->options['table_name'] = empty( $options['table'] ) ?
-				CLI::prompt( 'Table name', plural( strtolower( str_replace( '_model', '', $model_name ) ) ) ) :
-				$options['table'];
+			$this->options['table_name'] = empty($options['table']) ?
+				CLI::prompt('Table name', plural(strtolower(str_replace('_model', '', $model_name)))) : $options['table'];
 		}
 
-		$this->options['fields'] = $this->table_info( $this->options['table_name'], $options );
+		$this->options['fields'] = $this->table_info($this->options['table_name'], $options);
 
 		// Primary Key
 		if (empty($this->options['primary_key']))
 		{
-			$this->options['primary_key'] = empty( $options['primary_key'] ) ?
-				CLI::prompt( 'Primary Key', 'id' ) :
-				$options['primary_key'];
+			$this->options['primary_key'] = empty($options['primary_key']) ?
+				CLI::prompt('Primary Key', 'id') : $options['primary_key'];
 		}
 
-		$this->options['protected'] = [ $this->options['primary_key'] ];
+		$this->options['protected'] = [$this->options['primary_key']];
 
 		// Set Created?
-		if ( empty( $options['set_created'] ) )
+		if (empty($options['set_created']))
 		{
-			$ans = CLI::prompt( 'Set Created date?', [ 'y', 'n' ] );
-			if ( $ans == 'n' )
+			$ans = CLI::prompt('Set Created date?', ['y', 'n']);
+			if ($ans == 'n')
 			{
 				$this->options['set_created'] = FALSE;
 			}
 		}
 
 		// Set Modified?
-		if ( empty( $options['set_modified'] ) )
+		if (empty($options['set_modified']))
 		{
-			$ans = CLI::prompt( 'Set Modified date?', [ 'y', 'n' ] );
-			if ( $ans == 'n' )
+			$ans = CLI::prompt('Set Modified date?', ['y', 'n']);
+			if ($ans == 'n')
 			{
 				$this->options['set_modified'] = FALSE;
 			}
 		}
 
 		// Date Format
-		$this->options['date_format'] = empty( $options['date_format'] ) ?
-			CLI::prompt( 'Date Format?', [ 'datetime', 'date', 'int' ] ) :
-			$options['date_format'];
+		$this->options['date_format'] = empty($options['date_format']) ?
+			CLI::prompt('Date Format?', ['datetime', 'date', 'int']) : $options['date_format'];
 
 		// Log User?
-		if ( empty( $options['log_user'] ) )
+		if (empty($options['log_user']))
 		{
-			$ans = CLI::prompt( 'Log User actions?', [ 'y', 'n' ] );
-			if ( $ans == 'y' )
+			$ans = CLI::prompt('Log User actions?', ['y', 'n']);
+			if ($ans == 'y')
 			{
 				$this->options['log_user'] = TRUE;
 			}
 		}
 
 		// Soft Deletes
-		if ( empty( $options['soft_delete'] ) )
+		if (empty($options['soft_delete']))
 		{
-			$ans = CLI::prompt( 'Use Soft Deletes?', [ 'y', 'n' ] );
-			if ( $ans == 'n' )
+			$ans = CLI::prompt('Use Soft Deletes?', ['y', 'n']);
+			if ($ans == 'n')
 			{
 				$this->options['soft_delete'] = false;
 			}
@@ -180,21 +177,21 @@ 
 
 	//--------------------------------------------------------------------
 
-	protected function quietSetOptions( $model_name, $options=[] )
+	protected function quietSetOptions($model_name, $options = [])
 	{
-		$this->load->helper( 'inflector' );
+		$this->load->helper('inflector');
 
 		if (empty($this->options['table_name']))
 		{
-			$this->options['table_name'] = plural( strtolower( str_replace( '_model', '', $model_name ) ) );
+			$this->options['table_name'] = plural(strtolower(str_replace('_model', '', $model_name)));
 		}
 
 		// Try to set it from the database first,
 		// otherwise, try to pull from fields
-		$this->options['fields'] = $this->table_info( $this->options['table_name'], $options );
+		$this->options['fields'] = $this->table_info($this->options['table_name'], $options);
 
-		$this->options['primary_key'] = ! empty( $this->options['primary_key'] ) ? $this->options['primary_key'] : 'id';
-		$this->options['protected']   = [ $this->options['primary_key'] ];
+		$this->options['primary_key'] = ! empty($this->options['primary_key']) ? $this->options['primary_key'] : 'id';
+		$this->options['protected']   = [$this->options['primary_key']];
 	}
 
 	//--------------------------------------------------------------------
@@ -206,12 +203,12 @@ 
 	 *
 	 * @return mixed An array of fields or false if the table does not exist
 	 */
-	protected function table_info( $table_name, $options=[] )
+	protected function table_info($table_name, $options = [])
 	{
 		$this->load->database();
 
 		// Check whether the table exists in this database
-		if ( ! $this->db->table_exists( $table_name ) )
+		if ( ! $this->db->table_exists($table_name))
 		{
             if (empty($options['fields']))
             {
@@ -222,12 +219,12 @@ 
 		}
         else
         {
-            $fields = $this->db->field_data( $table_name );
+            $fields = $this->db->field_data($table_name);
         }
 
 		// There may be something wrong or the database driver may not return
 		// field data
-		if ( empty( $fields ) )
+		if (empty($fields))
 		{
 			return FALSE;
 		}
@@ -237,9 +234,9 @@ 
         $this->options['use_soft_deletes']  = false;
 
 		// Use the primary key if the table has one already set.
-		foreach ( $fields as $field )
+		foreach ($fields as $field)
 		{
-			if ( ! empty( $field->primary_key ) && $field->primary_key == 1 )
+			if ( ! empty($field->primary_key) && $field->primary_key == 1)
 			{
 				$this->options['primary_key'] = $field->name;
 			}
@@ -261,7 +258,7 @@ 
 		}
 
 		// Set our validation rules based on these fields
-		$this->options['rules'] = $this->buildValidationRules( $fields );
+		$this->options['rules'] = $this->buildValidationRules($fields);
 
 		return $fields;
 	}
@@ -274,20 +271,20 @@ 
      */
     protected function parseFieldString($fields)
     {
-        if ( empty( $fields ) )
+        if (empty($fields))
         {
             return NULL;
         }
 
-        $fields = explode( ' ', $fields );
+        $fields = explode(' ', $fields);
 
-        $new_fields = [ ];
+        $new_fields = [];
 
-        foreach ( $fields as $field )
+        foreach ($fields as $field)
         {
-            $pop = [ NULL, NULL, NULL ];
-            list( $field, $type, $size ) = array_merge( explode( ':', $field ), $pop );
-            $type = strtolower( $type );
+            $pop = [NULL, NULL, NULL];
+            list($field, $type, $size) = array_merge(explode(':', $field), $pop);
+            $type = strtolower($type);
 
             // Strings
             if (in_array($type, ['char', 'varchar', 'string']))
@@ -328,7 +325,7 @@ 
 
         // Convert to objects
         array_walk($new_fields, function(&$item, $key) {
-            $item = (object)$item;
+            $item = (object) $item;
         });
 
         return $new_fields;
@@ -345,7 +342,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function buildValidationrules($fields=[])
+	public function buildValidationrules($fields = [])
 	{
 		if (empty($fields) || ! is_array($fields) || ! count($fields))
 		{
@@ -390,7 +387,7 @@ 
 					break;
 			}
 
-			if (! empty($field->max_length))
+			if ( ! empty($field->max_length))
 			{
 				$rule[] = "max_length[{$field->max_length}]";
 			}