PaginatedListResource::getIterator() - Code Metrics - prgTW/basecrm-php-api - Measure and Improve Code Quality continuously with Scrutinizer

PaginatedListResource::getIterator() A
last analyzed 2016-08-09 08:15 UTC

↳ Parent: PaginatedListResource

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
c	3
b	1
f	0
dl	0
loc	6
rs	9.4285
cc	2
eloc	3
nc	2
nop	2

<?php

namespace prgTW\BaseCRM\Resource;

abstract class PaginatedListResource extends ListResource
{
	/** @var bool */
	protected $autoPagination = false;

	/**
	 * @return bool
	 */
	public function getAutoPagination()
	{
		return $this->autoPagination;
	}

	/**
	 * @param bool $autoPagination
	 *
	 * @return $this
	 */
	public function setAutoPagination($autoPagination)
	{
		$this->autoPagination = $autoPagination;

		return $this;
	}

	/**
	 * @param int   $page
	 * @param array $query
	 *
	 * @return Page

	 */
	public function getPage($page = 1, array $query = [])
	{
		$query = array_merge_recursive($query, [
			'page' => $page,
		]);

		return parent::all($query);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}

	/** {@inheritdoc} */
	protected function postAll(array $data)
	{
		$childResourceName = $this->getChildResourceName();

		if (array_key_exists('items', $data))
		{
			foreach ($data['items'] as $key => $resourceData)
			{
				$data['items'][$key] = $this->getObjectFromArray($resourceData[$childResourceName]);
			}
		}
		else
		{
			foreach ($data as $key => $resourceData)
			{
				$data[$key] = $this->getObjectFromArray($resourceData[$childResourceName]);
			}
		}

		return new Page($data);
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());
}
	}

	/** {@inheritdoc} */
	public function count()
	{
		//@codeCoverageIgnoreStart
		throw new \BadMethodCallException('Not allowed');
		//@codeCoverageIgnoreEnd
	}

	/**
	 * @param int   $page
	 * @param array $query
	 *
	 * @return AutoPagingIterator|PagingIterator
	 */
	public function getIterator($page = 1, array $query = [])
	{
		$iteratorClass = true === $this->autoPagination ? AutoPagingIterator::class : PagingIterator::class;

		return new $iteratorClass([$this, 'getPage'], $page, $query);
	}
}


1			<?php
2
3			namespace prgTW\BaseCRM\Resource;
4
5			abstract class PaginatedListResource extends ListResource
6			{
7			/** @var bool */
8			protected $autoPagination = false;
9
10			/**
11			* @return bool
12			*/
13			public function getAutoPagination()
14			{
15			return $this->autoPagination;
16			}
17
18			/**
19			* @param bool $autoPagination
20			*
21			* @return $this
22			*/
23			public function setAutoPagination($autoPagination)
24			{
25			$this->autoPagination = $autoPagination;
26
27			return $this;
28			}
29
30			/**
31			* @param int $page
32			* @param array $query
33			*
34			* @return Page
			0 ignored issues – show Documentation introduced 2016-08-09 08:15 UTC by Report Bug Copy Issue Report Should the return type not be `ResourceCollection`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
35			*/
36			public function getPage($page = 1, array $query = [])
37			{
38			$query = array_merge_recursive($query, [
39			'page' => $page,
40			]);
41
42			return parent::all($query);
			0 ignored issues – show Comprehensibility Bug introduced 2016-08-09 08:15 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`all()` instead of `getPage()`). Are you sure this is correct? If so, you might want to change this to `$this->all()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
43			}
44
45			/** {@inheritdoc} */
46			protected function postAll(array $data)
47			{
48			$childResourceName = $this->getChildResourceName();
49
50			if (array_key_exists('items', $data))
51			{
52			foreach ($data['items'] as $key => $resourceData)
53			{
54			$data['items'][$key] = $this->getObjectFromArray($resourceData[$childResourceName]);
55			}
56			}
57			else
58			{
59			foreach ($data as $key => $resourceData)
60			{
61			$data[$key] = $this->getObjectFromArray($resourceData[$childResourceName]);
62			}
63			}
64
65			return new Page($data);
			0 ignored issues – show Bug Best Practice introduced 2016-08-09 08:15 UTC by Report Bug Copy Issue Report The return type of `return new \prgTW\BaseCRM\Resource\Page($data);` (`prgTW\BaseCRM\Resource\Page`) is incompatible with the return type of the parent method `prgTW\BaseCRM\Resource\ListResource::postAll` of type `prgTW\BaseCRM\Resource\ResourceCollection`. 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...
66			}
67
68			/** {@inheritdoc} */
69			public function count()
70			{
71			//@codeCoverageIgnoreStart
72			throw new \BadMethodCallException('Not allowed');
73			//@codeCoverageIgnoreEnd
74			}
75
76			/**
77			* @param int $page
78			* @param array $query
79			*
80			* @return AutoPagingIterator\|PagingIterator
81			*/
82			public function getIterator($page = 1, array $query = [])
83			{
84			$iteratorClass = true === $this->autoPagination ? AutoPagingIterator::class : PagingIterator::class;
85
86			return new $iteratorClass([$this, 'getPage'], $page, $query);
87			}
88			}
89

prgTW / basecrm-php-api

GitHub Access Token became invalid

PaginatedListResource::getIterator() A last analyzed 2016-08-09 08:15 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PaginatedListResource::getIterator() A
last analyzed 2016-08-09 08:15 UTC