stakx-io / stakx

src/allejo/stakx/System/FileExplorer.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,8 +63,8 @@
      * FileExplorer constructor.
      *
      * @param \RecursiveIterator $iterator
-     * @param array              $excludes
-     * @param array              $includes
+     * @param string[]              $excludes
+     * @param string[]              $includes
      * @param int|null           $flags
      */
     public function __construct(\RecursiveIterator $iterator, array $excludes = array(), array $includes = array(), $flags = null)

Braces +2 added lines, -1 removed lines

@@ -203,7 +203,8 @@
             }
 
             if (strpos($haystack, $query, $offset) !== false)
-            { // stop on first true result
+            {
+// stop on first true result
                 return true;
             }
         }

src/allejo/stakx/Twig/TextExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     /**
      * Returns a list of filters.
      *
-     * @return array
+     * @return Twig_SimpleFilter[]
      */
     public function getFilters()
     {

tests/allejo/stakx/Test/StreamInterceptor.php

Braces +2 added lines, -1 removed lines

@@ -18,7 +18,8 @@
 
     public function filter($in, $out, &$consumed, $closing)
     {
-        while ($bucket = stream_bucket_make_writeable($in)) {
+        while ($bucket = stream_bucket_make_writeable($in))
+        {
             self::$output .= $bucket->data;
             $consumed += $bucket->datalen;
         }

tests/allejo/stakx/Test/PHPUnit_Stakx_TestCase.php

Braces +2 added lines, -1 removed lines

@@ -84,7 +84,8 @@
     {
         $results = array();
 
-        foreach ($elements as $element) {
+        foreach ($elements as $element)
+        {
             $filename = (isset($element['filename'])) ? $element['filename'] : hash('sha256', uniqid(mt_rand(), true), false);
             $frontMatter = (empty($element['frontmatter'])) ? '' : Yaml::dump($element['frontmatter'], 2);
             $body = (isset($element['body'])) ? $element['body'] : 'Body Text';

Doc Comments +3 added lines

@@ -50,6 +50,9 @@
     // Assertion functions
     ///
 
+    /**
+     * @param string $haystack
+     */
     protected function assertStringContains($needle, $haystack, $message = '')
     {
         $this->assertNotFalse(strpos($haystack, $needle), $message);

src/allejo/stakx/Engines/PlainTextEngine.php

Doc Comments +3 added lines

@@ -9,6 +9,9 @@
 
 class PlainTextEngine implements ParsingEngine
 {
+    /**
+     * @param string $context
+     */
     public function parse($context)
     {
         return $context;

src/allejo/stakx/System/StakxResource.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
      */
     private static $fs;
 
+    /**
+     * @param string $fileName
+     */
     public static function getResource($fileName)
     {
         self::initFileSystem();

src/allejo/stakx/Twig/WhereFilter.php

Doc Comments +4 added lines, -1 removed lines

@@ -89,7 +89,7 @@ 
      * @param array|\ArrayAccess[] $array      The elements to filter through
      * @param string               $key        The key value in an associative array or FrontMatter
      * @param string               $comparison The actual comparison symbols being used
-     * @param mixed                $value      The value we're searching for
+     * @param string                $value      The value we're searching for
      *
      * @throws Twig_Error_Syntax
      *
@@ -147,6 +147,9 @@ 
         return false;
     }
 
+    /**
+     * @param string $comparison
+     */
     private function comparisonSymbol($lhs, $comparison, $rhs)
     {
         switch ($comparison)

src/allejo/stakx/Utilities/ArrayUtilities.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
         return false;
     }
 
+    /**
+     * @param string $keyField
+     */
     public static function array_merge_defaults(array &$array1, array &$array2, $keyField)
     {
         $merged = $array1;

src/allejo/stakx/FrontMatter/Document.php

Doc Comments +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
     /**
      * Get the original file path.
      *
-     * @return string
+     * @return SplFileInfo
      */
     final public function getFilePath()
     {