iDokladAbstractFunction - Code Metrics - Inspection of "Support for locales" - Fousky/iDoklad - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( abcfe0...b389f0 )

by Lukáš

created 2018-03-22 19:44 UTC

iDokladAbstractFunction A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	276
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	2

Importance

Changes

Metric	Value
wmc	26
lcom	3
cbo	2
dl	0
loc	276
rs	10
c	0
b	0
f	0

18 Methods

Rating	Name	Size	Complexity
A	paginator()	6	1
A	sortable()	6	1
A	filter()	6	1
A	injectAccessTokenToHeaders()	4	1
A	handleResponse()	4	1
A	createModel()	14	3
B	validate()	22	4
B	assertConfiguration()	27	1
A	setConfig()	6	1
A	hasSortable()	4	1
A	getSortable()	11	2
A	setSortable()	4	1
A	hasPaginator()	4	1
A	getPaginator()	11	2
A	setPaginator()	4	1
A	hasFilter()	4	1
A	getFilter()	11	2
A	setFilter()	4	1

<?php

namespace Fousky\Component\iDoklad\Functions;

use Fousky\Component\iDoklad\Exception\InvalidModelException;
use Fousky\Component\iDoklad\Model\iDokladAbstractModel;
use Fousky\Component\iDoklad\Model\iDokladModelInterface;
use Fousky\Component\iDoklad\UrlExtension\iDokladFilter;
use Fousky\Component\iDoklad\UrlExtension\iDokladPaginator;
use Fousky\Component\iDoklad\UrlExtension\iDokladSortable;
use Psr\Http\Message\ResponseInterface;
use Symfony\Component\OptionsResolver\Exception\ExceptionInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * @author Lukáš Brzák <[email protected]>
 */
abstract class iDokladAbstractFunction implements iDokladFunctionInterface
{
    /** @var ResponseInterface|null $response */
    protected $response;

    /** @var array $config */
    protected $config;

    /** @var null|iDokladFilter $filter */
    protected $filter;

    /** @var null|iDokladPaginator $paginator */
    protected $paginator;

    /** @var null|iDokladSortable $sortable */
    protected $sortable;

    /**
     * @param iDokladPaginator $paginator
     *
     * @return iDokladAbstractFunction
     */
    public function paginator(iDokladPaginator $paginator): self
    {
        $this->setPaginator($paginator);

        return $this;
    }

    /**
     * @param iDokladSortable $sortable
     *
     * @return iDokladAbstractFunction
     */
    public function sortable(iDokladSortable $sortable): self
    {
        $this->setSortable($sortable);

        return $this;
    }

    /**
     * @param iDokladFilter $filter
     *
     * @return $this
     */
    public function filter(iDokladFilter $filter)
    {
        $this->setFilter($filter);

        return $this;
    }

    /**
     * @return bool
     */
    public function injectAccessTokenToHeaders(): bool
    {
        return true;
    }

    /**
     * Handle response from iDoklad and create model instance.
     *
     * @param ResponseInterface $response
     *
     * @throws \InvalidArgumentException
     * @throws \Fousky\Component\iDoklad\Exception\InvalidResponseException
     * @throws \ReflectionException
     *
     * @return iDokladModelInterface
     */
    public function handleResponse(ResponseInterface $response): iDokladModelInterface
    {
        return $this->createModel($this->getModelClass(), $response);
    }

    /**
     * @param string|iDokladModelInterface $modelClass
     * @param ResponseInterface            $response
     *
     * @throws \ReflectionException
     * @throws \InvalidArgumentException
     * @throws \Fousky\Component\iDoklad\Exception\InvalidResponseException
     *
     * @return iDokladModelInterface
     */
    protected function createModel($modelClass, ResponseInterface $response): iDokladModelInterface
    {
        if (!class_exists($modelClass) ||
            !(new \ReflectionClass($modelClass))->implementsInterface(iDokladModelInterface::class)
        ) {
            throw new \InvalidArgumentException(sprintf(
                'Class %s not exists or does not implements interface %s',
                $modelClass,
                iDokladModelInterface::class
            ));
        }

        return $modelClass::createFromResponse($response);
    }

