Transport::send() - Code Metrics - Inspection of "changelog" - flipbox/postmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cada30...88830a )

by Nate

created 2017-05-13 15:17 UTC

Transport::send() B

↳ Parent: Transport

Complexity

Conditions	3
Paths	3

Size

Total Lines	28
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	28
rs	8.8571
cc	3
eloc	11
nc	3
nop	2

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipbox/postmark/blob/master/LICENSE.md
 * @link       https://github.com/flipbox/postmark
 */

namespace flipbox\postmark;

use craft\helpers\Json;
use Psr\Http\Message\ResponseInterface;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class Transport extends \Postmark\Transport
{

    /**
     * {@inheritdoc}
     */
    public function send(\Swift_Mime_Message $message, &$failedRecipients = null)
    {

        /** @var ResponseInterface $response */
        $response = parent::send($message, $failedRecipients);

        // Check for errors
        if ($response->getStatusCode() !== 200) {

            $error = Json::decodeIfJson(
                $response->getBody()->getContents()
            );

            if (is_array($error)) {
                $error['StatusCode'] = $response->getStatusCode();
            }

            Postmark::error($error);

            return false;
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());
}

        }

        Postmark::info("Email sent successfully via Postmark Adapter.");

        return true;
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 Copyright (c) Flipbox Digital Limited
5			* @license https://github.com/flipbox/postmark/blob/master/LICENSE.md
6			* @link https://github.com/flipbox/postmark
7			*/
8
9			namespace flipbox\postmark;
10
11			use craft\helpers\Json;
12			use Psr\Http\Message\ResponseInterface;
13
14			/**
15			* @author Flipbox Factory <[email protected]>
16			* @since 1.0.0
17			*/
18			class Transport extends \Postmark\Transport
19			{
20
21			/**
22			* {@inheritdoc}
23			*/
24			public function send(\Swift_Mime_Message $message, &$failedRecipients = null)
25			{
26
27			/** @var ResponseInterface $response */
28			$response = parent::send($message, $failedRecipients);
29
30			// Check for errors
31			if ($response->getStatusCode() !== 200) {
32
33			$error = Json::decodeIfJson(
34			$response->getBody()->getContents()
35			);
36
37			if (is_array($error)) {
38			$error['StatusCode'] = $response->getStatusCode();
39			}
40
41			Postmark::error($error);
42
43			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-05-13 15:19 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Swift_Transport::send` of type `integer`. 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...
44
45			}
46
47			Postmark::info("Email sent successfully via Postmark Adapter.");
48
49			return true;
			0 ignored issues – show Bug Best Practice introduced 2017-05-13 15:19 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type declared by the interface `Swift_Transport::send` of type `integer`. 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...
50
51			}
52
53			}
54

flipbox / postmark

Push — master ( cada30...88830a )

Transport::send() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like