CryptoMarkets\Common\Gateway

Complexity

Total Complexity

9

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setOptions()	0	4	1
A	getOptions()	0	4	1
A	getOption()	0	4	1
A	getDefaultOptions()	0	4	1
	getName()	0	1	?
A	createRequest()	0	6	1
A	getHttpClient()	0	8	2
A	setHttpClient()	0	6	1

<?php

namespace CryptoMarkets\Common;

use CryptoMarkets\Common\Client;

abstract class Gateway
{
    /**
     * The HTTP client instance.
     *
     * @var \CryptoMarkets\Common\Client
     */
    protected $httpClient;

    /**
     * The gateway's options.
     *
     * @var array
     */
    protected $options = [];

    /**
     * Create a new Gateway instance.
     *
     * @param  array  $options
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(array $options = [])
    {
        $this->setOptions($options);
    }

    /**
     * Merge the custom options with the defaults.
     *
     * @param  array  $options
     * @return void
     */
    public function setOptions(array $options = [])
    {
        $this->options = array_replace($this->getDefaultOptions(), $options);
    }

    /**
     * Get the options.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * et the specified option value (if any).
     *
     * @param  string  $key
     * @param  mixed  $default
     * @return mixed
     */
    public function getOption($key, $default = null)

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

    {
        return $this->options[$key];
    }

    /**
     * Get the default options.
     *
     * @return array
     */
    public function getDefaultOptions()
    {
        return [];
    }

    /**
     * Get the gateway name.
     *
     * @return string
     */
    abstract public function getName();

    /**
     * Create a new request object.
     *
     * @param  string  $class
     * @param  array  $params
     * @return \CryptoMarkets\Common\Http\Request
     */
    public function createRequest($class, array $params = [])
    {
        $instance = new $class($this->getHttpClient());

        return $instance->configure(array_replace($this->getOptions(), $params));
    }

    /**
     * Get a instance of the HTTP client.
     *
     * @return \CryptoMarkets\Common\Client
     */
    public function getHttpClient()
    {
        if (is_null($this->httpClient)) {
            $this->setHttpClient(new Client);
        }

        return $this->httpClient;
    }

    /**
     * Set the HTTP client instance.
     *
     * @param  \CryptoMarkets\Common\Client  $client
     * @return $this
     */
    public function setHttpClient(Client $client)
    {
        $this->httpClient = $client;

        return $this;
    }
}