    /**
     * @param iDokladAbstractModel $model
     *
     * @throws InvalidModelException
     */
    protected function validate(iDokladAbstractModel $model)
    {
        try {
            $errorList = $model->validate();
        } catch (\Throwable $e) {
            throw new InvalidModelException([$e->getMessage()]);
        }

        if (0 === $errorList->count()) {
            return;
        }

        $errors = [
            sprintf('Model class %s has following errors:', \get_class($model)),
        ];

        foreach ($errorList as $error) {
            $errors[] = sprintf('- %s: %s', $error->getPropertyPath(), $error->getMessage());
        }

        throw new InvalidModelException($errors);
    }

    /**
     * @param array $config
     *
     * @throws ExceptionInterface
     *
     * @return array
     */
    public static function assertConfiguration(array $config): array
    {
        return (new OptionsResolver())
            ->setDefaults([
                'debug' => false,
                'url' => 'https://app.idoklad.cz/developer/api/v2/',
                'token_endpoint' => 'https://app.idoklad.cz/identity/server/connect/token',
                'scope' => 'idoklad_api',
                // iDoklad sends DateTime in UTC, so we tranform to another PHP \DateTimeZone
                'timezone' => 'Europe/Prague',
                // iDoklad generates invoices in available locales: ['cs-CZ', 'sk-SK', 'de-DE', 'en-US']

                'language' => 'cs-CZ',
            ])
            ->setRequired([
                'client_id',
                'client_secret',
            ])
            ->setAllowedTypes('debug', ['boolean'])
            ->setAllowedTypes('url', ['string'])
            ->setAllowedTypes('client_id', ['string'])
            ->setAllowedTypes('client_secret', ['string'])
            ->setAllowedTypes('token_endpoint', ['string'])
            ->setAllowedTypes('scope', ['string'])
            ->setAllowedTypes('language', ['string'])
            ->setAllowedValues('language', ['cs-CZ', 'sk-SK', 'de-DE', 'en-US'])
            ->resolve($config);
    }

