Message::getMessageType() - Code Metrics - Inspection of ":bug: Bugfix." - overtrue/easy-sms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b7696d...79d94c )

by Carlos

created 2017-04-28 13:19 UTC

Message::getMessageType() A

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the overtrue/easy-sms.
 * (c) overtrue <[email protected]>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Overtrue\EasySms;

use Overtrue\EasySms\Contracts\MessageInterface;

/**
 * Class Message.
 */
class Message implements MessageInterface
{
    /**
     * @var array
     */
    protected $gateways = [];

    /**
     * @var string
     */
    protected $type;

    /**
     * @var string
     */
    protected $content;

    /**
     * @var string
     */
    protected $template;

    /**
     * @var array
     */
    protected $data = [];

    /**
     * Message constructor.
     *
     * @param array  $attributes
     * @param string $type
     */
    public function __construct(array $attributes = [], $type = MessageInterface::TEXT_MESSAGE)
    {
        $this->type = $type;

        foreach ($attributes as $property => $value) {
            if (property_exists($this, $property)) {
                $this->$property = $value;
            }
        }
    }

    /**
     * Return the message type.
     *
     * @return string
     */
    public function getMessageType()
    {
        return $this->type;
    }

    /**
     * Return message content.
     *
     * @return string
     */
    public function getContent()
    {
        return $this->content;
    }

    /**
     * Return the template id of message.
     *
     * @return string
     */
    public function getTemplate()
    {
        return $this->template;
    }

    /**
     * @param string $type
     *
     * @return $this
     */
    public function setType(string $type)
    {
        $this->type = $type;

        return $this;
    }

    /**
     * @param mixed $content
     *
     * @return $this
     */
    public function setContent($content)
    {
        $this->content = $content;

        return $this;
    }

    /**
     * @param mixed $template
     *
     * @return $this
     */
    public function setTemplate($template)
    {
        $this->template = $template;

        return $this;
    }

    /**
     * @return array
     */
    public function getData()
    {
        return $this->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());
}
    }

    /**
     * @param array $data
     *
     * @return $this
     */
    public function setData(array $data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * @return array
     */
    public function getGateways()
    {
        return $this->gateways;
    }

    /**
     * @param array $gateways
     *
     * @return $this
     */
    public function setGateways(array $gateways)
    {
        $this->gateways = $gateways;

        return $this;
    }

    /**
     * @param $property
     *
     * @return string
     */
    public function __get($property)
    {
        if (property_exists($this, $property)) {
            return $this->$property;
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the overtrue/easy-sms.
5			* (c) overtrue <[email protected]>
6			* This source file is subject to the MIT license that is bundled
7			* with this source code in the file LICENSE.
8			*/
9
10			namespace Overtrue\EasySms;
11
12			use Overtrue\EasySms\Contracts\MessageInterface;
13
14			/**
15			* Class Message.
16			*/
17			class Message implements MessageInterface
18			{
19			/**
20			* @var array
21			*/
22			protected $gateways = [];
23
24			/**
25			* @var string
26			*/
27			protected $type;
28
29			/**
30			* @var string
31			*/
32			protected $content;
33
34			/**
35			* @var string
36			*/
37			protected $template;
38
39			/**
40			* @var array
41			*/
42			protected $data = [];
43
44			/**
45			* Message constructor.
46			*
47			* @param array $attributes
48			* @param string $type
49			*/
50			public function __construct(array $attributes = [], $type = MessageInterface::TEXT_MESSAGE)
51			{
52			$this->type = $type;
53
54			foreach ($attributes as $property => $value) {
55			if (property_exists($this, $property)) {
56			$this->$property = $value;
57			}
58			}
59			}
60
61			/**
62			* Return the message type.
63			*
64			* @return string
65			*/
66			public function getMessageType()
67			{
68			return $this->type;
69			}
70
71			/**
72			* Return message content.
73			*
74			* @return string
75			*/
76			public function getContent()
77			{
78			return $this->content;
79			}
80
81			/**
82			* Return the template id of message.
83			*
84			* @return string
85			*/
86			public function getTemplate()
87			{
88			return $this->template;
89			}
90
91			/**
92			* @param string $type
93			*
94			* @return $this
95			*/
96			public function setType(string $type)
97			{
98			$this->type = $type;
99
100			return $this;
101			}
102
103			/**
104			* @param mixed $content
105			*
106			* @return $this
107			*/
108			public function setContent($content)
109			{
110			$this->content = $content;
111
112			return $this;
113			}
114
115			/**
116			* @param mixed $template
117			*
118			* @return $this
119			*/
120			public function setTemplate($template)
121			{
122			$this->template = $template;
123
124			return $this;
125			}
126
127			/**
128			* @return array
129			*/
130			public function getData()
131			{
132			return $this->data;
			0 ignored issues – show Bug Best Practice introduced 2017-04-28 13:15 UTC by Report Bug Copy Issue Report The return type of `return $this->data;` (`array`) is incompatible with the return type declared by the interface `Overtrue\EasySms\Contrac...ssageInterface::getData` of type `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 '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...
133			}
134
135			/**
136			* @param array $data
137			*
138			* @return $this
139			*/
140			public function setData(array $data)
141			{
142			$this->data = $data;
143
144			return $this;
145			}
146
147			/**
148			* @return array
149			*/
150			public function getGateways()
151			{
152			return $this->gateways;
153			}
154
155			/**
156			* @param array $gateways
157			*
158			* @return $this
159			*/
160			public function setGateways(array $gateways)
161			{
162			$this->gateways = $gateways;
163
164			return $this;
165			}
166
167			/**
168			* @param $property
169			*
170			* @return string
171			*/
172			public function __get($property)
173			{
174			if (property_exists($this, $property)) {
175			return $this->$property;
176			}
177			}
178			}
179

overtrue / easy-sms

GitHub Access Token became invalid

Push — master ( b7696d...79d94c )

Message::getMessageType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like