stakx-io / stakx

src/allejo/stakx/FrontMatter/FrontMatterParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -194,7 +194,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
      *
      * @return array
      *

Braces +9 added lines, -3 removed lines

@@ -100,7 +100,9 @@ 
      */
     private function handleDateField ()
     {
-        if (!isset($this->frontMatter['date'])) { return; }
+        if (!isset($this->frontMatter['date']))
+        {
+return; }
 
         $date = &$this->frontMatter['date'];
         $itemDate = $this->guessDateTime($date);
@@ -258,7 +260,9 @@ 
 
             if (is_array($value) || is_bool($value))
             {
-                if ($ignoreArrays) { continue; }
+                if ($ignoreArrays)
+                {
+continue; }
 
                 throw new YamlUnsupportedVariableException("Yaml variable `$variable` for `$key` is not a supported data type.");
             }
@@ -348,6 +352,8 @@ 
         {
             return (new \DateTime($guess));
         }
-        catch (\Exception $e) { return false; }
+        catch (\Exception $e)
+        {
+return false; }
     }
 }
\ No newline at end of file

src/allejo/stakx/Manager/DataManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * Get all of the DataItems and DataSets in this manager
      *
-     * @return array
+     * @return string
      */
     public function getDataItems ()
     {

Braces +6 added lines, -2 removed lines

@@ -64,7 +64,9 @@ 
      */
     public function parseDataItems ($folders)
     {
-        if ($folders === null) { return; }
+        if ($folders === null)
+        {
+return; }
 
         foreach ($folders as $folder)
         {
@@ -84,7 +86,9 @@ 
      */
     public function parseDataSets ($dataSets)
     {
-        if ($dataSets === null) { return; }
+        if ($dataSets === null)
+        {
+return; }
 
         /**
          * The information which each DataSet has from the configuration file

src/allejo/stakx/Manager/PageManager.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
         $this->targetDir = &$folder;
     }
 
+    /**
+     * @param \allejo\stakx\Object\Configuration $configuration
+     */
     public function configureTwig ($configuration, $options)
     {
         $this->twigOpts['configuration'] = $configuration;

Braces +9 added lines, -3 removed lines

@@ -161,7 +161,9 @@ 
      */
     public function parsePageViews ($pageViewFolders)
     {
-        if (empty($pageViewFolders)) { return; }
+        if (empty($pageViewFolders))
+        {
+return; }
 
         /**
          * The name of the folder where PageViews are located
@@ -343,7 +345,9 @@ 
      */
     private function handleTrackableStaticPageView ($pageView)
     {
-        if (empty($pageView['title'])) { return; }
+        if (empty($pageView['title']))
+        {
+return; }
 
         $this->addToSiteMenu($pageView);
         $this->flatPages[$pageView['title']] = $pageView->createJail();
@@ -611,7 +615,9 @@ 
      */
     private function trackParentTwigTemplate ($template, &$pageView)
     {
-        if (!$this->tracking) { return; }
+        if (!$this->tracking)
+        {
+return; }
 
         /** @var Twig_Template $parent */
         $parent = $template->getParent(array());

src/allejo/stakx/Object/Configuration.php

Doc Comments +3 added lines

@@ -163,6 +163,9 @@
         return $this->configuration['twig']['autoescape'];
     }
 
+    /**
+     * @return false|string
+     */
     public function getRedirectTemplate ()
     {
         return $this->configuration['templates']['redirect'];

src/allejo/stakx/Object/FrontMatterObject.php

Doc Comments +1 added lines, -1 removed lines

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

Braces +3 added lines, -1 removed lines

@@ -392,7 +392,9 @@
      */
     final public function deleteFrontMatter ($key)
     {
-        if (!isset($this->writableFrontMatter[$key])) { return; }
+        if (!isset($this->writableFrontMatter[$key]))
+        {
+return; }
 
         unset($this->writableFrontMatter[$key]);
     }

src/allejo/stakx/Object/Website.php

Doc Comments +6 added lines

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

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 +13 added lines, -4 removed lines

@@ -143,11 +143,17 @@ 
      */
     public function matchesPattern ($filePath)
     {
-        if ($this->strpos_array($filePath, $this->includes)) { return true; }
-        if (($this->flags & self::INCLUDE_ONLY_FILES) && !$this->current()->isDir()) { return false; }
+        if ($this->strpos_array($filePath, $this->includes))
+        {
+return true; }
+        if (($this->flags & self::INCLUDE_ONLY_FILES) && !$this->current()->isDir())
+        {
+return false; }
 
         if (!($this->flags & self::ALLOW_DOT_FILES) &&
-            preg_match('#(^|\\\\|\/)\..+(\\\\|\/|$)#', $filePath) === 1) { return false; }
+            preg_match('#(^|\\\\|\/)\..+(\\\\|\/|$)#', $filePath) === 1)
+        {
+return false; }
 
         return ($this->strpos_array($filePath, $this->excludes) === false);
     }
@@ -192,10 +198,13 @@ 
                 return true;
             }
 
-            if (strpos($haystack, $query, $offset) !== false) // stop on first true result
+            if (strpos($haystack, $query, $offset) !== false)
+            {
+                // stop on first true result
             {
                 return true;
             }
+            }
         }
 
         return false;

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

src/allejo/stakx/Utilities/ArrayUtilities.php

Braces +3 added lines, -1 removed lines

@@ -9,7 +9,9 @@
         foreach ($array as $element)
         {
             if (is_array($element))
-                return true;
+            {
+                            return true;
+            }
         }
 
         return false;