stakx-io / stakx

src/allejo/stakx/Command/ContainerAwareCommand.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 {
     private $container;
 
+    /**
+     * @return \Symfony\Component\DependencyInjection\ContainerInterface
+     */
     public function getContainer()
     {
         if ($this->container === null)

src/allejo/stakx/Compiler.php

Doc Comments +6 added lines

@@ -110,6 +110,9 @@ 
     // Twig parent templates
     ///
 
+    /**
+     * @param string $filePath
+     */
     public function isImportDependency($filePath)
     {
         return isset($this->importDependencies[$filePath]);
@@ -162,6 +165,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->getAbsoluteFilePath());
         $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/ReadableDocument.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     protected $fs;
 
     /**
-     * @param string $filePath
+     * @param File $filePath
      */
     public function __construct(File $filePath)
     {

src/allejo/stakx/Manager/PageManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -86,7 +86,7 @@ 
      * @deprecated Been replaced by getPageViewsFlattened()
      * @since      0.1.0
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function getAllPageViews()
     {
@@ -98,7 +98,7 @@ 
      *
      * @since  0.1.1
      *
-     * @return PageView[][]
+     * @return \allejo\stakx\Document\TrackableDocument[]
      */
     public function &getPageViews()
     {

src/allejo/stakx/Manager/TrackingManager.php

Doc Comments +4 added lines, -4 removed lines

@@ -88,9 +88,9 @@ 
     }
 
     /**
-     * @param File|string $filePath
+     * @param string $filePath
      *
-     * @return mixed|null
+     * @return PageView
      */
     public function createNewItem($filePath)
     {
@@ -135,7 +135,7 @@ 
     /**
      * 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 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(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 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)
         {

src/allejo/stakx/Utilities/ArrayUtilities.php

Braces +2 added lines, -1 removed lines

@@ -20,7 +20,8 @@
      */
     public static function array_safe_get(array $array, $key, $default = null)
     {
-        if (isset($array[$key])) {
+        if (isset($array[$key]))
+        {
             return $array[$key];
         }