andela-tolotin / Emoji-REST-API

src/Auth/Oauth.php

Doc Comments -1 removed lines

@@ -16,7 +16,6 @@
      * This method authenticate user and log them in if the supplied
      * credentials are valid.
      *
-     * @param array $loginParams
      *
      * @return json jwt
      */

Spacing +8 added lines, -8 removed lines

@@ -63,7 +63,7 @@ 
     {
         $tokenId = base64_encode(mcrypt_create_iv(32));
         $issuedAt = time();
-        $notBefore = $issuedAt + 10;  //Adding 10 seconds
+        $notBefore = $issuedAt + 10; //Adding 10 seconds
         $expire = $notBefore + (float) strtotime('+30 days'); // Adding 30 days expiry date
         $serverName = $_SERVER['HTTP_HOST']; // Retrieve the server name
 
@@ -72,12 +72,12 @@ 
          * Create the token params as an array
          */
         $data = [
-            'iat'  => $issuedAt,         // Issued at: time when the token was generated
-            'jti'  => $tokenId,          // Json Token Id: an unique identifier for the token
-            'iss'  => $serverName,       // Issuer
-            'nbf'  => $notBefore,        // Not before
-            'exp'  => $expire,           // Expire
-            'dat'  => $userData,                    // User Information retrieved from the database
+            'iat'  => $issuedAt, // Issued at: time when the token was generated
+            'jti'  => $tokenId, // Json Token Id: an unique identifier for the token
+            'iss'  => $serverName, // Issuer
+            'nbf'  => $notBefore, // Not before
+            'exp'  => $expire, // Expire
+            'dat'  => $userData, // User Information retrieved from the database
         ];
 
         $loadEnv = DatabaseConnection::loadEnv();
@@ -85,7 +85,7 @@ 
         $secretKey = base64_decode(getenv('secret'));
 
         $jwt = JWT::encode(
-        $data,      //Data to be encoded in the JWT
+        $data, //Data to be encoded in the JWT
         $secretKey, // The signing key
         'HS512'     // Algorithm used to sign the token
         );

src/Controller/EmojiController.php

Doc Comments +1 added lines

@@ -239,6 +239,7 @@
 
     /**
      * This method authenticate and return user id
+     * @param Request $request
      */
     public function getCurrentUserId($request)
     {

Spacing +2 added lines, -2 removed lines

@@ -231,7 +231,7 @@ 
         foreach ($emojis as $key => &$value) {
             $value['created_by'] = $value['created_by']['firstname'].' '.$value['created_by']['lastname'];
             $value['category'] = $value['category']['category_name'];
-            $value['keywords'] = array_map(function ($key) { return $key['keyword_name']; }, $value['keywords']);
+            $value['keywords'] = array_map(function($key) { return $key['keyword_name']; }, $value['keywords']);
         }
 
         return $emojis;
@@ -247,7 +247,7 @@ 
         $authHeader = $request->getHeader('token');
 
         try {
-            if (is_array($authHeader) && ! empty($authHeader)) {
+            if (is_array($authHeader) && !empty($authHeader)) {
                 $jwtoken = $authHeader[0];
 
                 $secretKey = base64_decode(getenv('secret'));

src/Controller/UserController.php

Doc Comments +1 added lines, -1 removed lines

@@ -12,7 +12,7 @@
      *
      * @param $data
      *
-     * @return int $statuscode
+     * @return string|null $statuscode
      */
     public function createUser(array $data)
     {

src/Database/Schema.php

Spacing +4 added lines, -4 removed lines

@@ -25,7 +25,7 @@ 
      */
     public function createUser()
     {
-        Capsule::schema()->create('users', function ($table) {
+        Capsule::schema()->create('users', function($table) {
             $table->increments('id');
             $table->string('firstname');
             $table->string('lastname');
@@ -41,7 +41,7 @@ 
      */
     public function createKeyword()
     {
-        Capsule::schema()->create('keywords', function ($table) {
+        Capsule::schema()->create('keywords', function($table) {
             $table->increments('id');
             $table->integer('emoji_id');
             $table->string('keyword_name');
@@ -54,7 +54,7 @@ 
      */
     public function createCategory()
     {
-        Capsule::schema()->create('categories', function ($table) {
+        Capsule::schema()->create('categories', function($table) {
             $table->increments('id');
             $table->string('category_name');
             $table->timestamps();
@@ -66,7 +66,7 @@ 
      */
     public function createEmoji()
     {
-        Capsule::schema()->create('emojis', function ($table) {
+        Capsule::schema()->create('emojis', function($table) {
             $table->increments('id');
             $table->string('name');
             $table->string('char');

src/Route/SlimRouteApp.php

Spacing +11 added lines, -11 removed lines

@@ -31,7 +31,7 @@ 
             'settings' => [
             'debug' => true,
             'displayErrorDetails' => true,
-            ],]);
+            ], ]);
         
         $this->runEmojiRoute();
     }
@@ -56,7 +56,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->get('/', function (Request $request, Response $response) {
+        $this->slimApp->get('/', function(Request $request, Response $response) {
             return $response->withJson(['status'], 404);
 
         });
@@ -71,7 +71,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->post('/', function (Request $request, Response $response) {
+        $this->slimApp->post('/', function(Request $request, Response $response) {
             return $response->withJson(['status'], 404);
 
         });
@@ -86,7 +86,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->post('/auth/login', function (Request $request, Response $response) use ($auth) {
+        $this->slimApp->post('/auth/login', function(Request $request, Response $response) use ($auth) {
             return $auth->loginUser($request, $response);
 
         });
@@ -104,7 +104,7 @@ 
         *
         */
 
-        $this->slimApp->get('/auth/logout', function (Request $request, Response $response, $args) use ($auth) {
+        $this->slimApp->get('/auth/logout', function(Request $request, Response $response, $args) use ($auth) {
             return $auth->logoutUser($request, $response, $args)->withJson(['status'], 200);
 
         })->add(new Middleware());
@@ -119,7 +119,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->get('/emojis', function (Request $request, Response $response) use ($emoji) {
+        $this->slimApp->get('/emojis', function(Request $request, Response $response) use ($emoji) {
             return $emoji->listAllEmoji($response);
 
         });
@@ -134,7 +134,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->get('/emojis/{id}', function (Request $request, Response $response, $args) use ($emoji) {
+        $this->slimApp->get('/emojis/{id}', function(Request $request, Response $response, $args) use ($emoji) {
             return  $emoji->getSingleEmoji($response, $args)->withJson(['status'], 200);
 
         });
@@ -149,7 +149,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->post('/emojis', function (Request $request, Response $response) use ($emoji) {
+        $this->slimApp->post('/emojis', function(Request $request, Response $response) use ($emoji) {
             return $emoji->createEmoji($request, $response)->withJson(['status'], 200);
 
         })->add(new Middleware());
@@ -168,7 +168,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->put('/emojis/{id}', function (Request $request, Response $response, $args) use ($emoji) {
+        $this->slimApp->put('/emojis/{id}', function(Request $request, Response $response, $args) use ($emoji) {
             return $emoji->updateEmojiByPutVerb($request, $response, $args);
 
         })->add(new Middleware());
@@ -185,7 +185,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->patch('/emojis/{id}', function (Request $request, Response $response, $args) use ($emoji) {
+        $this->slimApp->patch('/emojis/{id}', function(Request $request, Response $response, $args) use ($emoji) {
             return $emoji->updateEmojiByPatchVerb($request, $response, $args);
 
         })->add(new Middleware());
@@ -202,7 +202,7 @@ 
         * @return json $response
         *
         */
-        $this->slimApp->delete('/emojis/{id}', function (Request $request, Response $response, $args) use ($emoji) {
+        $this->slimApp->delete('/emojis/{id}', function(Request $request, Response $response, $args) use ($emoji) {
             return $emoji->deleteEmoji($request, $response, $args);
 
         })->add(new Middleware());

src/Database/UploadTableInfo.php

Doc Comments +3 added lines

@@ -74,6 +74,9 @@
 
     }
 
+    /**
+     * @param string $keywords
+     */
     public function createEmojiKeywords($emoji_id, $keywords)
     {
         if ($keywords) {