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

@@ -61,7 +61,7 @@ 
         $this->handleDeprecations();
     }
 
-    public function isDebug ()
+    public function isDebug()
     {
         return $this->returnConfigOption('debug', false);
     }
@@ -71,7 +71,7 @@ 
      *
      * @return mixed|null
      */
-    public function getBaseUrl ()
+    public function getBaseUrl()
     {
         $base = $this->returnConfigOption('base');
 
@@ -83,62 +83,62 @@ 
         return $base;
     }
 
-    public function getDataFolders ()
+    public function getDataFolders()
     {
         return $this->returnConfigOption('data');
     }
 
-    public function getDataSets ()
+    public function getDataSets()
     {
         return $this->returnConfigOption('datasets');
     }
 
-    public function getIncludes ()
+    public function getIncludes()
     {
         return $this->returnConfigOption('include', array());
     }
 
-    public function getExcludes ()
+    public function getExcludes()
     {
         return $this->returnConfigOption('exclude', array());
     }
 
-    public function getTheme ()
+    public function getTheme()
     {
         return $this->returnConfigOption('theme');
     }
 
-    public function getConfiguration ()
+    public function getConfiguration()
     {
         return $this->configuration;
     }
 
-    public function getPageViewFolders ()
+    public function getPageViewFolders()
     {
         return $this->returnConfigOption('pageviews');
     }
 
-    public function getTargetFolder ()
+    public function getTargetFolder()
     {
         return $this->returnConfigOption('target');
     }
 
-    public function getCollectionsFolders ()
+    public function getCollectionsFolders()
     {
         return $this->returnConfigOption('collections');
     }
 
-    public function getTwigAutoescape ()
+    public function getTwigAutoescape()
     {
         return $this->configuration['twig']['autoescape'];
     }
 
-    private function returnConfigOption ($name, $default = null)
+    private function returnConfigOption($name, $default = null)
     {
         return (isset($this->configuration[$name]) ? $this->configuration[$name] : $default);
     }
 
-    private function defaultConfiguration ()
+    private function defaultConfiguration()
     {
         $defaultConfig = array(
             'baseurl' => '',
@@ -165,7 +165,7 @@ 
         }
     }
 
-    private function handleDeprecations ()
+    private function handleDeprecations()
     {
         // @TODO 1.0.0 handle 'base' deprecation in _config.yml
         $base = $this->returnConfigOption('base');

Braces +2 added lines, -4 removed lines

@@ -47,8 +47,7 @@ 
             try
             {
                 $this->configuration = Yaml::parse(file_get_contents($configFile));
-            }
-            catch (ParseException $e)
+            } catch (ParseException $e)
             {
                 $this->output->error("Parsing the configuration failed: {message}", array(
                     "message" => $e->getMessage()
@@ -158,8 +157,7 @@ 
         if (is_array($this->configuration))
         {
             $this->configuration = ArrayUtilities::array_merge_defaults($defaultConfig, $this->configuration, 'name');
-        }
-        else
+        } else
         {
             $this->configuration = $defaultConfig;
         }

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)
+                );
     }
 
     /**

Spacing +11 added lines, -11 removed lines

@@ -30,7 +30,7 @@ 
      *
      * @return string
      */
