stakx-io / stakx

src/allejo/stakx/Configuration.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,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()
     {

src/allejo/stakx/Command/BuildableCommand.php

Spacing +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      * @param InputInterface $input
      * @param string         $param
      */
-    private function setServiceParameter(InputInterface &$input, $param)
+    private function setServiceParameter(InputInterface & $input, $param)
     {
         Service::setParameter($param, $input->getOption($param));
     }

src/allejo/stakx/Twig/SelectFilter.php

Spacing +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
     private static function flatten(array $array)
     {
         $return = array();
-        array_walk_recursive($array, function($a) use (&$return) { $return[] = $a; });
+        array_walk_recursive($array, function ($a) use (&$return) { $return[] = $a; });
         return $return;
     }
 }
\ No newline at end of file

src/allejo/stakx/Website.php

Spacing +1 added lines, -1 removed lines

@@ -239,7 +239,7 @@
             ->setIterator($fileExplorer->getExplorer())
             ->addListener(Create::NAME, function ($e) { $this->watchListenerFunction($e); })
             ->addListener(Modify::NAME, function ($e) { $this->watchListenerFunction($e); })
-            ->addListener(Move::NAME,   function ($e) { $this->watchListenerFunction($e); })
+            ->addListener(Move::NAME, function ($e) { $this->watchListenerFunction($e); })
         ;
 
         $this->output->writeln('Watch started successfully');

src/allejo/stakx/Compiler.php

Doc Comments +7 added lines, -1 removed lines

@@ -88,7 +88,7 @@ 
     }
 
     /**
-     * @param PageView[][] $pageViews
+     * @param Document\TrackableDocument[] $pageViews
      * @param PageView[]   $pageViewsFlattened
      */
     public function setPageViews(array &$pageViews, array &$pageViewsFlattened)
@@ -109,6 +109,9 @@ 
     // Twig parent templates
     ///
 
+    /**
+     * @param string $filePath
+     */
     public function isImportDependency($filePath)
     {
         return isset($this->importDependencies[$filePath]);
@@ -161,6 +164,9 @@ 
         }
     }
 
+    /**
+     * @param string $filePath
+     */
     public function compileImportDependencies($filePath)
     {
         foreach ($this->importDependencies[$filePath] as &$dependent)

Spacing +11 added lines, -11 removed lines

@@ -195,7 +195,7 @@ 
      *
      * @since 0.1.1
      */
-    public function compilePageView(PageView &$pageView)
+    public function compilePageView(PageView & $pageView)
     {
         $this->twig->addGlobal('__currentTemplate', $pageView->getFilePath());
         $this->output->debug('Compiling {type} PageView: {pageview}', array(
@@ -242,7 +242,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileStaticPageView(PageView &$pageView)
+    private function compileStaticPageView(PageView & $pageView)
     {
         $targetFile = $pageView->getTargetFile();
         $output = $this->renderStaticPageView($pageView);
@@ -258,7 +258,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileDynamicPageViews(DynamicPageView &$pageView)
+    private function compileDynamicPageViews(DynamicPageView & $pageView)
     {
         $contentItems = $pageView->getRepeatableItems();
         $template = $this->createTwigTemplate($pageView);
@@ -291,7 +291,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileRepeaterPageViews(RepeaterPageView &$pageView)
+    private function compileRepeaterPageViews(RepeaterPageView & $pageView)
     {
         $pageView->rewindPermalink();
 
@@ -316,7 +316,7 @@ 
      *
      * @param ContentItem $contentItem
      */
-    public function compileContentItem(ContentItem &$contentItem)
+    public function compileContentItem(ContentItem & $contentItem)
     {
         $pageView = &$contentItem->getPageView();
         $template = $this->createTwigTemplate($pageView);
@@ -342,7 +342,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileStandardRedirects(PermalinkDocument &$pageView)
+    private function compileStandardRedirects(PermalinkDocument & $pageView)
     {
         $redirects = $pageView->getRedirects();
 
@@ -365,7 +365,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileExpandedRedirects(RepeaterPageView &$pageView)
+    private function compileExpandedRedirects(RepeaterPageView & $pageView)
     {
         $permalinks = $pageView->getRepeaterPermalinks();
 
@@ -403,7 +403,7 @@ 
      *
      * @return string
      */
-    private function renderRepeaterPageView(Twig_Template &$template, RepeaterPageView &$pageView, ExpandedValue &$expandedValue)
+    private function renderRepeaterPageView(Twig_Template & $template, RepeaterPageView & $pageView, ExpandedValue & $expandedValue)
     {
         $pageView->setFrontMatter(array(
             'permalink' => $expandedValue->getEvaluated(),
@@ -426,7 +426,7 @@ 
      * @since  0.1.1
      *
      */
-    private function renderDynamicPageView(Twig_Template &$template, TwigDocument &$twigItem)
+    private function renderDynamicPageView(Twig_Template & $template, TwigDocument & $twigItem)
     {
         return $template
             ->render(array(
@@ -447,7 +447,7 @@ 
      *
      * @return string
      */
-    private function renderStaticPageView(PageView &$pageView)
+    private function renderStaticPageView(PageView & $pageView)
     {
         return $this
             ->createTwigTemplate($pageView)
@@ -469,7 +469,7 @@ 
      *
      * @return Twig_Template
      */
-    private function createTwigTemplate(PageView &$pageView)
+    private function createTwigTemplate(PageView & $pageView)
     {
         try
         {

src/allejo/stakx/Document/TwigDocument.php

Doc Comments +1 added lines

@@ -11,6 +11,7 @@
 {
     /**
      * @param string $filePath
+     * @return void
      */
     public function __construct($filePath);
 

src/allejo/stakx/Manager/AssetManager.php

Doc Comments +2 added lines

@@ -68,6 +68,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function refreshItem($filePath)
     {
@@ -86,6 +87,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function createNewItem($filePath)
     {

src/allejo/stakx/Manager/CollectionManager.php

Doc Comments +2 added lines, -1 removed lines

@@ -28,7 +28,7 @@ 
     /**
      * Get all of the ContentItems grouped by Collection name.
      *
-     * @return ContentItem[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function &getCollections()
     {
@@ -109,6 +109,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $filePath
      */
     public function createNewItem($filePath)
     {

src/allejo/stakx/Manager/PageManager.php

Doc Comments +6 added lines, -3 removed lines

@@ -64,7 +64,7 @@ 
     /**
      * Give this manager the collections we'll be using for dynamic PageViews.
      *
-     * @param ContentItem[][] $collections
+     * @param \allejo\stakx\Document\TrackableDocument[] $collections
      *
      * @since 0.1.0
      */
@@ -73,6 +73,9 @@ 
         $this->collections = &$collections;
     }
 
+    /**
+     * @param \allejo\stakx\Document\TrackableDocument[] $datasets
+     */
     public function setDatasets($datasets)
     {
         $this->datasets = $datasets;
@@ -86,7 +89,7 @@ 
      * @deprecated Been replaced by getPageViewsFlattened()
      * @since      0.1.0
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function getAllPageViews()
     {
@@ -98,7 +101,7 @@ 
      *
      * @since  0.1.1
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function &getPageViews()
     {