Demo\EmojiController

Complexity

Total Complexity

35

Size/Duplication

Total Lines	317
Duplicated Lines	5.99 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	10
Bugs	3	Features	3

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getAllEmojis()	10	10	2
A	getSingleEmoji()	9	10	2
B	CreateEmoji()	0	34	4
A	updateEmojiByPatch()	0	21	3
A	updateEmojiByPut()	0	21	3
A	deleteEmoji()	0	12	2
A	getUserId()	0	18	3
A	getTheOwner()	0	6	1
A	createEmojiKeywords()	0	21	3
B	checkEmptyInput()	0	8	5
A	checkDuplicateEmoji()	0	12	3
A	validateArgs()	0	14	3

<?php

/**
 * @author: Raimi Ademola <ademola.raimi@andela.com>
 * @copyright: 2016 Andela
 */
namespace Demo;


use Exception;
use Carbon\Carbon;
use Firebase\JWT\JWT;
use Illuminate\Database\Capsule\Manager as Capsule;
use Psr\Http\Message\ResponseInterface as Response;

class EmojiController
{
    public $authController;

    /**
     * This is a constructor; a default method  that will be called automatically during class instantiation.
     */
    public function __construct()
    {
        $this->authController = new AuthController();
    }

    /**
     * Get all emojis.
     *
     * @param Slim\Http\Request  $request
     * @param Slim\Http\Response $response
     * @param array              $args
     *
     * @return Slim\Http\Response
     */
    public function getAllEmojis($request, $response, $args)

The parameter $request is not used and could be removed.

The parameter $args is not used and could be removed.

This method seems to be duplicated in your project.

    {
        $emoji = Emoji::with('keywords', 'created_by')->get();

        if (count($emoji) > 0) {
            return $response->withJson($emoji);
        }

        return $response->withJson(['message' => 'Oops, No Emoji to display'], 404);
    }

    /**
     * Get a single emoji.
     *
     * @param Slim\Http\Request  $request
     * @param Slim\Http\Response $response
     * @param array              $args
     *
     * @return Slim\Http\Response
     */
    public function getSingleEmoji($request, $response, $args)

The parameter $request is not used and could be removed.

This method seems to be duplicated in your project.

    {
        $emoji = Emoji::with('keywords', 'created_by')->find($args['id']);

        if (count($emoji) < 1) {
            return $response->withJson(['message' => 'The requested Emoji is not found.'], 404);
        }

        return $response->withJson($emoji);
    }

    /**
     * This method creates emoji and keywords associated with it.
     *
     * @param $request
     * @param $response
     * @param $requestParams
     *
     * @return json response
     */
    public function CreateEmoji($request, $response, $requestParams)

The parameter $requestParams is not used and could be removed.

    {
        $requestParams     = $request->getParsedBody();
        $validateUserData = $this->authController->validateUserData(['name', 'chars', 'category', 'keywords'], $requestParams);

        if (is_array($validateUserData)) {
            return $response->withJson($validateUserData, 400);
        }
        
        $validateEmptyInput = $this->checkEmptyInput($requestParams['name'], $requestParams['chars'], $requestParams['category'], $requestParams['keywords']);

        if (is_array($validateEmptyInput)) {
            return $response->withJson($validateEmptyInput, 401);
        }

        $validateEmojiDuplicate = $this->checkDuplicateEmoji($requestParams['name'], $requestParams['chars']);

        if (is_array($validateEmojiDuplicate)) {
            return $response->withJson($validateEmojiDuplicate, 400);
        }

        $emoji = Emoji::create([
            'name'       => strtolower($requestParams['name']),
            'chars'      => $requestParams['chars'],
            'category'   => $requestParams['category'],
            'created_at' => Carbon::now()->toDateTimeString(),
            'updated_at' => Carbon::now()->toDateTimeString(),
            'created_by' => $this->getUserId($request, $response),
        ]);

        $this->createEmojiKeywords($emoji->id, $requestParams['keywords']);

The property id does not exist on object<Demo\Emoji>. Since you implemented __get, maybe consider adding a @property annotation.

        return $response->withJson($emoji->toArray(), 201);
    }

    /**
     * This method updates an emoji by using Patch.
     *
     * @param $request
     * @param $response
     * @param $args
     *
     * @return json $response
     */
    public function updateEmojiByPatch($request, $response, $args)
    {
        $updateParams = $request->getParsedBody();

        $validateUserData = $this->authController->validateUserData(['name'], $updateParams);
       
        if (is_array($validateUserData)) {
            return $response->withJson($validateUserData, 400);
        }

        $validateArgs = $this->validateArgs($request, $response, $args);

        if (is_array($validateArgs)) {
            return $response->withJson($validateArgs, 401);
        }

        Emoji::where('id', '=', $args['id'])
            ->update(['name' => strtolower($updateParams['name']), 'updated_at' => Carbon::now()->toDateTimeString()]);

        return $response->withJson(['message' => 'Emoji has been updated successfully'], 200);
    }

