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/Object/FrontMatterObject.php

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
         if (!$this->fs->exists($filePath))
         {
-            throw new FileNotFoundException("The following file could not be found: ${filePath}");
+            throw new FileNotFoundException("The following file could not be found: ${filepath}");
         }
 
         $this->extension = strtolower($this->fs->getExtension($filePath));

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

src/allejo/stakx/Manager/ThemeManager.php

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
 
         if (!$this->fs->exists($this->themeFolder))
         {
-            throw new FileNotFoundException("The '${themeName}' theme folder could not be found.'");
+            throw new FileNotFoundException("The '${themename}' theme folder could not be found.'");
         }
 
         if ($this->fs->exists($this->themeFile))

src/allejo/stakx/FrontMatter/FrontMatterParser.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/Object/Configuration.php

Doc Comments +4 added lines, -1 removed lines

@@ -97,7 +97,7 @@ 
     /**
      * @TODO 1.0.0 Remove support for 'base' in next major release; it has been replaced by 'baseurl'
      *
-     * @return mixed|null
+     * @return string
      */
     public function getBaseUrl()
     {
@@ -168,6 +168,9 @@ 
         return $this->configuration['twig']['autoescape'];
     }
 
+    /**
+     * @return string|false
+     */
     public function getRedirectTemplate()
     {
         return $this->configuration['templates']['redirect'];

src/allejo/stakx/Object/Website.php

Doc Comments +6 added lines

@@ -349,6 +349,9 @@ 
         $this->noClean = $noClean;
     }
 
+    /**
+     * @param string $filePath
+     */
     private function creationWatcher($filePath)
     {
         $this->output->writeln(sprintf('File creation detected: %s', $filePath));
@@ -390,6 +393,9 @@ 
         }
     }
 
+    /**
+     * @param string $filePath
+     */
     private function modificationWatcher($filePath)
     {
         $this->output->writeln(sprintf('File change detected: %s', $filePath));

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