Arcanedev\GeoIP\Drivers\AbstractDriver

Complexity

Total Complexity

4

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

80%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
	init()	0	1	?
A	update()	0	6	1
A	getOption()	0	4	1
A	hydrate()	0	4	1

<?php namespace Arcanedev\GeoIP\Drivers;

use Arcanedev\GeoIP\Contracts\GeoIPDriver;
use Arcanedev\GeoIP\Location;
use Illuminate\Support\Arr;

/**
 * Class     AbstractDriver
 *
 * @package  Arcanedev\GeoIP\Drivers
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
abstract class AbstractDriver implements GeoIPDriver
{
    /* ------------------------------------------------------------------------------------------------
     |  Properties
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Driver options.
     *
     * @var array
     */
    protected $options = [];

    /* ------------------------------------------------------------------------------------------------
     |  Constructor
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * AbstractDriver constructor.
     *
     * @param  array  $options
     */
    public function __construct(array $options = [])
    {
        $this->options = $options;
        $this->init();
    }

    /* ------------------------------------------------------------------------------------------------
     |  Main Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Init the driver.
     */
    abstract protected function init();

    /**
     * Update the driver.
     *
     * @return bool
     *
     * @throws \Exception
     */
    public function update()
    {
        // Do nothing

        return true;
    }

    /* ------------------------------------------------------------------------------------------------
     |  Other Functions
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get option value.
     *
     * @param  string  $key
     * @param  mixed   $default
     *
     * @return mixed
     */
    protected function getOption($key, $default = null)
    {
        return Arr::get($this->options, $key, $default);
    }

    /**
     * Hydrate the location entity.
     *
     * @param  array  $attributes
     *
     * @return \Arcanedev\GeoIP\Location
     */
    protected function hydrate(array $attributes = [])
    {
        return new Location($attributes);
    }
}