stakx-io / stakx

src/Object/Configuration.php

Doc Comments +10 added lines, -1 removed lines

@@ -34,7 +34,7 @@ 
      * Configuration constructor.
      *
      * @param string                                $configFile
-     * @param ConsoleInterface|OutputInterface|null $output
+     * @param ConsoleInterface $output
      */
     public function __construct($configFile, $output = null)
     {
@@ -83,11 +83,17 @@ 
         return $base;
     }
 
+    /**
+     * @return string[]
+     */
     public function getDataFolders ()
     {
         return $this->returnConfigOption('data');
     }
 
+    /**
+     * @return string[]
+     */
     public function getDataSets ()
     {
         return $this->returnConfigOption('datasets');
@@ -133,6 +139,9 @@ 
         return $this->configuration['twig']['autoescape'];
     }
 
+    /**
+     * @param string $name
+     */
     private function returnConfigOption ($name, $default = null)
     {
         return (isset($this->configuration[$name]) ? $this->configuration[$name] : $default);

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      * @param string                                $configFile
      * @param ConsoleInterface|OutputInterface|null $output
      */
-    public function __construct($configFile, $output = null)
+    public function __construct ($configFile, $output = null)
     {
         $this->configuration = array();
         $this->output        = new ConsoleInterface($output);

src/System/FileSystem.php

Doc Comments +3 added lines

@@ -140,6 +140,9 @@
         return pathinfo($filename, PATHINFO_EXTENSION);
     }
 
+    /**
+     * @param string $folderPath
+     */
     public function isDir ($folderPath)
     {
         return is_dir($folderPath);

Indentation +6 added lines, -6 removed lines

@@ -66,9 +66,9 @@ 
     {
         $finder = new Finder();
         $finder->files()
-               ->ignoreVCS(true)
-               ->ignoreDotFiles(true)
-               ->ignoreUnreadableDirs();
+                ->ignoreVCS(true)
+                ->ignoreDotFiles(true)
+                ->ignoreUnreadableDirs();
 
         $finder->in(
             empty(trim($searchIn)) ? getcwd() : $searchIn
@@ -155,9 +155,9 @@ 
     public function removeExtension ($filename)
     {
         return $this->appendPath(
-                   $this->getFolderPath($filename),
-                   $this->getBaseName($filename)
-               );
+                    $this->getFolderPath($filename),
+                    $this->getBaseName($filename)
+                );
     }
 
     /**

src/System/Folder.php

Doc Comments +11 added lines

@@ -62,6 +62,10 @@ 
         }
     }
 
+    /**
+     * @param string $absolutePath
+     * @param string $targetPath
+     */
     public function copyFile ($absolutePath, $targetPath)
     {
         $targetPath = ltrim($targetPath, DIRECTORY_SEPARATOR);
@@ -73,6 +77,10 @@ 
         );
     }
 
+    /**
+     * @param string $targetPath
+     * @param string $fileContent
+     */
     public function writeFile ($targetPath, $fileContent)
     {
         $outputFolder   = $this->fs->getFolderPath($targetPath);
@@ -98,6 +106,9 @@ 
         ));
     }
 