-    public function absolutePath ($pathFragments)
+    public function absolutePath($pathFragments)
     {
         $args = func_get_args();
         array_unshift($args, getcwd());
@@ -45,7 +45,7 @@ 
      *
      * @return string
      */
-    public function appendPath ($pathFragments)
+    public function appendPath($pathFragments)
     {
         return implode(DIRECTORY_SEPARATOR, func_get_args());
     }
@@ -57,12 +57,12 @@ 
      *
      * @return string
      */
-    public function getRelativePath ($path)
+    public function getRelativePath($path)
     {
         return str_replace(getcwd() . DIRECTORY_SEPARATOR, '', $path);
     }
 
-    public function getFinder ($explicitIncludes = array(), $explicitIgnores = array(), $searchIn = "")
+    public function getFinder($explicitIncludes = array(), $explicitIgnores = array(), $searchIn = "")
     {
         $finder = new Finder();
         $finder->files()
@@ -99,7 +99,7 @@ 
      *
      * @return string
      */
-    public function getBaseName ($filePath)
+    public function getBaseName($filePath)
     {
         return pathinfo($filePath, PATHINFO_FILENAME);
     }
@@ -111,7 +111,7 @@ 
      *
      * @return string
      */
-    public function getFileName ($filePath)
+    public function getFileName($filePath)
     {
         return pathinfo($filePath, PATHINFO_BASENAME);
     }
@@ -123,7 +123,7 @@ 
      *
      * @return string
      */
-    public function getFolderPath ($filePath)
+    public function getFolderPath($filePath)
     {
         return pathinfo($filePath, PATHINFO_DIRNAME);
     }
@@ -135,12 +135,12 @@ 
      *
      * @return string The extension of the file
      */
-    public function getExtension ($filename)
+    public function getExtension($filename)
     {
         return pathinfo($filename, PATHINFO_EXTENSION);
     }
 
-    public function isDir ($folderPath)
+    public function isDir($folderPath)
     {
         return is_dir($folderPath);
     }
@@ -152,7 +152,7 @@ 
      *
      * @return string
      */
-    public function removeExtension ($filename)
+    public function removeExtension($filename)
     {
         return $this->appendPath(
                    $this->getFolderPath($filename),
@@ -169,7 +169,7 @@ 
      *
      * @return SplFileInfo A reference to the newly created file
      */
-    public function writeFile ($targetDir, $fileName, $content)
+    public function writeFile($targetDir, $fileName, $content)
     {
         $outputFolder = $this->getFolderPath($this->absolutePath($targetDir, $fileName));
         $targetFile   = $this->getFileName($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();

Spacing +7 added lines, -7 removed lines

@@ -16,7 +16,7 @@ 
     protected $absolutePath;
     protected $targetDirectories;
 
-    public function __construct ($folderPath)
+    public function __construct($folderPath)
     {
         $this->fs = new Filesystem();
         $this->targetDirectories = array();
@@ -45,12 +45,12 @@ 
         }
     }
 
-    public function __toString ()
+    public function __toString()
     {
         return rtrim($this->absolutePath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
     }
 
-    public function setTargetDirectory ($folderName)
+    public function setTargetDirectory($folderName)
     {
         if (is_null($folderName) || empty($folderName))
         {
@@ -62,7 +62,7 @@ 
         }
     }
 
-    public function copyFile ($absolutePath, $targetPath)
+    public function copyFile($absolutePath, $targetPath)
     {
         $targetPath = ltrim($targetPath, DIRECTORY_SEPARATOR);
 
@@ -73,7 +73,7 @@ 
         );
     }
 
-    public function writeFile ($targetPath, $fileContent)
+    public function writeFile($targetPath, $fileContent)
     {
         $outputFolder   = $this->fs->getFolderPath($targetPath);
         $targetFileName = $this->fs->getFileName($outputFolder);
@@ -98,7 +98,7 @@ 
         ));
     }
 
-    private function buildPath ($pathFragments)
+    private function buildPath($pathFragments)
     {
         $paths = func_get_args();
 
@@ -110,7 +110,7 @@ 
      *
      * @return string
      */
-    private function getCwd ()
+    private function getCwd()
     {
         $location = array_merge(array($this->absolutePath), $this->targetDirectories);
 

Braces +2 added lines, -4 removed lines

@@ -25,8 +25,7 @@ 
         if (substr($folderPath, 0, 1) === DIRECTORY_SEPARATOR)
         {
             $this->absolutePath = $folderPath;
-        }
-        else
+        } else
         {
             $this->absolutePath = $this->fs->absolutePath($folderPath);
         }
@@ -55,8 +54,7 @@ 
         if (is_null($folderName) || empty($folderName))
         {
             $this->targetDirectories = array();
-        }
-        else
+        } else
         {
             $this->targetDirectories[] = trim($folderName, DIRECTORY_SEPARATOR);
         }

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

@@ -49,7 +49,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;
@@ -86,7 +86,7 @@ 
                 }
             }
 
-            return rtrim(substr($value, 0, $length)).$separator;
+            return rtrim(substr($value, 0, $length)) . $separator;
         }
 
         return $value;

src/Command/BuildCommand.php

Spacing +2 added lines, -2 removed lines

