stakx-io / stakx

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/Server/DevServer.php

Braces +2 added lines, -1 removed lines

@@ -43,7 +43,8 @@
     {
         $dispatcher = RouteDispatcher::create($router, $compiler);
 
-        return new Server(function (ServerRequestInterface $request) use ($router, $dispatcher) {
+        return new Server(function (ServerRequestInterface $request) use ($router, $dispatcher)
+        {
             $httpMethod = $request->getMethod();
             $urlPath = RouteDispatcher::normalizeUrl($request->getUri()->getPath());
 

src/allejo/stakx/Server/RouteDispatcher.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

@@ -44,7 +44,8 @@ 
      */
     private function staticPageViewController(StaticPageView $pageView, Compiler $compiler)
     {
-        return function () use ($pageView, $compiler) {
+        return function () use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             if ($this->hasBeenTouched($pageView))
@@ -72,7 +73,8 @@ 
      */
     private function dynamicPageViewController(DynamicPageView $pageView, Compiler $compiler)
     {
-        return function (ServerRequestInterface $request) use ($pageView, $compiler) {
+        return function (ServerRequestInterface $request) use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             $contentItem = self::getContentItem($pageView, $request->getUri()->getPath());
@@ -106,7 +108,8 @@ 
      */
     private function repeaterPageViewController(RepeaterPageView $pageView, Compiler $compiler)
     {
-        return function (ServerRequestInterface $request) use ($pageView, $compiler) {
+        return function (ServerRequestInterface $request) use ($pageView, $compiler)
+        {
             Service::setOption('currentTemplate', $pageView->getAbsoluteFilePath());
 
             $expandedValue = self::getExpandedValue($pageView, $request->getUri()->getPath());
@@ -147,7 +150,8 @@ 
                 return $this->repeaterPageViewController($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);
@@ -188,7 +192,8 @@ 
     {
         self::$baseUrl = $router->getBaseUrl();
 
-        return \FastRoute\simpleDispatcher(function (RouteCollector $r) use ($router, $compiler) {
+        return \FastRoute\simpleDispatcher(function (RouteCollector $r) use ($router, $compiler)
+        {
             $dispatcher = new RouteDispatcher();
 
             foreach ($router->getRouteMapping() as $route => $pageView)

src/allejo/stakx/Server/MimeDetector.php

Doc Comments +3 added lines

@@ -104,6 +104,9 @@
         'svg' => 'image/svg+xml',
     ];
 
+    /**
+     * @return \allejo\stakx\Document\StaticPageView
+     */
     public static function getMimeType($extension)
     {
         return isset(self::$mimes[$extension]) ? self::$mimes[$extension] : null;