Issues in CollectionAdapter.php - Failed Issues - Inspection of "Switch to Chadicus coding standard" - chadicus/marvel-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#25)

by Chad

created 2016-10-08 22:22 UTC

tests/Assets/CollectionAdapter.php (1 issue)

Labels

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
namespace Chadicus\Marvel\Api\Assets;

use Chadicus\Marvel\Api\Adapter\AdapterInterface;
use Chadicus\Marvel\Api\Client;
use Chadicus\Marvel\Api\RequestInterface;
use Chadicus\Marvel\Api\Response;

/**
 * Adapter that returns multiple items.
 */
final class CollectionAdapter implements AdapterInterface
{
    /**
     * Simulate sending a request to the API.
     *
     * @param RequestInterface $request The request.
     *
     * @return ResponseInterface
     */
    public function send(RequestInterface $request)
    {
        $allResults = [
            ['id' => 0, 'title' => 'a title for comic 0', 'resourceURI' => Client::BASE_URL . 'comics/0'],
            ['id' => 1, 'title' => 'a title for comic 1', 'resourceURI' => Client::BASE_URL . 'comics/1'],
            ['id' => 2, 'title' => 'a title for comic 2', 'resourceURI' => Client::BASE_URL . 'comics/2'],
            ['id' => 3, 'title' => 'a title for comic 3', 'resourceURI' => Client::BASE_URL . 'comics/3'],
            ['id' => 4, 'title' => 'a title for comic 4', 'resourceURI' => Client::BASE_URL . 'comics/4'],
        ];

        $queryString = parse_url($request->getUrl(), PHP_URL_QUERY);
        $queryParams = [];
        parse_str($queryString, $queryParams);

        $offset = (int)$queryParams['offset'];
        $limit = (int)$queryParams['limit'];
        $results = array_slice($allResults, $offset, $limit);
        $count = count($results);
        return new Response(
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());
}
            200,
            ['Content-type' => 'application/json', 'etag' => 'an etag'],
            [
                'code' => 200,
                'status' => 'ok',
                'etag' => 'an etag',
                'data' => [
                    'offset' => $offset,
                    'limit' => $limit,
                    'total' => 5,
                    'count' => $count,
                    'results' => $results,
                ],
            ]
        );
    }
}


1			<?php
2			namespace Chadicus\Marvel\Api\Assets;
3
4			use Chadicus\Marvel\Api\Adapter\AdapterInterface;
5			use Chadicus\Marvel\Api\Client;
6			use Chadicus\Marvel\Api\RequestInterface;
7			use Chadicus\Marvel\Api\Response;
8
9			/**
10			* Adapter that returns multiple items.
11			*/
12			final class CollectionAdapter implements AdapterInterface
13			{
14			/**
15			* Simulate sending a request to the API.
16			*
17			* @param RequestInterface $request The request.
18			*
19			* @return ResponseInterface
20			*/
21			public function send(RequestInterface $request)
22			{
23			$allResults = [
24			['id' => 0, 'title' => 'a title for comic 0', 'resourceURI' => Client::BASE_URL . 'comics/0'],
25			['id' => 1, 'title' => 'a title for comic 1', 'resourceURI' => Client::BASE_URL . 'comics/1'],
26			['id' => 2, 'title' => 'a title for comic 2', 'resourceURI' => Client::BASE_URL . 'comics/2'],
27			['id' => 3, 'title' => 'a title for comic 3', 'resourceURI' => Client::BASE_URL . 'comics/3'],
28			['id' => 4, 'title' => 'a title for comic 4', 'resourceURI' => Client::BASE_URL . 'comics/4'],
29			];
30
31			$queryString = parse_url($request->getUrl(), PHP_URL_QUERY);
32			$queryParams = [];
33			parse_str($queryString, $queryParams);
34
35			$offset = (int)$queryParams['offset'];
36			$limit = (int)$queryParams['limit'];
37			$results = array_slice($allResults, $offset, $limit);
38			$count = count($results);
39			return new Response(
			0 ignored issues – show Bug Best Practice introduced 2016-10-08 22:25 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return new \Chadicus\Mar...esults' => $results)));` (`Chadicus\Marvel\Api\Response`) is incompatible with the return type declared by the interface `Chadicus\Marvel\Api\Adapter\AdapterInterface::send` of type `Chadicus\Marvel\Api\Adapter\ResponseInterface`. 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...
40			200,
41			['Content-type' => 'application/json', 'etag' => 'an etag'],
42			[
43			'code' => 200,
44			'status' => 'ok',
45			'etag' => 'an etag',
46			'data' => [
47			'offset' => $offset,
48			'limit' => $limit,
49			'total' => 5,
50			'count' => $count,
51			'results' => $results,
52			],
53			]
54			);
55			}
56			}
57

chadicus / marvel-api-client

Pull Request — master (#25)

tests/Assets/CollectionAdapter.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like