Jgut\Tify\Adapter\AbstractAdapter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	3
A	isSandbox()	0	4	1
A	setSandbox()	0	6	1
A	getDefinedParameters()	0	4	1
A	getDefaultParameters()	0	4	1
A	getRequiredParameters()	0	4	1

<?php
/**
 * Push notification services abstraction (http://github.com/juliangut/tify)
 *
 * @link https://github.com/juliangut/tify for the canonical source repository
 *
 * @license https://github.com/juliangut/tify/blob/master/LICENSE
 */

namespace Jgut\Tify\Adapter;

use Doctrine\Common\Collections\ArrayCollection;
use Jgut\Tify\Exception\AdapterException;
use Jgut\Tify\ParameterTrait;
use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Class AbstractService.
 */
abstract class AbstractAdapter
{
    use ParameterTrait;

    /**
     * Sandbox environment.
     *
     * @var bool
     */
    protected $sandbox;

    /**
     * Constructor.
     *
     * @param array $parameters
     * @param bool  $sandbox
     *
     * @throws \Jgut\Tify\Exception\AdapterException
     */
    public function __construct(array $parameters = [], $sandbox = false)
    {
        $parametersResolver = new OptionsResolver();

        $parametersResolver->setDefined($this->getDefinedParameters());
        $parametersResolver->setDefaults($this->getDefaultParameters());
        $parametersResolver->setRequired($this->getRequiredParameters());

        try {
            $this->parameters = new ArrayCollection($parametersResolver->resolve($parameters));
        } catch (MissingOptionsException $exception) {
            throw new AdapterException(sprintf('Missing parameters on "%s"', self::class));
        } catch (\Exception $exception) {
            throw new AdapterException('Invalid parameter provided');
        }

        $this->sandbox = (bool) $sandbox;
    }

    /**
     * Retrieve if sandbox.
     *
     * @return bool
     */
    public function isSandbox()
    {
        return (bool) $this->sandbox;
    }

    /**
     * Set Sandbox.
     *
     * @param bool $sandbox
     *
     * @return $this
     */
    public function setSandbox($sandbox)
    {
        $this->sandbox = (bool) $sandbox;

        return $this;
    }

    /**
     * Get the list of defined parameters.
     *
     * @return array
     */
    protected function getDefinedParameters()
    {
        return [];
    }

    /**
     * Get the list of default parameters.
     *
     * @return array
     */
    protected function getDefaultParameters()
    {
        return [];
    }

    /**
     * Get the list of required parameters.
     *
     * @return array
     */
    protected function getRequiredParameters()
    {
        return [];
    }
}