phpcs

Author: driusan

modules/dashboard/jsx/welcome.js

@@ -1,13 +1,13 @@
 import DOMPurify from 'dompurify';
 
 window.addEventListener('load', () => {
-    fetch(loris.BaseURL + "/dashboard/projectdescription").then ( (resp) => {
+    fetch(loris.BaseURL + '/dashboard/projectdescription').then( (resp) => {
         if (!resp.ok) {
             throw new Error('Could not get project description');
         }
         return resp.json();
-    }).then ( (json) => {
-      const el = document.getElementById("project-description");
+    }).then( (json) => {
+      const el = document.getElementById('project-description');
       el.innerHTML = DOMPurify.sanitize(json.Description);
     }).catch( (e) => console.error(e));
 });

modules/dashboard/php/projectdescription.class.inc

@@ -1,6 +1,5 @@
 <?php
 namespace LORIS\dashboard;
-use \Psr\Http\Server\RequestHandlerInterface;
 use \Psr\Http\Message\ServerRequestInterface;
 use \Psr\Http\Message\ResponseInterface;
 
@@ -12,11 +11,28 @@ use \Psr\Http\Message\ResponseInterface;
 
 class ProjectDescription extends \LORIS\Http\Endpoint
 {
-    public function handle(ServerRequestInterface $request) : ResponseInterface {
+    /**
+     * {@inheritDoc}
+     *
+     * @param ServerRequestInterface $request The incoming request
+     *
+     * @return ResponseInterface
+     */
+    public function handle(ServerRequestInterface $request) : ResponseInterface
+    {
         $desc = $this->loris->getConfiguration()->getSetting('projectDescription');
         return new \LORIS\Http\Response\JSON\OK(['Description' => $desc]);
     }
-    public function _hasAccess(\User $user) {
+
+    /**
+     * The hasAccess call called by the Module class before loading the page.
+     *
+     * @param \User $user The user accessing the page
+     *
+     * @return bool
+     */
+    function _hasAccess(\User $user)
+    {
         return true;
     }
 }

src/Http/Endpoint.php

@@ -70,13 +70,14 @@ public function hasAccess(\User $user): bool
      * This function can be overridden in a module's page to load the necessary
      * resources to check the permissions of a user.
      *
-     * @param User                   $user    The user to load the resources for
+     * @param \User                   $user    The user to load the resources for
      * @param ServerRequestInterface $request The PSR15 Request being handled
      *
      * @return void
      */
     public function loadResources(
-        \User $user, ServerRequestInterface $request
+        \User $user,
+        ServerRequestInterface $request
     ) : void {
     }
 }