+    /**
+     * @param string $pathFragments
+     */
     private function buildPath ($pathFragments)
     {
         $paths = func_get_args();

src/Twig/TextFilter.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 +8 added lines, -8 removed lines

@@ -17,7 +17,7 @@ 
      *
      * @return array
      */
-    public function getFilters()
+    public function getFilters ()
     {
         return array(
             new Twig_SimpleFilter('truncate', 'twig_truncate_filter', array('needs_environment' => true)),
@@ -30,14 +30,14 @@ 
      *
      * @return string
      */
-    public function getName()
+    public function getName ()
     {
         return 'Text';
     }
 }
 
 if (function_exists('mb_get_info')) {
-    function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
+    function twig_truncate_filter (Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
     {
         if (mb_strlen($value, $env->getCharset()) > $length) {
             if ($preserve) {
@@ -49,13 +49,13 @@ 
                 $length = $breakpoint;
             }
 
-            return rtrim(mb_substr($value, 0, $length, $env->getCharset())).$separator;
+            return rtrim(mb_substr($value, 0, $length, $env->getCharset())) . $separator;
         }
 
         return $value;
     }
 
-    function twig_wordwrap_filter(Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)
+    function twig_wordwrap_filter (Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)
     {
         $sentences = array();
 
@@ -77,7 +77,7 @@ 
         return implode($separator, $sentences);
     }
 } else {
-    function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
+    function twig_truncate_filter (Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
     {
         if (strlen($value) > $length) {
             if ($preserve) {
@@ -86,13 +86,13 @@ 
                 }
             }
 
-            return rtrim(substr($value, 0, $length)).$separator;
+            return rtrim(substr($value, 0, $length)) . $separator;
         }
 
         return $value;
     }
 
-    function twig_wordwrap_filter(Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)
+    function twig_wordwrap_filter (Twig_Environment $env, $value, $length = 80, $separator = "\n", $preserve = false)
     {
         return wordwrap($value, $length, $separator, !$preserve);
     }

Braces +21 added lines, -10 removed lines

@@ -36,13 +36,17 @@ 
     }
 }
 
-if (function_exists('mb_get_info')) {
+if (function_exists('mb_get_info'))
+{
     function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
     {
-        if (mb_strlen($value, $env->getCharset()) > $length) {
-            if ($preserve) {
+        if (mb_strlen($value, $env->getCharset()) > $length)
+        {
+            if ($preserve)
+            {
                 // If breakpoint is on the last word, return the value without separator.
-                if (false === ($breakpoint = mb_strpos($value, ' ', $length, $env->getCharset()))) {
+                if (false === ($breakpoint = mb_strpos($value, ' ', $length, $env->getCharset())))
+                {
                     return $value;
                 }
 
@@ -65,8 +69,10 @@ 
         $pieces = mb_split($separator, $value);
         mb_regex_encoding($previous);
 
-        foreach ($pieces as $piece) {
-            while (!$preserve && mb_strlen($piece, $env->getCharset()) > $length) {
+        foreach ($pieces as $piece)
+        {
+            while (!$preserve && mb_strlen($piece, $env->getCharset()) > $length)
+            {
                 $sentences[] = mb_substr($piece, 0, $length, $env->getCharset());
                 $piece = mb_substr($piece, $length, 2048, $env->getCharset());
             }
@@ -76,12 +82,17 @@ 
 
         return implode($separator, $sentences);
     }
-} else {
+}
+else
+{
     function twig_truncate_filter(Twig_Environment $env, $value, $length = 30, $preserve = false, $separator = '...')
     {
-        if (strlen($value) > $length) {
-            if ($preserve) {
-                if (false !== ($breakpoint = strpos($value, ' ', $length))) {
+        if (strlen($value) > $length)
+        {
+            if ($preserve)
+            {
+                if (false !== ($breakpoint = strpos($value, ' ', $length)))
+                {
                     $length = $breakpoint;
                 }
             }

src/Manager/PageManager.php

Indentation +4 added lines, -4 removed lines

@@ -76,10 +76,10 @@
 
             $finder = new Finder();
             $finder->files()
-                   ->name('/\.(html|twig)/')
-                   ->ignoreDotFiles(true)
-                   ->ignoreUnreadableDirs()
-                   ->in($pageViewFolder);
+                    ->name('/\.(html|twig)/')
+                    ->ignoreDotFiles(true)
+                    ->ignoreUnreadableDirs()
+                    ->in($pageViewFolder);
 
             foreach ($finder as $viewFile)
             {

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
     /**
      * PageManager constructor
      */
-    public function __construct()
+    public function __construct ()
     {
         parent::__construct();
 

Braces +6 added lines, -2 removed lines

@@ -58,7 +58,9 @@ 
      */
     public function parsePageViews ($pageViewFolders)
     {
-        if (empty($pageViewFolders)) { return; }
+        if (empty($pageViewFolders))
+        {
+return; }
 
         /**
          * The name of the folder where PageViews are located
@@ -109,7 +111,9 @@ 
      */
     public function prepareDynamicPageViews ($collections)
     {
-        if (empty($collections)) { return; }
+        if (empty($collections))
+        {
+return; }
 
         foreach ($this->dynamicPageViews as $pageView)
         {

src/Manager/DataManager.php

Indentation +3 added lines, -3 removed lines

@@ -112,9 +112,9 @@
         $dataItems = array();
         $finder    = new Finder();
         $finder->files()
-               ->ignoreDotFiles(true)
-               ->ignoreUnreadableDirs()
-               ->in($this->fs->absolutePath($folder));
+                ->ignoreDotFiles(true)
+                ->ignoreUnreadableDirs()
+                ->in($this->fs->absolutePath($folder));
 
         foreach ($finder as $dataItem)
         {

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/Command/BuildableCommand.php

Doc Comments +1 added lines, -1 removed lines

@@ -60,7 +60,7 @@
      *
      * @param  InputInterface  $input
      *
-     * @return bool True if the website was configured properly
+     * @return boolean|null True if the website was configured properly
      */
     protected function configureBuild (InputInterface $input)
     {

src/Manager/CollectionManager.php

Spacing +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      */
     private $collections;
 
-    public function __construct()
+    public function __construct ()
     {
         parent::__construct();
 

src/Engines/Markdown/TwigMarkdownEngine.php

Spacing +3 added lines, -3 removed lines

@@ -8,7 +8,7 @@ 
 {
     protected $engine;
 
-    public function __construct($instanceName = null)
+    public function __construct ($instanceName = null)
     {
         $this->engine = MarkdownEngine::instance($instanceName);
     }
@@ -16,7 +16,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function transform($content)
+    public function transform ($content)
     {
         return $this->engine->parse($content);
     }
@@ -24,7 +24,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function getName()
+    public function getName ()
     {
         return 'stakx/parsedown';
     }