    /**
     * @param array $config
     *
     * @return iDokladFunctionInterface
     */
    public function setConfig(array $config): iDokladFunctionInterface
    {
        $this->config = $config;

        return $this;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @return bool
     */
    public function hasSortable(): bool
    {
        return null !== $this->sortable;
    }

    /**
     * @throws \RuntimeException
     *
     * @return iDokladSortable
     */
    public function getSortable(): iDokladSortable
    {
        if (null === $this->sortable) {
            throw new \RuntimeException(sprintf(
                'Function %s does not have iDokladSortable instance.',
                __CLASS__
            ));
        }

        return $this->sortable;
    }

    /**
     * @param null|iDokladSortable $sortable
     */
    public function setSortable(iDokladSortable $sortable = null)
    {
        $this->sortable = $sortable;
    }

    /**
     * @return bool
     */
    public function hasPaginator(): bool
    {
        return null !== $this->paginator;
    }

    /**
     * @throws \RuntimeException
     *
     * @return iDokladPaginator
     */
    public function getPaginator(): iDokladPaginator
    {
        if (null === $this->paginator) {
            throw new \RuntimeException(sprintf(
                'Function %s does not have iDokladPaginator instance.',
                __CLASS__
            ));
        }

        return $this->paginator;
    }

    /**
     * @param null|iDokladPaginator $paginator
     */
    public function setPaginator(iDokladPaginator $paginator = null)
    {
        $this->paginator = $paginator;
    }

    /**
     * @return bool
     */
    public function hasFilter(): bool
    {
        return null !== $this->filter;
    }

    /**
     * @throws \RuntimeException
     *
     * @return iDokladFilter
     */
    public function getFilter(): iDokladFilter
    {
        if (null === $this->filter) {
            throw new \RuntimeException(sprintf(
                'Function %s does not have iDokladFilter instance.',
                __CLASS__
            ));
        }

        return $this->filter;
    }

    /**
     * @param null|iDokladFilter $filter
     */
    public function setFilter(iDokladFilter $filter = null)
    {
        $this->filter = $filter;
    }
}


1			<?php
2
3			namespace Fousky\Component\iDoklad\Functions;
4
5			use Fousky\Component\iDoklad\Exception\InvalidModelException;
6			use Fousky\Component\iDoklad\Model\iDokladAbstractModel;
7			use Fousky\Component\iDoklad\Model\iDokladModelInterface;
8			use Fousky\Component\iDoklad\UrlExtension\iDokladFilter;
9			use Fousky\Component\iDoklad\UrlExtension\iDokladPaginator;
10			use Fousky\Component\iDoklad\UrlExtension\iDokladSortable;
11			use Psr\Http\Message\ResponseInterface;
12			use Symfony\Component\OptionsResolver\Exception\ExceptionInterface;
13			use Symfony\Component\OptionsResolver\OptionsResolver;
14
15			/**
16			* @author Lukáš Brzák <[email protected]>
17			*/
18			abstract class iDokladAbstractFunction implements iDokladFunctionInterface
19			{
20			/** @var ResponseInterface\|null $response */
21			protected $response;
22
23			/** @var array $config */
24			protected $config;
25
26			/** @var null\|iDokladFilter $filter */
27			protected $filter;
28
29			/** @var null\|iDokladPaginator $paginator */
30			protected $paginator;
31
32			/** @var null\|iDokladSortable $sortable */
33			protected $sortable;
34
35			/**
36			* @param iDokladPaginator $paginator
37			*
38			* @return iDokladAbstractFunction
39			*/
40			public function paginator(iDokladPaginator $paginator): self
41			{
42			$this->setPaginator($paginator);
43
44			return $this;
45			}
46
47			/**
48			* @param iDokladSortable $sortable
49			*
50			* @return iDokladAbstractFunction
51			*/
52			public function sortable(iDokladSortable $sortable): self
53			{
54			$this->setSortable($sortable);
55
56			return $this;
57			}
58
59			/**
60			* @param iDokladFilter $filter
61			*
62			* @return $this
63			*/
64			public function filter(iDokladFilter $filter)
65			{
66			$this->setFilter($filter);
67
68			return $this;
69			}
70
71			/**
72			* @return bool
73			*/
74			public function injectAccessTokenToHeaders(): bool
75			{
76			return true;
77			}
78
79			/**
80			* Handle response from iDoklad and create model instance.
81			*
82			* @param ResponseInterface $response
83			*
84			* @throws \InvalidArgumentException
85			* @throws \Fousky\Component\iDoklad\Exception\InvalidResponseException
86			* @throws \ReflectionException
87			*
88			* @return iDokladModelInterface
89			*/
90			public function handleResponse(ResponseInterface $response): iDokladModelInterface
91			{
92			return $this->createModel($this->getModelClass(), $response);
93			}
94
95			/**
96			* @param string\|iDokladModelInterface $modelClass
97			* @param ResponseInterface $response
98			*
99			* @throws \ReflectionException
100			* @throws \InvalidArgumentException
101			* @throws \Fousky\Component\iDoklad\Exception\InvalidResponseException
102			*
103			* @return iDokladModelInterface
104			*/
105			protected function createModel($modelClass, ResponseInterface $response): iDokladModelInterface
106			{
107			if (!class_exists($modelClass) \|\|
108			!(new \ReflectionClass($modelClass))->implementsInterface(iDokladModelInterface::class)
109			) {
110			throw new \InvalidArgumentException(sprintf(
111			'Class %s not exists or does not implements interface %s',
112			$modelClass,
113			iDokladModelInterface::class
114			));
115			}
116
117			return $modelClass::createFromResponse($response);
118			}
119
120			/**
121			* @param iDokladAbstractModel $model
122			*
123			* @throws InvalidModelException
124			*/
125			protected function validate(iDokladAbstractModel $model)
126			{
127			try {
128			$errorList = $model->validate();
129			} catch (\Throwable $e) {
130			throw new InvalidModelException([$e->getMessage()]);
131			}
132
133			if (0 === $errorList->count()) {
134			return;
135			}
136
137			$errors = [
138			sprintf('Model class %s has following errors:', \get_class($model)),
139			];
140
141			foreach ($errorList as $error) {
142			$errors[] = sprintf('- %s: %s', $error->getPropertyPath(), $error->getMessage());
143			}
144
145			throw new InvalidModelException($errors);
146			}
147
148			/**
149			* @param array $config
150			*
151			* @throws ExceptionInterface
152			*
153			* @return array
154			*/
155			public static function assertConfiguration(array $config): array
156			{
157			return (new OptionsResolver())
158			->setDefaults([
159			'debug' => false,
160			'url' => 'https://app.idoklad.cz/developer/api/v2/',
161			'token_endpoint' => 'https://app.idoklad.cz/identity/server/connect/token',
162			'scope' => 'idoklad_api',
163			// iDoklad sends DateTime in UTC, so we tranform to another PHP \DateTimeZone
164			'timezone' => 'Europe/Prague',
165			// iDoklad generates invoices in available locales: ['cs-CZ', 'sk-SK', 'de-DE', 'en-US']
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-03-22 19:46 UTC by Report Bug Copy Issue Report `36%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
166			'language' => 'cs-CZ',
167			])
168			->setRequired([
169			'client_id',
170			'client_secret',
171			])
172			->setAllowedTypes('debug', ['boolean'])
173			->setAllowedTypes('url', ['string'])
174			->setAllowedTypes('client_id', ['string'])
175			->setAllowedTypes('client_secret', ['string'])
176			->setAllowedTypes('token_endpoint', ['string'])
177			->setAllowedTypes('scope', ['string'])
178			->setAllowedTypes('language', ['string'])
179			->setAllowedValues('language', ['cs-CZ', 'sk-SK', 'de-DE', 'en-US'])
180			->resolve($config);
181			}
182
183			/**
184			* @param array $config
185			*
186			* @return iDokladFunctionInterface
187			*/
188			public function setConfig(array $config): iDokladFunctionInterface
189			{
190			$this->config = $config;
191
192			return $this;
			0 ignored issues – show Bug Best Practice introduced 2017-11-10 03:46 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Fousky\Component\iDoklad...iDokladAbstractFunction`) is incompatible with the return type declared by the interface `Fousky\Component\iDoklad...ionInterface::setConfig` of type `self`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
193			}
194
195			/**
196			* @return bool
197			*/
198			public function hasSortable(): bool
199			{
200			return null !== $this->sortable;
201			}
202
203			/**
204			* @throws \RuntimeException
205			*
206			* @return iDokladSortable
207			*/
208			public function getSortable(): iDokladSortable
209			{
210			if (null === $this->sortable) {
211			throw new \RuntimeException(sprintf(
212			'Function %s does not have iDokladSortable instance.',
213			__CLASS__
214			));
215			}
216
217			return $this->sortable;
218			}
219
220			/**
221			* @param null\|iDokladSortable $sortable
222			*/
223			public function setSortable(iDokladSortable $sortable = null)
224			{
225			$this->sortable = $sortable;
226			}
227
228			/**
229			* @return bool
230			*/
231			public function hasPaginator(): bool
232			{
233			return null !== $this->paginator;
234			}
235
236			/**
237			* @throws \RuntimeException
238			*
239			* @return iDokladPaginator
240			*/
241			public function getPaginator(): iDokladPaginator
242			{
243			if (null === $this->paginator) {
244			throw new \RuntimeException(sprintf(
245			'Function %s does not have iDokladPaginator instance.',
246			__CLASS__
247			));
248			}
249
250			return $this->paginator;
251			}
252
253			/**
254			* @param null\|iDokladPaginator $paginator
255			*/
256			public function setPaginator(iDokladPaginator $paginator = null)
257			{
258			$this->paginator = $paginator;
259			}
260
261			/**
262			* @return bool
263			*/
264			public function hasFilter(): bool
265			{
266			return null !== $this->filter;
267			}
268
269			/**
270			* @throws \RuntimeException
271			*
272			* @return iDokladFilter
273			*/
274			public function getFilter(): iDokladFilter
275			{
276			if (null === $this->filter) {
277			throw new \RuntimeException(sprintf(
278			'Function %s does not have iDokladFilter instance.',
279			__CLASS__
280			));
281			}
282
283			return $this->filter;
284			}
285
286			/**
287			* @param null\|iDokladFilter $filter
288			*/
289			public function setFilter(iDokladFilter $filter = null)
290			{
291			$this->filter = $filter;
292			}
293			}
294

Fousky / iDoklad

Push — master ( abcfe0...b389f0 )

iDokladAbstractFunction A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

Duplication Side-by-Side

Filter issues like