Address::find() - Code Metrics - Inspection of "3d6a47c1a4e290a4fdb76fe4e8c9761acbe21dc9" - ali-alharthi/SaudiAddress - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Branch — simplistic (3d6a47)

by Ali
created 2021-10-16 16:44 UTC
Address::find() A

↳ Parent: Address
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	3
rs	10
<?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    2.0
 * @author     Ali Alharthi
 * @license    MIT
 * @copyright  (c) 2020, Ali Alharthi
 * @link       https://aalharthi.sa
 */

namespace AliAlharthi\SaudiAddress\Api;

use AliAlharthi\SaudiAddress\ConfigInterface;

class Address 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/' . 'address_';

    /**
     * Constructor.
     *
     * @param   \AliAlharthi\SaudiAddress\ConfigInterface  $config
     */
    public function __construct($config)
    {
        parent::__construct($config);
    }

    /**
     * Free text address search.
     *
     * @param   string  $address
     * @param   int     $page
     * @return  Address
     */
    public function search($address, $page = 1)
    {
        $cache = $this->file . preg_replace('/[^a-zA-Z0-9_]/', '_', $address) . '_' . strtolower($this->config->getLocale()) . '.data';

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

        if ($this->response == null) {
            $response = $this->_get(
                'v4/Address/address-free-text',
                [
                    'addressstring' => $address,
                    'page' => $page,
                ],
                false
            );
            if ($response['success'] == false) {
                return;
            }
            $addresses = $response['Addresses'];
            $pages = (int) ceil($response['totalSearchResults'] / 20);
            if ($page == 1 && ($pages > 1)) {
                for ($i = 2; $i <= $pages; $i++) {
                    // 1 call allowed per 5 seconds (on Development subscription)
                    ($this->config->getApiSubscription() == 'Development') ? sleep(5) : '';
                    $pageData = $this->_get(
                        'v4/Address/address-free-text',
                        [
                            'addressstring' => $address,
                            'page' => $i,
                        ],
                        false
                    );

                    $pageData = $pageData['Addresses'];
                    $pageData = array_combine(range(($i * 10), count($pageData) + (($i * 10) - 1)), array_values($pageData));
                    $addresses += $pageData;
                }
            }
            if($this->config->getCache()){
                (!file_exists($this->cacheDir)) ?
                (!file_exists(/** @scrutinizer ignore-type */ $this->cacheDir)) ?
                    mkdir($this->cacheDir, 0777, false) : ((file_exists($cache)) ? unlink($cache) : touch($cache));
                    mkdir(/** @scrutinizer ignore-type */ $this->cacheDir, 0777, false) : ((file_exists($cache)) ? unlink($cache) : touch($cache));
                file_put_contents($cache, serialize($addresses));
            }
            $this->response = $addresses;
        }

        return $this;
    }
    /**
     * Constructor.
     *
     * @param   string  $address
     * @param   int     $page
     * @return  Address
     */
    public function find($address = null, $page = 1)
    {
        $this->search($address, $page);
    }

    /**
     * Returns all the addresses found.
     *
     * @return  array
     */
    public function all()
    {
        $this->check();

        return $this->response;
    }

    /**
     * Returns all the addresses found.
     *
     * @return  array
     */
    public function get()
    {
        return $this->all();
    }

    /**
     * Verify an address.
     *
     * @param   int     $buildingNumber
     * @param   int     $zip
     * @param   int     $additionalNumber
     * @return  bool
     */
    public function verify($buildingNumber, $zip, $additionalNumber)
    {
        $cache = $this->file . $buildingNumber . '_' .$zip . '_' .$additionalNumber . '_' . strtolower($this->config->getLocale()) . '.data';

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

        if ($response == null) {

            $response = $this->_get(
                'v3.1/Address/address-verify',
                [
                    'buildingnumber'    => $buildingNumber,
                    'zipcode'           => $zip,
                    'additionalnumber'  => $additionalNumber,
                ]
            );
        }

        if($this->config->getCache()){
            (!file_exists($this->cacheDir)) ?
            (!file_exists(/** @scrutinizer ignore-type */ $this->cacheDir)) ?
                mkdir($this->cacheDir, 0777, false) : ((file_exists($cache)) ? unlink($cache) : touch($cache));
                mkdir(/** @scrutinizer ignore-type */ $this->cacheDir, 0777, false) : ((file_exists($cache)) ? unlink($cache) : touch($cache));
            file_put_contents($cache, serialize($response));
        }

        return (bool) $response['addressfound'];
    }

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

ali-alharthi / SaudiAddress

Branch — simplistic (3d6a47)

Address::find() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
