stakx-io / stakx

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
      *

Spacing +12 added lines, -12 removed lines

@@ -61,7 +61,7 @@ 
      *
      * @param array $rawFrontMatter
      */
-    public function __construct(&$rawFrontMatter)
+    public function __construct (&$rawFrontMatter)
     {
         $this->expansionUsed = false;
         $this->nestingLevel = 0;
@@ -78,7 +78,7 @@ 
      *
      * @return bool
      */
-    public function hasExpansion()
+    public function hasExpansion ()
     {
         return $this->expansionUsed;
     }
@@ -90,7 +90,7 @@ 
     /**
      * Special treatment for some FrontMatter variables.
      */
-    private function handleSpecialFrontMatter()
+    private function handleSpecialFrontMatter ()
     {
         $this->handleDateField();
     }
@@ -98,7 +98,7 @@ 
     /**
      * Special treatment for the `date` field in FrontMatter that creates three new variables: year, month, day.
      */
-    private function handleDateField()
+    private function handleDateField ()
     {
         if (!isset($this->frontMatter['date']))
         {
@@ -126,7 +126,7 @@ 
      *
      * @param array $yaml
      */
-    private function evaluateBlock(&$yaml)
+    private function evaluateBlock (&$yaml)
     {
         ++$this->nestingLevel;
 
@@ -165,7 +165,7 @@ 
      *
      * @return array
      */
-    private function evaluateExpandableField($key, $fmStatement)
+    private function evaluateExpandableField ($key, $fmStatement)
     {
         if (!is_array($fmStatement))
         {
@@ -203,7 +203,7 @@ 
      *
      * @return array
      */
-    private function evaluateArrayType($frontMatterKey, $expandableValue, $arrayVariableNames)
+    private function evaluateArrayType ($frontMatterKey, $expandableValue, $arrayVariableNames)
     {
         if (!is_array($expandableValue))
         {
@@ -251,7 +251,7 @@ 
      *
      * @return string The final string with variables evaluated
      */
-    private function evaluateBasicType($key, $string, $ignoreArrays = false)
+    private function evaluateBasicType ($key, $string, $ignoreArrays = false)
     {
         $variables = $this->getFrontMatterVariables($string);
 
@@ -286,7 +286,7 @@ 
      *
      * @return string[]
      */
-    private function getFrontMatterVariables($string)
+    private function getFrontMatterVariables ($string)
     {
         $variables = array();
 
@@ -307,7 +307,7 @@ 
      *
      * @return mixed
      */
-    private function getVariableValue($key, $varName)
+    private function getVariableValue ($key, $varName)
     {
         if (!isset($this->frontMatter[$varName]))
         {
@@ -326,7 +326,7 @@ 
      *
      * @return bool|\DateTime
      */
-    private function castDateTimeTimezone($epochTime)
+    private function castDateTimeTimezone ($epochTime)
     {
         $timezone = new \DateTimeZone(date_default_timezone_get());
         $value = \DateTime::createFromFormat('U', $epochTime);
@@ -340,7 +340,7 @@ 
      *
      * @return bool|\DateTime
      */
-    private function guessDateTime($guess)
+    private function guessDateTime ($guess)
     {
         if ($guess instanceof \DateTime)
         {

src/allejo/stakx/Manager/PageManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
      *
      * @since 0.1.0
      *
-     * @return PageView[][]
+     * @return PageView[]
      */
     public function getAllPageViews()
     {

Spacing +10 added lines, -10 removed lines

@@ -41,7 +41,7 @@ 
     /**
      * PageManager constructor.
      */
-    public function __construct()
+    public function __construct ()
     {
         parent::__construct();
 
@@ -56,7 +56,7 @@ 
      *
      * @since 0.1.0
      */
-    public function setCollections(&$collections)
+    public function setCollections (&$collections)
     {
         $this->collections = &$collections;
     }
@@ -68,7 +68,7 @@ 
      *
      * @return PageView[][]
      */
-    public function getAllPageViews()
+    public function getAllPageViews ()
     {
         return $this->trackedItemsFlattened;
     }
@@ -80,7 +80,7 @@ 
      *
      * @return PageView[]
      */
-    public function getStaticPageViews()
+    public function getStaticPageViews ()
     {
         return $this->staticPages;
     }
@@ -92,7 +92,7 @@ 
      *
      * @return JailObject[]
      */
-    public function getJailedStaticPageViews()
+    public function getJailedStaticPageViews ()
     {
         $jailedObjects = array();
 
@@ -112,7 +112,7 @@ 
      *
      * @since 0.1.0
      */
-    public function parsePageViews($pageViewFolders)
+    public function parsePageViews ($pageViewFolders)
     {
         if (empty($pageViewFolders))
         {
@@ -143,7 +143,7 @@ 
      *
      * @since 0.1.0
      */
-    public function trackNewContentItem(&$contentItem)
+    public function trackNewContentItem (&$contentItem)
     {
         $collection = $contentItem->getCollection();
         $this->trackedItems[PageView::DYNAMIC_TYPE][$collection]->addContentItem($contentItem);
@@ -152,7 +152,7 @@ 
     /**
      * {@inheritdoc}
      */
-    protected function handleTrackableItem($filePath, $options = array())
+    protected function handleTrackableItem ($filePath, $options = array())
     {
         $pageView = PageView::create($filePath);
         $namespace = $pageView->getType();
@@ -183,7 +183,7 @@ 
      *
      * @since 0.1.0
      */
-    private function handleTrackableStaticPageView(&$pageView)
+    private function handleTrackableStaticPageView (&$pageView)
     {
         if (empty($pageView['title']))
         {
@@ -200,7 +200,7 @@ 
      *
      * @since 0.1.0
      */
-    private function handleTrackableDynamicPageView(&$pageView)
+    private function handleTrackableDynamicPageView (&$pageView)
     {
         $frontMatter = $pageView->getFrontMatter(false);
         $collection = $frontMatter['collection'];

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

Spacing +19 added lines, -19 removed lines

@@ -46,7 +46,7 @@ 
     /**
      * Configuration constructor.
      */
-    public function __construct()
+    public function __construct ()
     {
         $this->configuration = array();
         $this->fs = new Filesystem();
@@ -60,7 +60,7 @@ 
      * @param string|null $configFile The path to the configuration file. If null, the default configuration will be
      *                                used
      */
-    public function parseConfiguration($configFile = null)
+    public function parseConfiguration ($configFile = null)
     {
         if ($this->fs->exists($configFile))
         {
@@ -84,12 +84,12 @@ 
     /**
      * {@inheritdoc}
      */
-    public function setLogger(LoggerInterface $logger)
+    public function setLogger (LoggerInterface $logger)
     {
         $this->output = $logger;
     }
 
-    public function isDebug()
+    public function isDebug ()
     {
         return $this->returnConfigOption('debug', false);
     }
@@ -99,7 +99,7 @@ 
      *
      * @return mixed|null
      */
-    public function getBaseUrl()
+    public function getBaseUrl ()
     {
         $base = $this->returnConfigOption('base');
         $baseUrl = $this->returnConfigOption('baseurl');
@@ -115,7 +115,7 @@ 
     /**
      * @return string[]
      */
-    public function getDataFolders()
+    public function getDataFolders ()
     {
         return $this->returnConfigOption('data');
     }
@@ -123,52 +123,52 @@ 
     /**
      * @return string[]
      */
-    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'];
     }
 
-    public function getRedirectTemplate()
+    public function getRedirectTemplate ()
     {
         return $this->configuration['templates']['redirect'];
     }
@@ -181,12 +181,12 @@ 
      *
      * @return mixed|null
      */
-    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'   => '',
@@ -210,7 +210,7 @@ 
         $this->configuration = ArrayUtilities::array_merge_defaults($defaultConfig, $this->configuration, 'name');
     }
 
-    private function handleDeprecations()
+    private function handleDeprecations ()
     {
         // @TODO 1.0.0 handle 'base' deprecation in _config.yml
         $base = $this->returnConfigOption('base');

src/allejo/stakx/Object/FrontMatterObject.php

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

Spacing +26 added lines, -26 removed lines

@@ -136,7 +136,7 @@ 
      * @throws IOException           The file was not a valid ContentItem. This would meam there was no front matter or
      *                               no body
      */
-    public function __construct($filePath)
+    public function __construct ($filePath)
     {
         $this->frontMatterBlacklist = array('permalink', 'redirects');
         $this->writableFrontMatter = array();
@@ -159,14 +159,14 @@ 
      *
      * @return string
      */
-    abstract public function getContent();
+    abstract public function getContent ();
 
     /**
      * Get the extension of the current file.
      *
      * @return string
      */
-    final public function getExtension()
+    final public function getExtension ()
     {
         return $this->extension;
     }
@@ -176,7 +176,7 @@ 
      *
      * @return string
      */
-    final public function getFilePath()
+    final public function getFilePath ()
     {
         return $this->filePath;
     }
@@ -186,7 +186,7 @@ 
      *
      * @return int
      */
-    final public function getLineOffset()
+    final public function getLineOffset ()
     {
         return $this->lineOffset;
     }
@@ -196,7 +196,7 @@ 
      *
      * @return string
      */
-    final public function getName()
+    final public function getName ()
     {
         return $this->fs->getBaseName($this->filePath);
     }
@@ -206,7 +206,7 @@ 
      *
      * @return string
      */
-    final public function getRelativeFilePath()
+    final public function getRelativeFilePath ()
     {
         if ($this->filePath instanceof SplFileInfo)
         {
@@ -222,7 +222,7 @@ 
      *
      * @return string
      */
-    final public function getTargetFile()
+    final public function getTargetFile ()
     {
         $permalink = $this->getPermalink();
         $missingFile = (substr($permalink, -1) == '/');
@@ -244,7 +244,7 @@ 
      *
      * @return bool
      */
-    final public function hasTwigDependency($namespace, $needle)
+    final public function hasTwigDependency ($namespace, $needle)
     {
         return in_array($needle, $this->dataDependencies[$namespace]);
     }
@@ -252,7 +252,7 @@ 
     /**
      * Read the file, and parse its contents.
      */
-    final public function refreshFileContent()
+    final public function refreshFileContent ()
     {
         // This function can be called after the initial object was created and the file may have been deleted since the
         // creation of the object.
@@ -305,7 +305,7 @@ 
      *
      * @param string $filter 'collections' or 'data'
      */
-    private function findTwigDataDependencies($filter)
+    private function findTwigDataDependencies ($filter)
     {
         $regex = '/{[{%](?:.+)?(?:' . $filter . ')(?:\.|\[\')(\w+)(?:\'\])?.+[%}]}/';
         $results = array();
@@ -326,7 +326,7 @@ 
      *
      * @return string
      */
-    final public function getPermalink()
+    final public function getPermalink ()
     {
         if (!is_null($this->permalink))
         {
@@ -365,7 +365,7 @@ 
      *
      * @return string[]
      */
-    final public function getRedirects()
+    final public function getRedirects ()
     {
         if (is_null($this->redirects))
         {
@@ -381,7 +381,7 @@ 
      *
      * @return string
      */
-    private function getPathPermalink()
+    private function getPathPermalink ()
     {
         // Remove the protocol of the path, if there is one and prepend a '/' to the beginning
         $cleanPath = preg_replace('/[\w|\d]+:\/\//', '', $this->getRelativeFilePath());
@@ -413,7 +413,7 @@ 
      *
      * @return string $permalink The sanitized permalink
      */
-    private function sanitizePermalink($permalink)
+    private function sanitizePermalink ($permalink)
     {
         // Remove multiple '/' together
         $permalink = preg_replace('/\/+/', '/', $permalink);
@@ -448,7 +448,7 @@ 
     /**
      * {@inheritdoc}
      */
-    final public function evaluateFrontMatter($variables = null)
+    final public function evaluateFrontMatter ($variables = null)
     {
         if (!is_null($variables))
         {
@@ -460,7 +460,7 @@ 
     /**
      * {@inheritdoc}
      */
-    final public function getFrontMatter($evaluateYaml = true)
+    final public function getFrontMatter ($evaluateYaml = true)
     {
         if (is_null($this->frontMatter))
         {
@@ -477,7 +477,7 @@ 
     /**
      * {@inheritdoc}
      */
-    final public function hasExpandedFrontMatter()
+    final public function hasExpandedFrontMatter ()
     {
         return !is_null($this->frontMatterParser) && $this->frontMatterParser->hasExpansion();
     }
@@ -485,7 +485,7 @@ 
     /**
      * {@inheritdoc.
      */
-    final public function appendFrontMatter(array $frontMatter)
+    final public function appendFrontMatter (array $frontMatter)
     {
         foreach ($frontMatter as $key => $value)
         {
@@ -496,7 +496,7 @@ 
     /**
      * {@inheritdoc.
      */
-    final public function deleteFrontMatter($key)
+    final public function deleteFrontMatter ($key)
     {
         if (!isset($this->writableFrontMatter[$key]))
         {
@@ -509,7 +509,7 @@ 
     /**
      * {@inheritdoc.
      */
-    final public function setFrontMatter(array $frontMatter)
+    final public function setFrontMatter (array $frontMatter)
     {
         if (!is_array($frontMatter))
         {
@@ -526,7 +526,7 @@ 
      *
      * @throws YamlVariableUndefinedException A FrontMatter variable used does not exist
      */
-    private function evaluateYaml(&$yaml)
+    private function evaluateYaml (&$yaml)
     {
         try
         {
@@ -546,7 +546,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetSet($offset, $value)
+    public function offsetSet ($offset, $value)
     {
         if (is_null($offset))
         {
@@ -559,7 +559,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetExists($offset)
+    public function offsetExists ($offset)
     {
         if (isset($this->writableFrontMatter[$offset]) || isset($this->frontMatter[$offset]))
         {
@@ -574,7 +574,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetUnset($offset)
+    public function offsetUnset ($offset)
     {
         unset($this->writableFrontMatter[$offset]);
     }
@@ -582,7 +582,7 @@ 
     /**
      * {@inheritdoc}
      */
-    public function offsetGet($offset)
+    public function offsetGet ($offset)
     {
         $fxnCall = 'get' . ucfirst($offset);
 

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

Spacing +14 added lines, -14 removed lines

@@ -109,7 +109,7 @@ 
      *
      * @param OutputInterface $output
      */
-    public function __construct(OutputInterface $output)
+    public function __construct (OutputInterface $output)
     {
         $this->output = new StakxLogger($output);
         $this->cm = new CollectionManager();
@@ -124,7 +124,7 @@ 
      *
      * @param bool $tracking Whether or not to keep track of files as they're compiled to save time in 'watch'
      */
-    public function build($tracking = false)
+    public function build ($tracking = false)
     {
         // Configure the environment
         $this->createFolderStructure(!$this->noClean);
@@ -210,7 +210,7 @@ 
         $this->am->copyFiles();
     }
 
-    public function watch()
+    public function watch ()
     {
         $this->output->writeln('Building website...');
         $this->build(true);
@@ -261,7 +261,7 @@ 
     /**
      * @return Configuration
      */
-    public function getConfiguration()
+    public function getConfiguration ()
     {
         return $this->configuration;
     }
@@ -271,7 +271,7 @@ 
      *
      * @throws \LogicException
      */
-    public function setConfiguration($configFile)
+    public function setConfiguration ($configFile)
     {
         if (!$this->fs->exists($configFile) && !$this->isConfLess())
         {
@@ -296,7 +296,7 @@ 
      *
      * @return bool True when being built with no configuration file
      */
-    public function isConfLess()
+    public function isConfLess ()
     {
         return $this->confLess;
     }
@@ -306,7 +306,7 @@ 
      *
      * @param bool $status True when a website should be built without a configuration
      */
-    public function setConfLess($status)
+    public function setConfLess ($status)
     {
         $this->confLess = $status;
     }
@@ -318,7 +318,7 @@ 
      *
      * @return bool True when the website is being built in safe mode
      */
-    public function isSafeMode()
+    public function isSafeMode ()
     {
         return $this->safeMode;
     }
@@ -328,7 +328,7 @@ 
      *
      * @param bool $bool True if a website should be built in safe mode
      */
-    public function setSafeMode($bool)
+    public function setSafeMode ($bool)
     {
         $this->safeMode = $bool;
     }
@@ -336,7 +336,7 @@ 
     /**
      * @return bool
      */
-    public function isNoClean()
+    public function isNoClean ()
     {
         return $this->noClean;
     }
@@ -344,12 +344,12 @@ 
     /**
      * @param bool $noClean
      */
-    public function setNoClean($noClean)
+    public function setNoClean ($noClean)
     {
         $this->noClean = $noClean;
     }
 
-    private function creationWatcher($filePath)
+    private function creationWatcher ($filePath)
     {
         $this->output->writeln(sprintf('File creation detected: %s', $filePath));
 
@@ -390,7 +390,7 @@ 
         }
     }
 
-    private function modificationWatcher($filePath)
+    private function modificationWatcher ($filePath)
     {
         $this->output->writeln(sprintf('File change detected: %s', $filePath));
 
@@ -434,7 +434,7 @@ 
      *
      * @param bool $cleanDirectory Clean the target directory
      */
-    private function createFolderStructure($cleanDirectory)
+    private function createFolderStructure ($cleanDirectory)
     {
         $tarDir = $this->fs->absolutePath($this->configuration->getTargetFolder());
 

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

@@ -23,7 +23,7 @@ 
      *
      * @return array
      */
-    public function getFilters()
+    public function getFilters ()
     {
         return array(
             new Twig_SimpleFilter('summary', 'twig_summary_filter'),
@@ -37,13 +37,13 @@ 
      *
      * @return string
      */
-    public function getName()
+    public function getName ()
     {
         return 'Text';
     }
 }
 
-function twig_summary_filter($value, $paragraphCount = 1)
+function twig_summary_filter ($value, $paragraphCount = 1)
 {
     if (function_exists('simplexml_load_string'))
     {
@@ -64,7 +64,7 @@ 
     return $value;
 }
 
-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)
     {
@@ -85,7 +85,7 @@ 
     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();
 

src/Gregwar/RST/HTML/Nodes/CodeNode.php

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
 
 class CodeNode extends Base
 {
-    public function render()
+    public function render ()
     {
         return '<pre><code class="hljs language-' . $this->language . '">' . $this->value . '</code></pre>';
     }

src/allejo/stakx/Command/WatchCommand.php

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
 
 class WatchCommand extends BuildableCommand
 {
-    protected function configure()
+    protected function configure ()
     {
         parent::configure();
 
@@ -20,7 +20,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);
 

src/allejo/stakx/Command/BuildCommand.php

Spacing +2 added lines, -2 removed lines

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