Issues in ShowResponse.php - New Issues - Inspection of "(WIP) Routes API" - mailgun/mailgun-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#249)

by David

created 2016-12-08 23:58 UTC

Resource/Api/Routes/Response/ShowResponse.php (2 issues)

Labels

Severity

Major 2

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

/*
 * Copyright (C) 2013-2016 Mailgun
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Mailgun\Resource\Api\Routes\Response;

use Mailgun\Resource\Api\Routes\Dto\RouteDto;
use Mailgun\Resource\ApiResponse;

/**
 * @author David Garcia <[email protected]>
 */
final class ShowResponse implements ApiResponse
{
    /**
     * Create an API response object from the HTTP response from the API server.
     *
     * @param array $data
     *
     * @return RouteDto
     */
    public static function create(array $data)
    {
        if (isset($data['route'])) {
            return RouteDto::create($data['route']);
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 RouteDto::create([]);
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());
}
    }
}


1			<?php
2
3			/*
4			* Copyright (C) 2013-2016 Mailgun
5			*
6			* This software may be modified and distributed under the terms
7			* of the MIT license. See the LICENSE file for details.
8			*/
9
10			namespace Mailgun\Resource\Api\Routes\Response;
11
12			use Mailgun\Resource\Api\Routes\Dto\RouteDto;
13			use Mailgun\Resource\ApiResponse;
14
15			/**
16			* @author David Garcia <[email protected]>
17			*/
18			final class ShowResponse implements ApiResponse
19			{
20			/**
21			* Create an API response object from the HTTP response from the API server.
22			*
23			* @param array $data
24			*
25			* @return RouteDto
26			*/
27			public static function create(array $data)
28			{
29			if (isset($data['route'])) {
30			return RouteDto::create($data['route']);
			0 ignored issues – show Bug Best Practice introduced 2016-12-08 23:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return \Mailgun\Resource...create($data['route']);` (`Mailgun\Resource\Api\Routes\Dto\RouteDto`) is incompatible with the return type declared by the interface `Mailgun\Resource\ApiResponse::create` of type `Mailgun\Resource\ApiResponse`. 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...
31			}
32
33			return RouteDto::create([]);
			0 ignored issues – show Bug Best Practice introduced 2016-12-08 23:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return \Mailgun\Resource...teDto::create(array());` (`Mailgun\Resource\Api\Routes\Dto\RouteDto`) is incompatible with the return type declared by the interface `Mailgun\Resource\ApiResponse::create` of type `Mailgun\Resource\ApiResponse`. 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...
34			}
35			}
36

mailgun / mailgun-php

Pull Request — master (#249)

Resource/Api/Routes/Response/ShowResponse.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like