stakx-io / stakx

src/allejo/stakx/DataTransformer/DataTransformerManager.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
         }
     }
 
+    /**
+     * @param string $extension
+     */
     public function getTransformer($extension)
     {
         if (isset($this->transformers[$extension]))

src/allejo/stakx/Document/CollectableItem.php

Doc Comments +4 added lines

@@ -12,6 +12,9 @@ 
  */
 interface CollectableItem
 {
+    /**
+     * @return string
+     */
     public function getRelativeFilePath();
 
     /**
@@ -58,6 +61,7 @@ 
      * Evaluate the FrontMatter in this object by merging a custom array of data.
      *
      * @param array|null $variables An array of YAML variables to use in evaluating the `$permalink` value
+     * @return void
      */
     public function evaluateFrontMatter(array $variables = null);
 }

Spacing +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
      *
      * @return void
      */
-    public function setParentPageView(DynamicPageView &$pageView);
+    public function setParentPageView(DynamicPageView & $pageView);
 
     /**
      * Evaluate the FrontMatter in this object by merging a custom array of data.

src/allejo/stakx/Manager/CollectionManager.php

Doc Comments +2 added lines, -1 removed lines

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

src/allejo/stakx/Manager/PageManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
      *
      * @since  0.1.1
      *
-     * @return BasePageView[][]
+     * @return \allejo\stakx\Document\ReadableDocument[]
      */
     public function &getPageViews()
     {

src/allejo/stakx/Manager/TrackingManager.php

Doc Comments +5 added lines, -5 removed lines

@@ -88,9 +88,9 @@ 
     }
 
     /**
-     * @param File|string $filePath
+     * @param string $filePath
      *
-     * @return mixed|null
+     * @return \allejo\stakx\Document\BasePageView
      */
     public function createNewItem($filePath)
     {
@@ -135,9 +135,9 @@ 
     /**
      * Update the contents of a specified file.
      *
-     * @param File|string $filePath The relative path of the file
+     * @param string $filePath The relative path of the file
      *
-     * @return mixed|null
+     * @return \allejo\stakx\Document\BasePageView
      */
     public function refreshItem($filePath)
     {
@@ -286,7 +286,7 @@ 
     /**
      * Return an array of JailedDocuments created from the tracked items
      *
-     * @param array    $elements
+     * @param ReadableDocument[]    $elements
      * @param \Closure $name
      *
      * @return JailedDocument[]|JailedDocument[][]

Spacing +4 added lines, -4 removed lines

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

src/allejo/stakx/EventSubscriber/PageViewsCompletedSubscriber.php

Braces +4 added lines, -2 removed lines

@@ -41,13 +41,15 @@
         $twig->setGlobalVariable('site', $this->container->get(Configuration::class)->getconfiguration());
 
         $dataItems = [];
-        if ($this->container->has(DataManager::class)) {
+        if ($this->container->has(DataManager::class))
+        {
             $dataItems = $this->container->get(DataManager::class)->getJailedDataItems();
         }
         $twig->setGlobalVariable('data', $dataItems);
 
         $collectionItems = [];
-        if ($this->container->has(CollectionManager::class)) {
+        if ($this->container->has(CollectionManager::class))
+        {
             $collectionItems = $this->container->get(CollectionManager::class)->getJailedCollections();
         }
         $twig->setGlobalVariable('collections', $collectionItems);

src/allejo/stakx/Compiler.php

Indentation -1 removed lines

@@ -333,7 +333,6 @@
      * Write the compiled output for a repeater PageView.
      *
      * @param RepeaterPageView $pageView
-
      * @since 0.1.1
      *
      * @throws TemplateErrorInterface

Spacing +11 added lines, -11 removed lines

@@ -238,7 +238,7 @@ 
      *
      * @since 0.1.1
      */
-    public function compilePageView(BasePageView &$pageView)
+    public function compilePageView(BasePageView & $pageView)
     {
         $this->templateBridge->setGlobalVariable('__currentTemplate', $pageView->getAbsoluteFilePath());
         $this->output->debug('Compiling {type} PageView: {pageview}', array(
@@ -285,7 +285,7 @@ 
      *
      * @throws TemplateErrorInterface
      */
-    private function compileStaticPageView(StaticPageView &$pageView)
+    private function compileStaticPageView(StaticPageView & $pageView)
     {
         $targetFile = $pageView->getTargetFile();
         $output = $this->renderStaticPageView($pageView);
@@ -303,7 +303,7 @@ 
      *
      * @throws TemplateErrorInterface
      */
-    private function compileDynamicPageViews(DynamicPageView &$pageView)
+    private function compileDynamicPageViews(DynamicPageView & $pageView)
     {
         $contentItems = $pageView->getCollectableItems();
         $template = $this->createTwigTemplate($pageView);
@@ -338,7 +338,7 @@ 
      *
      * @throws TemplateErrorInterface
      */
-    private function compileRepeaterPageViews(RepeaterPageView &$pageView)
+    private function compileRepeaterPageViews(RepeaterPageView & $pageView)
     {
         $pageView->rewindPermalink();
 
@@ -363,7 +363,7 @@ 
      *
      * @param ContentItem $contentItem
      */
-    public function compileContentItem(ContentItem &$contentItem)
+    public function compileContentItem(ContentItem & $contentItem)
     {
         $pageView = &$contentItem->getPageView();
         $template = $this->createTwigTemplate($pageView);
@@ -389,7 +389,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileStandardRedirects(PermalinkDocument &$pageView)
+    private function compileStandardRedirects(PermalinkDocument & $pageView)
     {
         $redirects = $pageView->getRedirects();
 
@@ -412,7 +412,7 @@ 
      *
      * @since 0.1.1
      */
-    private function compileExpandedRedirects(RepeaterPageView &$pageView)
+    private function compileExpandedRedirects(RepeaterPageView & $pageView)
     {
         $permalinks = $pageView->getRepeaterPermalinks();
 
@@ -450,7 +450,7 @@ 
      *
      * @return string
      */
-    private function renderRepeaterPageView(TemplateInterface &$template, RepeaterPageView &$pageView, ExpandedValue &$expandedValue)
+    private function renderRepeaterPageView(TemplateInterface & $template, RepeaterPageView & $pageView, ExpandedValue & $expandedValue)
     {
         $pageView->evaluateFrontMatter([
             'permalink' => $expandedValue->getEvaluated(),
@@ -470,7 +470,7 @@ 
      *
      * @return string
      */
-    private function renderDynamicPageView(TemplateInterface &$template, TemplateReadyDocument &$twigItem)
+    private function renderDynamicPageView(TemplateInterface & $template, TemplateReadyDocument & $twigItem)
     {
         return $template
             ->render(array(
@@ -487,7 +487,7 @@ 
      *
      * @return string
      */
-    private function renderStaticPageView(StaticPageView &$pageView)
+    private function renderStaticPageView(StaticPageView & $pageView)
     {
         return $this
             ->createTwigTemplate($pageView)
@@ -505,7 +505,7 @@ 
      *
      * @return TemplateInterface
      */
-    private function createTwigTemplate(BasePageView &$pageView)
+    private function createTwigTemplate(BasePageView & $pageView)
     {
         try
         {

src/allejo/stakx/DataTransformer/JsonTransformer.php

Braces +2 added lines, -1 removed lines

@@ -16,7 +16,8 @@
     {
         $data = json_decode($content, true);
 
-        if ($data === null) {
+        if ($data === null)
+        {
             return [];
         }
 

src/allejo/stakx/Templating/TwigTemplate.php

Braces +2 added lines, -1 removed lines

@@ -31,7 +31,8 @@
     {
         $parent = $this->template->getParent([]);
 
-        if ($parent === false) {
+        if ($parent === false)
+        {
             return false;
         }