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
      *

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      *
      * @param array $rawFrontMatter
      */
-    public function __construct(&$rawFrontMatter)
+    public function __construct (&$rawFrontMatter)
     {
         $this->expansionUsed = false;
         $this->nestingLevel = 0;

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;

Spacing +5 added lines, -5 removed lines

@@ -58,7 +58,7 @@ 
     /**
      * PageManager constructor
      */
-    public function __construct()
+    public function __construct ()
     {
         parent::__construct();
 
@@ -228,7 +228,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function isTracked($filePath)
+    public function isTracked ($filePath)
     {
         return (parent::isTracked($filePath) || isset($this->twigExtendsDeps[$filePath]));
     }
@@ -236,7 +236,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function refreshItem($filePath)
+    public function refreshItem ($filePath)
     {
         if (parent::isTracked($filePath))
         {
@@ -256,7 +256,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function handleTrackableItem($filePath, $options = array())
+    protected function handleTrackableItem ($filePath, $options = array())
     {
         $pageView  = PageView::create($filePath);
         $namespace = $pageView->getType();
@@ -534,7 +534,7 @@ 
         {
             $filePath = $this->fs->getRelativePath($parent->getSourceContext()->getPath());
 
-            $this->twigExtendsDeps[$filePath][(string)$pageView->getFilePath()] = &$pageView;
+            $this->twigExtendsDeps[$filePath][(string) $pageView->getFilePath()] = &$pageView;
             $parent = $parent->getParent(array());
         }
     }

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

Spacing +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
     /**
      * Configuration constructor.
      */
-    public function __construct()
+    public function __construct ()
     {
         $this->configuration = array();
         $this->fs            = new Filesystem();
@@ -64,7 +64,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function setLogger(LoggerInterface $logger)
+    public function setLogger (LoggerInterface $logger)
     {
         $this->output = $logger;
     }

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

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

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

Spacing +6 added lines, -6 removed lines

@@ -139,11 +139,11 @@ 
         $this->pm->configureTwig($this->getConfiguration(), array(
             'safe'    => $this->safeMode,
             'globals' => array(
-                array('name' => 'site',        'value' => $this->getConfiguration()->getConfiguration()),
+                array('name' => 'site', 'value' => $this->getConfiguration()->getConfiguration()),
                 array('name' => 'collections', 'value' => $this->cm->getJailedCollections()),
-                array('name' => 'menu',        'value' => $this->pm->getSiteMenu()),
-                array('name' => 'pages',       'value' => $this->pm->getFlatPages()),
-                array('name' => 'data',        'value' => $this->dm->getDataItems())
+                array('name' => 'menu', 'value' => $this->pm->getSiteMenu()),
+                array('name' => 'pages', 'value' => $this->pm->getFlatPages()),
+                array('name' => 'data', 'value' => $this->dm->getDataItems())
             )
         ));
         $this->pm->compileAll();
@@ -309,7 +309,7 @@ 
     /**
      * @return boolean
      */
-    public function isNoClean()
+    public function isNoClean ()
     {
         return $this->noClean;
     }
@@ -317,7 +317,7 @@ 
     /**
      * @param boolean $noClean
      */
-    public function setNoClean($noClean)
+    public function setNoClean ($noClean)
     {
         $this->noClean = $noClean;
     }

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)

Spacing +6 added lines, -6 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * A bitwise flag to have FileExplorer search files starting with a period as well
      */
-    const ALLOW_DOT_FILES    = 0x2;
+    const ALLOW_DOT_FILES = 0x2;
 
     /**
      * A list of common version control folders to ignore.
@@ -36,7 +36,7 @@ 
      *
      * @var string[]
      */
-    public static $vcsPatterns =  array('.git', '.hg', '.svn', '_svn');
+    public static $vcsPatterns = array('.git', '.hg', '.svn', '_svn');
 
     /**
      * A list of phrases to exclude from the search
@@ -67,7 +67,7 @@ 
      * @param array              $includes
      * @param int|null           $flags
      */
-    public function __construct(\RecursiveIterator $iterator, array $excludes = array(), array $includes = array(), $flags = null)
+    public function __construct (\RecursiveIterator $iterator, array $excludes = array(), array $includes = array(), $flags = null)
     {
         parent::__construct($iterator);
 
@@ -79,7 +79,7 @@ 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString ()
     {
         return $this->current()->getFilename();
     }
@@ -105,7 +105,7 @@ 
      *
      * @return SplFileInfo
      */
-    public function current()
+    public function current ()
     {
         /** @var \SplFileInfo $current */
         $current = parent::current();
@@ -120,7 +120,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function getChildren()
+    public function getChildren ()
     {
         return (new self(
             $this->getInnerIterator()->getChildren(),

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

Spacing +2 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
     public function getFilters ()
     {
         return array(
-            new Twig_SimpleFilter('summary',  'twig_summary_filter'),
+            new Twig_SimpleFilter('summary', 'twig_summary_filter'),
             new Twig_SimpleFilter('truncate', 'twig_truncate_filter', array('needs_environment' => true)),
             new Twig_SimpleFilter('wordwrap', 'twig_wordwrap_filter', array('needs_environment' => true)),
         );
@@ -73,7 +73,7 @@ 
             $length = $breakpoint;
         }
 
-        return rtrim(mb_substr($value, 0, $length, $env->getCharset())).$separator;
+        return rtrim(mb_substr($value, 0, $length, $env->getCharset())) . $separator;
     }
 
     return $value;

src/allejo/stakx/Object/JailObject.php

Spacing +4 added lines, -4 removed lines

@@ -103,7 +103,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetExists($offset)
+    public function offsetExists ($offset)
     {
         return $this->object->offsetExists($offset);
     }
@@ -111,7 +111,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetGet($offset)
+    public function offsetGet ($offset)
     {
         return $this->object->offsetGet($offset);
     }
@@ -119,7 +119,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetSet($offset, $value)
+    public function offsetSet ($offset, $value)
     {
         return $this->object->offsetSet($offset, $value);
     }
@@ -127,7 +127,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetUnset($offset)
+    public function offsetUnset ($offset)
     {
         return $this->object->offsetUnset($offset);
     }