    /**
     * This method updates an emoji by using put.
     *
     * @param $request
     * @param $response
     * @param $args
     *
     * @return json $response
     */
    public function updateEmojiByPut($request, $response, $args)
    {
        $updateParams = $request->getParsedBody();

        $validateUserData = $this->authController->validateUserData(['name', 'chars', 'category'], $updateParams);
       
        if (is_array($validateUserData)) {
            return $response->withJson($validateUserData, 400);
        }

        $validateArgs = $this->validateArgs($request, $response, $args);

        if (is_array($validateArgs)) {
            return $response->withJson($validateArgs, 401);
        }

        Emoji::where('id', '=', $args['id'])
            ->update(['name' => strtolower($updateParams['name']), 'chars' => $updateParams['chars'], 'category' => $updateParams['category'], 'updated_at' => Carbon::now()->toDateTimeString()]);

        return $response->withJson(['message' => 'Emoji has been updated successfully'], 200);
    }

    /**
     * This method deletes an emoji.
     *
     * @param Slim\Http\Request  $request
     * @param Slim\Http\Response $response
     * @param array              $args
     *
     * @return json response
     */
    public function deleteEmoji($request, $response, $args)
    {
        $validateArgs = $this->validateArgs($request, $response, $args);

        if (is_array($validateArgs)) {
            return $response->withJson($validateArgs, 401);
        }

        Emoji::where('id', '=', $args['id'])->delete();

        return $response->withJson(['message' => 'Emoji successfully deleted.'], 200);
    }

    /**
     * This method authenticate and returns user id.
     *
     * @param $response
     * @param $request
     *
     * @return user id
     */
    public function getUserId($request, $response)
    {
        $jwtoken = $request->getHeader('HTTP_AUTHORIZATION');

        try {
            if (isset($jwtoken)) {
                $secretKey    = getenv('APP_SECRET');
                $jwt          = $jwtoken[0];
                $decodedToken = JWT::decode($jwt, $secretKey, ['HS512']);
                $tokenInfo    = (array) $decodedToken;
                $userInfo     = (array) $tokenInfo['data'];

                return $userInfo['userId'];
            }
        } catch (Exception $e) {
            return $response->withJson(['status: fail, msg: Unauthorized']);
        }
    }

    /**
     * This method solves for rightful owner of a record.
     *
     * @param $response
     * @param $request
     * @param $args
     *
     * @return user id
     */
    public function getTheOwner($request, $response, $args)
    {
        return Capsule::table('emojis')
            ->where('id', '=', $args['id'])
            ->where('created_by', '=', $this->getUserId($request, $response));
    }

    /**
     * This method creates emoji keywords.
     *
     * @param $emoji_id
     * @param $keywords
     *
     * @return keyword id
     */
    public function createEmojiKeywords($emoji_id, $keywords)
    {
        if (isset($keywords)) {
            $splittedKeywords = explode(',', $keywords);
            $created_at       = Carbon::now()->toDateTimeString();
            $updated_at       = Carbon::now()->toDateTimeString();

            foreach ($splittedKeywords as $keyword) {
                $emojiKeyword = Keyword::create([
                    'emoji_id'     => $emoji_id,
                    'keyword_name' => $keyword,
                    'created_at'   => $created_at,
                    'updated_at'   => $updated_at,
                ]);
            }

            return $emojiKeyword->id;

The property id does not exist on object<Demo\Keyword>. Since you implemented __get, maybe consider adding a @property annotation.

The variable $emojiKeyword does not seem to be defined for all execution paths leading up to this point.

        }

        return true;
    }

    /**
     * This method checks for empty input from user.
     *
     * @param $inputName
     * @param $inputChars
     * @param $inputCategory
     * @param $inputKeywords
     *
     * @return bool
     */
    public function checkEmptyInput($inputName, $inputChars, $inputCategory, $inputKeywords)
    {
        if (empty($inputName) || empty($inputChars) || empty($inputCategory) || empty($inputKeywords)) {
            return ['message' => 'All fields must be provided.'];
        }

        return true;
    }

    /**
     * This method checks for duplicate emoji.
     *
     * @param $inputName
     * @param $inputChars
     *
     * @return bool
     */
    public function checkDuplicateEmoji($inputName, $inputChars)
    {
        $nameCheck = Capsule::table('emojis')->where('name', '=', strtolower($inputName))->get();
        $charsCheck = Capsule::table('emojis')->where('chars', '=', $inputChars)->get();
       
        if ($nameCheck || $charsCheck) {

The expression $nameCheck of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

The expression $charsCheck of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return ['message' => 'The emoji already exist in the database.'];
        }

        return true;
    }

    /**
     * This method checks for empty input from user.
     *
     * @param $request
     * @param $response
     * @param $args
     *
     * @return bool
     */
    public function validateArgs($request, $response, $args)
    {
        $emoji = Emoji::find($args['id']);
        
        if (count($emoji) < 1) {
            return ['message' => 'Action cannot be performed because the id supplied is invalid'];
        }

        if (is_null($this->getTheOwner($request, $response, $args)->first())) {

The method first does not exist on object<Demo\User>? Since you implemented __call, maybe consider adding a @method annotation.

            return ['message' => 'Action cannot be performed because you are not the creator'];
        }

        return true;
    }
}