Multidimensional\Cakephpify\Controller\Component\ShopifyDatabaseComponent

Complexity

Total Complexity

30

Size/Duplication

Total Lines	192
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

Test Coverage

Coverage

23.53%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	shopDataToDatabase()	0	17	3
B	accessTokenToDatabase()	0	31	4
A	initialize()	0	5	1
A	startup()	0	4	1
A	setController()	0	7	2
B	getShopIdFromDomain()	0	20	5
C	getShopDataFromAccessToken()	0	29	7
C	getAccessTokenFromShopDomain()	0	27	7

<?php
/**
 * CakePHPify : CakePHP Plugin for Shopify API Authentication
 * Copyright (c) Multidimension.al (http://multidimension.al)
 * Github : https://github.com/multidimension-al/cakephpify
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE file
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright (c) Multidimension.al (http://multidimension.al)
 * @link      https://github.com/multidimension-al/cakephpify CakePHPify Github
 * @license   http://www.opensource.org/licenses/mit-license.php MIT License
 */

namespace Multidimensional\Cakephpify\Controller\Component;

use Cake\Controller\Component;
use Cake\Event\Event;
use Cake\ORM\TableRegistry;

class ShopifyDatabaseComponent extends Component

The property $access_tokens is not named in camelCase.

{

    private $shops;
    private $access_tokens;

$access_tokens does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    public $controller = null;

    /**
     * @param array $config

Missing parameter comment

     * @return void
     */
    public function initialize(array $config = [])
    {
        $this->shops = TableRegistry::get('Multidimensional/Cakephpify.Shops');
        $this->access_tokens = TableRegistry::get('Multidimensional/Cakephpify.AccessTokens');
    }

    /**
     * @param Event $event

Missing parameter comment

     * @return void
     */
    public function startup(Event $event)
    {
        $this->setController($event->subject());
    }

    /**
     * @param controller $controller

Missing parameter comment

     * @return void
     */
    public function setController($controller)
    {
        $this->controller = $controller;
        if (!isset($this->controller->paginate)) {
            $this->controller->paginate = [];
        }
    }

    /**
     * @param array $data

Missing parameter comment

     * @return array|bool

Consider making the return type a bit more specific; maybe use array|false.

     */
    public function shopDataToDatabase(array $data)
    {
        $shopEntity = $this->shops->newEntity();

        unset($data['created_at']);
        unset($data['updated_at']);

        $shopEntity->set($data);

        $shopEntity->set(['updated_at' => new \DateTime('now')]);

        if (!$shopEntity->errors() && $this->shops->save($shopEntity)) {
            return $shopEntity->toArray();
        } else {
            return false;
        }
    }

    /**
     * @param string $accessToken

Missing parameter comment

     * @param int    $shopId

Missing parameter comment

     * @param string $apiKey

Missing parameter comment

     * @return array|bool

Consider making the return type a bit more specific; maybe use array|false.

     */
    public function accessTokenToDatabase($accessToken, $shopId, $apiKey)
    {
        $accessTokenEntity = $this->access_tokens->newEntity();

        $accessTokenArray = [
            'shop_id' => $shopId,
            'api_key' => $apiKey,
            'token' => $accessToken];

        $accessTokenEntity->set($accessTokenArray);

        $accessTokenId = $this->access_tokens
            ->find()
            ->where($accessTokenArray)
            ->first();

        if ($accessTokenId) {
            $accessTokenEntity->set(
                [
                'id' => $accessTokenId->id,
                'updated_at' => new \DateTime('now')
                ]
            );
        }

        if (!$accessTokenEntity->errors() && $this->access_tokens->save($accessTokenEntity)) {
            return $accessTokenEntity->toArray();
        } else {
            return false;
        }
    }

    /**
     * @param string $domain

Missing parameter comment

     * @return int|false
     */
    public function getShopIdFromDomain($domain)
    {
        if (empty($domain) || $domain === true) {
            return false;    

Double space found

        }

        $query = $this->shops->find;

The property find does not seem to exist in Cake\ORM\Table.

        $query = $query->findByShopDomain(['domain' => $domain]);
        $shopEntity = $query->first();
            
        if ($shopEntity->isEmpty()) {
            return false;    

Double space found

        }
            
        if ($shopEntity->id) {
            return (int)$shopEntity->id;
        } else {
            return false;
        }
    }

    /**
     * @param string $accessToken

Missing parameter comment

     * @param string $apiKey

Missing parameter comment

     * @return array|false
     */
    public function getShopDataFromAccessToken($accessToken, $apiKey)
    {
        if (empty($accessToken) || empty($apiKey) || $accessToken === true || $apiKey === true) {
            return false;    

Double space found

        }
        
        $query = $this->access_tokens->find();
        $query = $query->contain(['Shops']);
        $query = $query->where(['api_key' => $apiKey, 'token' => $accessToken]);
        $query = $query->where(
            function ($exp, $q) {

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

                return $exp->isNull('expired_at');
            }
        );

        $shopEntity = $query->first();
        
        if ($shopEntity->isEmpty()) {
            return false;    

Double space found

        }
        
        $shopArray = $shopEntity->toArray();

        if (is_array($shopArray['shop'])) {
            return $shopArray['shop'];
        } else {
            return false;
        }
    }

    /**
     * @param string $shopDomain

Missing parameter comment

     * @param string $apiKey

Missing parameter comment

     * @return string|bool
     */
    public function getAccessTokenFromShopDomain($shopDomain, $apiKey)
    {
        if (empty($shopDomain) || empty($apiKey) || $shopDomain === true || $apiKey === true) {
            return false;    

Double space found

        }
        
        $query = $this->access_tokens->find();
        $query = $query->contain(['Shops']);
        $query = $query->where(['api_key' => $apiKey, 'Shops.myshopify_domain' => $shopDomain]);
        $query = $query->where(
            function ($exp, $q) {

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

                return $exp->isNull('expired_at');
            }
        );

        $accessTokenEntity = $query->first();

        if ($accessTokenEntity->isEmpty()) {
            return false;    

Double space found

        }

        if ($accessTokenEntity->token) {
            return $accessTokenEntity->token;
        } else {
            return false;
        }
    }
}