Payment::__construct() - Code Metrics - Inspection of "Update buttons" - tgallice/fb-messenger-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#15)

by Gallice

created 2016-10-31 11:44 UTC

Payment::__construct() A

↳ Parent: Payment

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	2
crap	1

<?php

namespace Tgallice\FBMessenger\Model\Button;

use Tgallice\FBMessenger\Model\Button;
use Tgallice\FBMessenger\Model\Button\Payment\PaymentSummary;

class Payment extends Button
{
    /**
     * @var string
     */
    private $title;

    /**
     * @var string
     */
    private $payload;

    /**
     * @var PaymentSummary
     */
    private $paymentSummary;

    /**
     * @param string $payload
     * @param PaymentSummary $paymentSummary
     */
    public function __construct($payload, PaymentSummary $paymentSummary)
    {
        parent::__construct(Button::TYPE_PAYMENT);

        $this->title = 'buy'; // Title must be buy.
        $this->payload = $payload;
        $this->paymentSummary = $paymentSummary;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @return string
     */
    public function getPayload()
    {
        return $this->payload;
    }

    /**
     * @return PaymentSummary
     */
    public function getPaymentSummary()
    {
        return $this->paymentSummary;
    }

    /**
     * @inheritdoc
     */
    function jsonSerialize()

    {
        $json = parent::jsonSerialize();
        $json['title'] = $this->title;
        $json['payload'] = $this->payload;
        $json['payment_summary'] = $this->paymentSummary;

        return $json;
class Author {
    private $name;

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

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

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

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

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

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

}


1		<?php
2
3		namespace Tgallice\FBMessenger\Model\Button;
4
5		use Tgallice\FBMessenger\Model\Button;
6		use Tgallice\FBMessenger\Model\Button\Payment\PaymentSummary;
7
8		class Payment extends Button
9		{
10		/**
11		* @var string
12		*/
13		private $title;
14
15		/**
16		* @var string
17		*/
18		private $payload;
19
20		/**
21		* @var PaymentSummary
22		*/
23		private $paymentSummary;
24
25		/**
26		* @param string $payload
27		* @param PaymentSummary $paymentSummary
28		*/
29	7	public function __construct($payload, PaymentSummary $paymentSummary)
30		{
31	7	parent::__construct(Button::TYPE_PAYMENT);
32
33	7	$this->title = 'buy'; // Title must be buy.
34	7	$this->payload = $payload;
35	7	$this->paymentSummary = $paymentSummary;
36	7	}
37
38		/**
39		* @return string
40		*/
41	1	public function getTitle()
42		{
43	1	return $this->title;
44		}
45
46		/**
47		* @return string
48		*/
49	1	public function getPayload()
50		{
51	1	return $this->payload;
52		}
53
54		/**
55		* @return PaymentSummary
56		*/
57	1	public function getPaymentSummary()
58		{
59	1	return $this->paymentSummary;
60		}
61
62		/**
63		* @inheritdoc
64		*/
65	1	function jsonSerialize()
		0 ignored issues – show Best Practice introduced 2016-10-31 11:47 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
66		{
67	1	$json = parent::jsonSerialize();
68	1	$json['title'] = $this->title;
69	1	$json['payload'] = $this->payload;
70	1	$json['payment_summary'] = $this->paymentSummary;
71
72	1	return $json;
		0 ignored issues – show Best Practice introduced 2016-10-31 11:47 UTC by Report Bug Copy Issue Report The expression `return $json;` seems to be an `array`, but some of its elements' types (`Tgallice\FBMessenger\Mod...\Payment\PaymentSummary`) are incompatible with the return type of the parent method `Tgallice\FBMessenger\Model\Button::jsonSerialize` of type `array<string,string>`. 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 new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return '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...
73		}
74
75		}
76

tgallice / fb-messenger-sdk

GitHub Access Token became invalid

Pull Request — master (#15)

Payment::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like