stakx-io / stakx

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

@@ -194,7 +194,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(
@@ -241,7 +241,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileStaticPageView(PageView &$pageView)
+    private function compileStaticPageView(PageView & $pageView)
     {
         $targetFile = $pageView->getTargetFile();
         $output = $this->renderStaticPageView($pageView);
@@ -257,7 +257,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileDynamicPageViews(DynamicPageView &$pageView)
+    private function compileDynamicPageViews(DynamicPageView & $pageView)
     {
         $contentItems = $pageView->getRepeatableItems();
         $template = $this->createTwigTemplate($pageView);
@@ -288,7 +288,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileRepeaterPageViews(RepeaterPageView &$pageView)
+    private function compileRepeaterPageViews(RepeaterPageView & $pageView)
     {
         $pageView->rewindPermalink();
 
@@ -313,7 +313,7 @@ 
      *
      * @param ContentItem $contentItem
      */
-    public function compileContentItem(ContentItem &$contentItem)
+    public function compileContentItem(ContentItem & $contentItem)
     {
         $pageView = &$contentItem->getPageView();
         $template = $this->createTwigTemplate($pageView);
@@ -339,7 +339,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileStandardRedirects(PageView &$pageView)
+    private function compileStandardRedirects(PageView & $pageView)
     {
         $redirects = $pageView->getRedirects();
 
@@ -362,7 +362,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileExpandedRedirects(RepeaterPageView &$pageView)
+    private function compileExpandedRedirects(RepeaterPageView & $pageView)
     {
         $permalinks = $pageView->getRepeaterPermalinks();
 
@@ -400,7 +400,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(),
@@ -423,7 +423,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(
@@ -444,7 +444,7 @@ 
      *
      * @return string
      */
-    private function renderStaticPageView(PageView &$pageView)
+    private function renderStaticPageView(PageView & $pageView)
     {
         return $this
             ->createTwigTemplate($pageView)
@@ -466,7 +466,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()
     {

src/allejo/stakx/Manager/TrackingManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -88,7 +88,7 @@ 
     }
 
     /**
-     * @param SplFileInfo|string $filePath
+     * @param string $filePath
      *
      * @return mixed|null
      */
@@ -135,7 +135,7 @@ 
     /**
      * Update the contents of a specified file.
      *
-     * @param SplFileInfo|string $filePath The relative path of the file
+     * @param string $filePath The relative path of the file
      *
      * @return PageView
      */
@@ -286,7 +286,7 @@ 
     /**
      * Return an array of JailedDocuments created from the tracked items
      *
-     * @param array $elements
+     * @param TrackableDocument[] $elements
      *
      * @return JailedDocument[]|JailedDocument[][]
      */

Spacing +4 added lines, -4 removed lines

@@ -148,12 +148,12 @@ 
     // Internal object handling
     ///
 
-    protected function addFileToTracker(SplFileInfo &$file)
+    protected function addFileToTracker(SplFileInfo & $file)
     {
         $this->trackedItemsFlattened[$file->getRelativePathname()] = &$file;
     }
 
-    protected function delFileFromTracker(SplFileInfo &$file)
+    protected function delFileFromTracker(SplFileInfo & $file)
     {
         unset($this->trackedItemsFlattened[$file->getRelativePathname()]);
     }
@@ -164,7 +164,7 @@ 
      * @param TrackableDocument $trackedItem
      * @param string|null       $namespace
      */
-    protected function addObjectToTracker(TrackableDocument &$trackedItem, $namespace = null)
+    protected function addObjectToTracker(TrackableDocument & $trackedItem, $namespace = null)
     {
         if ($namespace == null)
         {
@@ -184,7 +184,7 @@ 
      * @param TrackableDocument $trackedItem
      * @param string|null       $namespace
      */
-    protected function delObjectFromTracker(TrackableDocument &$trackedItem, $namespace = null)
+    protected function delObjectFromTracker(TrackableDocument & $trackedItem, $namespace = null)
     {
         if ($namespace == null)
         {

Braces +3 added lines, -1 removed lines

@@ -300,7 +300,9 @@
          */
         foreach ($elements as &$item)
         {
-            if (!Service::getParameter(BuildableCommand::USE_DRAFTS) && $item->isDraft()) { continue; }
+            if (!Service::getParameter(BuildableCommand::USE_DRAFTS) && $item->isDraft())
+            {
+continue; }
 
             if (empty($item->getNamespace()))
             {

src/allejo/stakx/Twig/BaseUrlFunction.php

Doc Comments +3 added lines

@@ -32,6 +32,9 @@
         ));
     }
 
+    /**
+     * @param boolean $absolute
+     */
     private function getUrl($absolute)
     {
         $url = '/';

Spacing +1 added lines, -1 removed lines

@@ -95,6 +95,6 @@
             }
         }
 
-        return preg_replace('#(?<!:)/+#','/', join('/', $paths));
+        return preg_replace('#(?<!:)/+#', '/', join('/', $paths));
     }
 }

src/allejo/stakx/Document/RepeatableItem.php

Spacing +1 added lines, -1 removed lines

@@ -46,5 +46,5 @@
      *
      * @return void
      */
-    public function setParentPageView(PageView &$pageView);
+    public function setParentPageView(PageView & $pageView);
 }

src/allejo/stakx/Document/DataItem.php

Spacing +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
     /**
      * {@inheritdoc}
      */
-    public function setParentPageView(PageView &$pageView)
+    public function setParentPageView(PageView & $pageView)
     {
         $this->pageView = &$pageView;
     }