hiqdev\hiart\AbstractConnection

Complexity

Total Complexity

30

Size/Duplication

Total Lines	263
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	4

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	getDb()	0	4	2
A	setAuth()	0	4	1
A	getAuth()	0	11	3
A	disableAuth()	0	4	1
A	enableAuth()	0	4	1
A	__sleep()	0	4	1
A	getDriverName()	0	4	1
A	createCommand()	0	6	1
A	getQueryBuilder()	0	8	2
A	getHandler()	0	4	1
A	setHandler()	0	4	1
A	isDisabledAuth()	0	4	1
A	setDisabledAuth()	0	4	1
A	decodeErrorBody()	0	14	3
A	setErrorChecker()	0	4	1
A	checkResponse()	0	10	2
A	checkError()	0	8	2
A	isError()	0	4	1
A	getBaseUri()	0	12	3
A	getUserAgent()	0	4	1

<?php
/**
 * Tools to use API as ActiveRecord for Yii2
 *
 * @link      https://github.com/hiqdev/yii2-hiart
 * @package   yii2-hiart
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\hiart;

use Closure;
use Yii;
use hiqdev\hiart\stream\Request;
use yii\base\Component;
use yii\base\InvalidParamException;
use yii\helpers\Json;

/**
 * Abstract connection class.
 */
abstract class AbstractConnection extends Component implements ConnectionInterface
{
    const EVENT_AFTER_OPEN = 'afterOpen';

    /**
     * @var string to be specified in concrete implementation
     */
    public $queryBuilderClass;

    public $requestClass = Request::class;

    public $commandClass = Command::class;

    public $queryClass = Query::class;

    public $activeQueryClass = ActiveQuery::class;

    public static $dbname = 'hiart';

    public $name = 'hiart';

    public $userAgent = 'HiArt/0.x';

    public $baseUri;

    /**
     * @var array transport config will be used in Request for handler or proxy request
     */
    public $config = [];

    /**
     * @var object request handler common for all requests of this connection
     */
    protected $_handler;

    /**
     * @var QueryBuilder the query builder for this connection
     */
    protected $_builder;

    /**
     * @var array authorization config
     */
    protected $_auth = [];

    /**
     * @var bool is auth disabled
     */
    protected $_disabledAuth = false;

    /**
     * @var Closure callback to test if API response has error
     * The function signature: `function ($response)`
     * Must return `null`, if the response does not contain an error
     */
    protected $_errorChecker;

    public static function getDb($dbname = null)
    {
        return $dbname ? Yii::$app->get($dbname) : Yii::$container->get(ConnectionInterface::class);
    }

    public function setAuth($auth)
    {
        $this->_auth = $auth;
    }

    /**
     * Returns auth settings.
     * @return array
     */
    public function getAuth()
    {
        if ($this->_disabledAuth) {
            return [];
        }
        if ($this->_auth instanceof Closure) {
            $this->_auth = call_user_func($this->_auth, $this);

It seems like call_user_func($this->_auth, $this) of type * is incompatible with the declared type array of property $_auth.

        }

        return $this->_auth;
    }

    public function disableAuth()
    {
        $this->_disabledAuth = true;
    }

    public function enableAuth()
    {
        $this->_disabledAuth = false;
    }

    /**
     * Closes the connection when this component is being serialized.
     * @return array
     */
    public function __sleep()
    {
        return array_keys(get_object_vars($this));
    }

    /**
     * Returns the name of the DB driver for the current [[dsn]].
     * @return string name of the DB driver
     */
    public function getDriverName()
    {
        return 'hiart';
    }

    /**
     * Creates a command for execution.
     * @param array $config the configuration for the Command class
     * @return Command the DB command
     */
    public function createCommand(array $config = [])
    {
        $config['db'] = $this;

        return new $this->commandClass($config);
    }

    /**
     * @return QueryBuilder the query builder for this connection
     */
    public function getQueryBuilder()
    {
        if ($this->_builder === null) {
            $this->_builder = new $this->queryBuilderClass($this);
        }

        return $this->_builder;
    }

    /**
     * Handler is created and set by request.
     * @see setHandler
     * @return object
     */
    public function getHandler()
    {
        return $this->_handler;
    }

    /**
     * Requests use this function to keep request handler.
     * @param object $handler
     */
    public function setHandler($handler)
    {
        $this->_handler = $handler;
    }

    /**
     * @return boolean
     */
    public function isDisabledAuth()
    {
        return $this->_disabledAuth;
    }

    /**
     * @param boolean $disabledAuth
     */
    public function setDisabledAuth($disabledAuth)
    {
        $this->_disabledAuth = $disabledAuth;
    }

    /**
     * Try to decode error information if it is valid json, return it if not.
     * @param $body
     * @return mixed
     */
    protected function decodeErrorBody($body)
    {
        try {
            $decoded = Json::decode($body);
            if (isset($decoded['error'])) {
                $decoded['error'] = preg_replace('/\b\w+?Exception\[/',
                    "<span style=\"color: red;\">\\0</span>\n               ", $decoded['error']);
            }

            return $decoded;
        } catch (InvalidParamException $e) {
            return $body;
        }
    }

    /**
     * Setter for errorChecker.
     * @param Closure $checker
     */
    public function setErrorChecker($checker)
    {
        $this->_errorChecker = $checker;
    }

    /**
     * Checks response with checkError method and raises exception if error.
     * @param ResponseInterface $response response data from API
     * @throws ErrorResponseException
     * @return mixed response data
     */
    public function checkResponse(ResponseInterface $response)
    {
        $error = $this->checkError($response);
        if ($error) {

The expression $error of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            throw new ErrorResponseException($error, [
                'request' => $response->getRequest()->getParts(),
                'response' => $response->getData(),
            ]);
        }
    }

    /**
     * Checks response with errorChecker callback and returns error text if error.
     * @param ResponseInterface $response
     * @return string|false error text or false
     */
    public function checkError(ResponseInterface $response)
    {
        if (isset($this->_errorChecker)) {
            return call_user_func($this->_errorChecker, $response);
        } else {
            return $this->isError($response);

The return type of return $this->isError($response); (boolean) is incompatible with the return type documented by hiqdev\hiart\AbstractConnection::checkError of type string|false.

        }
    }

    /**
     * Default error checker. TODO check something in response?
     * @param ResponseInterface $response
     * @return bool
     */
    public function isError(ResponseInterface $response)

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

    {
        return false;
    }

    /**
     * Return API base uri.
     * Adds trailing slash if uri is domain only.
     * @return string
     */
    public function getBaseUri()
    {
        static $checked;
        if (empty($checked)) {
            if (count(explode('/', $this->baseUri, 4)) === 3) {
                $this->baseUri .= '/';
            }
            $checked = true;
        }

        return $this->baseUri;
    }

    public function getUserAgent()
    {
        return $this->userAgent;
    }
}