stakx-io / stakx

src/allejo/stakx/Website.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
     /**
      * Compile the website.
      *
-     * @return true if the website built successfully
+     * @return false|null if the website built successfully
      */
     public function build()
     {

src/allejo/stakx/Manager/CollectionManager.php

Braces +2 added lines, -1 removed lines

@@ -105,7 +105,8 @@
      */
     public function getJailedCollections()
     {
-        return self::getJailedTrackedItems($this->trackedItemsFlattened, function ($contentItem) {
+        return self::getJailedTrackedItems($this->trackedItemsFlattened, function ($contentItem)
+        {
             return $contentItem['basename'];
         });
     }

src/allejo/stakx/Document/BasePageView.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
     /**
      * Create the appropriate object type when parsing a PageView.
      *
-     * @return DynamicPageView|StaticPageView|RepeaterPageView
+     * @return BasePageView
      */
     public static function create(File $filePath, array $complexVariables = [])
     {

tests/allejo/stakx/Test/PHPUnit_Stakx_TestCase.php

Doc Comments +3 added lines, -3 removed lines

@@ -259,7 +259,7 @@ 
     }
 
     /**
-     * @return Configuration|\PHPUnit_Framework_MockObject_MockObject
+     * @return Configuration
      */
     protected function getMockConfiguration()
     {
@@ -377,7 +377,7 @@ 
     /**
      * Get a mock EventDispatcher.
      *
-     * @return EventDispatcherInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @return EventDispatcherInterface
      */
     protected function getMockEventDistpatcher()
     {
@@ -387,7 +387,7 @@ 
     /**
      * Get a mock logger.
      *
-     * @return LoggerInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @return LoggerInterface
      */
     protected function getMockLogger()
     {

src/allejo/stakx/AssetEngine/Sass/SourceMapGenerator.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
         $this->generatorOptions = $options;
     }
 
+    /**
+     * @return string
+     */
     public function getSourceMapContents()
     {
         return $this->sourceMapContent;

src/allejo/stakx/Service.php

Doc Comments +10 added lines

@@ -13,11 +13,18 @@ 
     protected static $runTimeStatus;
     protected static $options;
 
+    /**
+     * @param string $key
+     * @param string $value
+     */
     public static function setOption($key, $value)
     {
         self::$options[$key] = $value;
     }
 
+    /**
+     * @param string $key
+     */
     public static function getOption($key)
     {
         return isset(self::$options[$key]) ? self::$options[$key] : null;
@@ -48,6 +55,9 @@ 
         return self::$workingDirectory;
     }
 
+    /**
+     * @param \string|null $directory
+     */
     public static function setWorkingDirectory($directory)
     {
         self::$workingDirectory = $directory;

src/allejo/stakx/MarkupEngine/MarkdownEngine.php

Upper-Lower-Casing +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
             try
             {
                 $highlighted = $this->highlighter->highlight($language, $block['element']['text']['text']);
-                $block['markup'] = "<pre><code class=\"hljs ${cssClass}\">" . $highlighted->value . '</code></pre>';
+                $block['markup'] = "<pre><code class=\"hljs ${cssclass}\">" . $highlighted->value . '</code></pre>';
 
                 // Only return the block if Highlighter knew the language and how to handle it.
                 return $block;

src/allejo/stakx/AssetEngine/Sass/SassEngine.php

Doc Comments +6 added lines

@@ -163,6 +163,9 @@ 
         );
     }
 
+    /**
+     * @param string $content
+     */
     private function handleThemeImports(&$content)
     {
         if (($themeName = $this->configuration->getTheme()))
@@ -172,6 +175,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     public static function stringToFormatter($format)
     {
         if ($format == 'nested')

Upper-Lower-Casing +2 added lines, -2 removed lines

@@ -167,8 +167,8 @@
     {
         if (($themeName = $this->configuration->getTheme()))
         {
-            $themePath = "../_themes/${themeName}/_sass";
-            $content = preg_replace("/(@import ['\"])(@theme)(.+)/", "$1${themePath}$3", $content);
+            $themePath = "../_themes/${themename}/_sass";
+            $content = preg_replace("/(@import ['\"])(@theme)(.+)/", "$1${themepath}$3", $content);
         }
     }
 

src/allejo/stakx/Server/Controller.php

Doc Comments +4 added lines, -4 removed lines

@@ -206,7 +206,7 @@ 
      *
      * @param string $url
      *
-     * @return mixed
+     * @return string
      */
     public static function normalizeUrl($url)
     {
@@ -217,9 +217,9 @@ 
      * Find a ContentItem from a Dynamic PageView or null if it doesn't exist.
      *
      * @param DynamicPageView $pageView
-     * @param                 $permalink
+     * @param                 string $permalink
      *
-     * @return CollectableItem|ReadableDocument|TemplateReadyDocument|null
+     * @return CollectableItem|null
      */
     private static function getContentItem(DynamicPageView $pageView, $permalink)
     {
@@ -240,7 +240,7 @@ 
      * Find the ExpandedValue from a Repeater PageView or null if it doesn't exist.
      *
      * @param RepeaterPageView $pageView
-     * @param                  $permalink
+     * @param                  string $permalink
      *
      * @return ExpandedValue|null
      */

Braces +10 added lines, -5 removed lines

@@ -45,7 +45,8 @@ 
      */
     private function staticPageViewAction(StaticPageView $pageView, Compiler $compiler)
     {
-        return function () use ($pageView, $compiler) {
+        return function () use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             $compiler->getTemplateBridge()->clearTemplateCache();
@@ -75,7 +76,8 @@ 
      */
     private function dynamicPageViewAction(DynamicPageView $pageView, Compiler $compiler)
     {
-        return function (ServerRequestInterface $request) use ($pageView, $compiler) {
+        return function (ServerRequestInterface $request) use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             $compiler->getTemplateBridge()->clearTemplateCache();
@@ -111,7 +113,8 @@ 
      */
     private function repeaterPageViewAction(RepeaterPageView $pageView, Compiler $compiler)
     {
-        return function (ServerRequestInterface $request) use ($pageView, $compiler) {
+        return function (ServerRequestInterface $request) use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             $compiler->getTemplateBridge()->clearTemplateCache();
@@ -154,7 +157,8 @@ 
                 return $this->repeaterPageViewAction($pageView, $compiler);
 
             default:
-                return function () {
+                return function ()
+                {
                     $errMsg = 'This URL type has not yet been implemented.';
 
                     return new Response(501, ['Content-Type' => 'text/plain'], $errMsg);
@@ -171,7 +175,8 @@ 
      */
     private function createRedirectAction($to)
     {
-        return function () use ($to) {
+        return function () use ($to)
+        {
             return new Response(302, [
                 'Location' => $to,
             ]);