@@ -10,7 +10,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function configure ()
+    protected function configure()
     {
         parent::configure();
 
@@ -21,7 +21,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function execute (InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
         parent::execute($input, $output);
 

Braces +1 added lines, -2 removed lines

@@ -33,8 +33,7 @@
             $output->writeln(sprintf("Your site built successfully! It can be found at: %s",
                 $this->website->getConfiguration()->getTargetFolder() . DIRECTORY_SEPARATOR
             ));
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             $output->writeln(sprintf("Your website failed to build with the following error: %s",
                 $e->getMessage()

src/Command/WatchCommand.php

Spacing +2 added lines, -2 removed lines

@@ -7,7 +7,7 @@ 
 
 class WatchCommand extends BuildableCommand
 {
-    protected function configure ()
+    protected function configure()
     {
         parent::configure();
 
@@ -15,7 +15,7 @@ 
         $this->setDescription('Watch the source folder and rebuild the website as files change');
     }
 
-    protected function execute (InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
         parent::execute($input, $output);
 

Braces +1 added lines, -2 removed lines

@@ -28,8 +28,7 @@
             ));
 
             $this->website->watch();
-        }
-        catch (\Exception $e)
+        } catch (\Exception $e)
         {
             $output->writeln(sprintf("Your website failed to build with the following error: %s",
                 $e->getMessage()

src/Command/BuildableCommand.php

Spacing +3 added lines, -3 removed lines

@@ -37,7 +37,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function configure ()
+    protected function configure()
     {
         $this->fs = new Filesystem();
 
@@ -49,7 +49,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function execute (InputInterface $input, OutputInterface $output)
+    protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->website = new Website($output);
         $this->website->setConfLess($input->getOption('no-conf'));
@@ -62,7 +62,7 @@ 
      *
      * @return bool True if the website was configured properly
      */
-    protected function configureBuild (InputInterface $input)
+    protected function configureBuild(InputInterface $input)
     {
         $this->website->setConfiguration($input->getOption('conf'));
         $this->website->setSafeMode($input->getOption('safe'));

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

@@ -45,7 +45,7 @@ 
      *
      * @return array
      */
-    public function getSiteMenu ()
+    public function getSiteMenu()
     {
         return $this->siteMenu;
     }
@@ -56,7 +56,7 @@ 
      *
      * @param $pageViewFolders
      */
-    public function parsePageViews ($pageViewFolders)
+    public function parsePageViews($pageViewFolders)
     {
         if (empty($pageViewFolders)) { return; }
 
@@ -107,7 +107,7 @@ 
      *
      * @param ContentItem[] $collections
      */
-    public function prepareDynamicPageViews ($collections)
+    public function prepareDynamicPageViews($collections)
     {
         if (empty($collections)) { return; }
 
@@ -136,7 +136,7 @@ 
      * @param ContentItem[][]   $collections The collections that will be used to compile dynamic PageViews
      * @param Folder            $targetDir   The relative target directory as specified from the configuration file
      */
-    public function compile (&$twig, &$collections, &$targetDir)
+    public function compile(&$twig, &$collections, &$targetDir)
     {
         $this->compileDynamicPageViews($twig, $collections, $targetDir);
         $this->compileStaticPageViews($twig, $targetDir);
@@ -150,7 +150,7 @@ 
      * @param ContentItem[][]   $collections The collections that will be used to compile dynamic PageViews
      * @param Folder            $targetDir   The relative target directory as specified from the configuration file
      */
-    private function compileDynamicPageViews (&$twig, &$collections, &$targetDir)
+    private function compileDynamicPageViews(&$twig, &$collections, &$targetDir)
     {
         foreach ($this->dynamicPageViews as $pageView)
         {
@@ -180,7 +180,7 @@ 
      *
      * @throws \Exception
      */
-    private function compileStaticPageViews (&$twig, &$targetDir)
+    private function compileStaticPageViews(&$twig, &$targetDir)
     {
         foreach ($this->staticPageViews as $pageView)
         {
@@ -200,7 +200,7 @@ 
      *
      * @param array $frontMatter
      */
-    private function addToSiteMenu ($frontMatter)
+    private function addToSiteMenu($frontMatter)
     {
         if (!array_key_exists('permalink', $frontMatter) ||
             (array_key_exists('menu', $frontMatter) && !$frontMatter['menu']))

Braces +1 added lines, -2 removed lines

@@ -88,8 +88,7 @@
                 if ($newPageView->isDynamicPage())
                 {
                     $this->dynamicPageViews[] = $newPageView;
-                }
-                else
+                } else
                 {
                     $this->addToSiteMenu($newPageView->getFrontMatter());
                     $this->staticPageViews[] = $newPageView;

src/Manager/ItemManager.php

Spacing +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
      */
     protected $fs;
 
-    public function __construct ()
+    public function __construct()
     {
         $this->fs = new Filesystem();
     }
@@ -26,7 +26,7 @@ 
     /**
      * @param ConsoleInterface|OutputInterface|null $output
      */
-    public function setConsoleOutput ($output)
+    public function setConsoleOutput($output)
     {
         $this->output = new ConsoleInterface($output);
     }