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)

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/PHPUnit_Stakx_TestCase.php

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;

Spacing +2 added lines, -2 removed lines

@@ -78,10 +78,10 @@
      */
     public static function associative_array_split($key, array &$array, $considerOffset = true)
     {
-        $offset = array_search($key, array_keys($array)) + (int)$considerOffset;
+        $offset = array_search($key, array_keys($array)) + (int) $considerOffset;
         $result = array();
 
-        $result[0] = array_slice($array, 0 , $offset, true);
+        $result[0] = array_slice($array, 0, $offset, true);
         $result[1] = array_slice($array, $offset, null, true);
 
         return $result;

src/allejo/stakx/FrontMatter/Parser.php

Doc Comments +1 added lines, -1 removed lines

@@ -197,7 +197,7 @@
      *
      * @param string $frontMatterKey     The current hierarchy of the Front Matter keys being used
      * @param string $expandableValue    The Front Matter value that will be expanded
-     * @param array  $arrayVariableNames The Front Matter variable names that reference arrays
+     * @param string[]  $arrayVariableNames The Front Matter variable names that reference arrays
      *
      * @throws YamlUnsupportedVariableException If a multidimensional array is given for value expansion
      *

src/allejo/stakx/FrontMatter/WritableDocumentInterface.php

Doc Comments +4 added lines

@@ -13,6 +13,7 @@ 
      * Evaluate the FrontMatter in this object by merging a custom array of data.
      *
      * @param array|null $variables An array of YAML variables to use in evaluating the `$permalink` value
+     * @return void
      */
     public function evaluateFrontMatter($variables = null);
 
@@ -36,6 +37,7 @@ 
      * Append a custom FrontMatter value.
      *
      * @param array $frontMatter
+     * @return void
      */
     public function appendFrontMatter(array $frontMatter);
 
@@ -45,6 +47,7 @@ 
      * This will not delete a FrontMatter value parsed from the file
      *
      * @param string $key
+     * @return void
      */
     public function deleteFrontMatter($key);
 
@@ -55,6 +58,7 @@ 
      * available to Twig templates
      *
      * @param array $frontMatter
+     * @return void
      */
     public function setFrontMatter(array $frontMatter);
 }