AliAlharthi\SaudiAddress\Api\Regions

Complexity

Total Complexity

15

Size/Duplication

Total Lines	161
Duplicated Lines	17.39 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	12	21	5
A	get()	0	6	1
A	getId()	8	8	1
A	byId()	0	4	1
A	id()	0	4	1
A	getName()	8	8	1
A	name()	0	4	1
A	byName()	0	4	1
A	named()	0	4	1
A	check()	0	6	2

<?php

/*
 * Part of the Saudi Address API PHP package.
 *
 * NOTICE OF LICENSE
 *
 * Licensed under the MIT.
 *
 * This source file is subject to the MIT License that is
 * bundled with this package in the LICENSE file.
 *
 * @package    Saudi Address
 * @version    1.2
 * @author     Ali Alharthi
 * @license    MIT
 * @copyright  (c) 2020, Ali Alharthi
 * @link       https://aalharthi.sa
 */

namespace AliAlharthi\SaudiAddress\Api;

class Regions extends Api
{
    /**
     * The response array.
     *
     * @var array|null
     */
    protected $response = null;

    /**
     * The cache directory.
     *
     * @var string|null
     */
    protected $cacheDir = __DIR__ . '/cache/';

    /**
     * The cache file name.
     *
     * @var string|null
     */
    protected $file = __DIR__ . '/cache/' . 'regions_';

    /**
     * Returns a list of all the regions.
     *
     * @param   string  $lang
     * @return  Regions
     */
    public function all($lang = 'A')
    {
        $cache = $this->file . strtolower($lang) . '.data';

        $this->response = $this->cacheValue($cache);

It seems like $this->cacheValue($cache) can also be of type string. However, the property $response is declared as type array|null. Maybe add an additional type check?

        if ($this->response == null) {

It seems like you are loosely comparing $this->response of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

This code seems to be duplicated across your project.

            $response = $this->_get(
                'v3.1/lookup/regions',
                $lang
            );
            if($this->config->getCache()){
                (!file_exists($this->cacheDir)) ?
                mkdir($this->cacheDir, 0777, false) : ((file_exists($cache)) ? unlink($cache) : touch($cache));
                file_put_contents($cache, serialize($response));
            }
            $this->response = $response;
        }

        return $this;
    }

    /**
     * Returns a the response.
     *
     * @return  array
     */
    public function get()
    {
        $this->check();

        return $this->response['Regions'];
    }

    /**
     * Returns a certian region info by id.
     *
     * @param   int     $regionId
     * @return  array
     */
    public function getId(int $regionId)

This method seems to be duplicated in your project.

    {
        $this->check();

        $key = array_search($regionId, array_column($this->response['Regions'], 'Id'));

        return $this->response['Regions'][$key];
    }

    /**
     * Returns a certian region info by id.
     *
     * @param   int     $regionId
     * @return  array
     */
    public function byId(int $regionId)
    {
        return $this->getId($regionId);
    }

    /**
     * Returns a certian region info by id.
     *
     * @param   int     $regionId
     * @return  array
     */
    public function id(int $regionId)
    {
        return $this->getId($regionId);
    }

    /**
     * Returns a certian region info by name.
     *
     * @param   string  $name
     * @return  array
     */
    public function getName($name)

This method seems to be duplicated in your project.

    {
        $this->check();

        $key = array_search(ucwords($name), array_column($this->response['Regions'], 'Name'));

        return $this->response['Regions'][$key];
    }

    /**
     * Returns a certian region info by name.
     *
     * @param   string  $name
     * @return  array
     */
    public function name($name)
    {
        return $this->getName($name);
    }

    /**
     * Returns a certian region info by name.
     *
     * @param   string  $name
     * @return  array
     */
    public function byName($name)
    {
        return $this->getName($name);
    }

    /**
     * Returns a certian region info by name.
     *
     * @param   string  $name
     * @return  array
     */
    public function named($name)
    {
        return $this->getName($name);
    }

    /**
     * Check if all() method was called first.
     *
     * @return  void
     * @throws  \BadMethodCallException
     */
    protected function check()
    {
        if ($this->response == null) {
            throw new \BadMethodCallException("You need to call all() method first.");
        }
    }
}