StringMessage::__construct() - Code Metrics - appserver-io/messaging - Measure and Improve Code Quality continuously with Scrutinizer

StringMessage::__construct() A
last analyzed 2018-07-18 09:55 UTC

↳ Parent: StringMessage

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	16
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	2.0116

Importance

Changes

Metric	Value
dl	16
loc	16
ccs	6
cts	7
cp	0.8571
rs	9.7333
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2.0116

<?php

/**
 * AppserverIo\Messaging\StringMessage
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/messaging
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Messaging;

use Rhumsaa\Uuid\Uuid;

/**
 * The implementation for sending a message containing
 * data encapsulated in a string.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/messaging
 * @link      http://www.appserver.io
 */
class StringMessage extends AbstractMessage

{

    /**
     * The message id as hash value.
     *
     * @var string
     */
    protected $messageId = null;

    /**
     * The message itself.
     *
     * @var string
     */
    protected $message = null;

    /**
     * Initializes the message with the String
     * to send to the queue.
     *
     * @param string $message The string with the data to send
     *
     * @throws \Exception Is thrown if the passed message is not a valid string value
     */
    public function __construct($message)
    {

        // call parent constructor
        parent::__construct();

        // check if we've an string passed
        if (is_string($message) === false) {
            throw new \Exception(sprintf('Message \'%s\' is not a valid string', $message));
        }

        // initialize the String sent with the message
        $this->message = $message;
        // initialize the message-ID
        $this->messageId = Uuid::uuid4()->__toString();
    }

    /**
     * Returns the unique message-ID.
     *
     * @return string The unique message-ID
     */
    public function getMessageId()
    {
        return $this->messageId;
    }

    /**
     * The message itself.
     *
     * @return string The message itself
     */
    public function getMessage()
    {
        return $this->message;
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());
}
    }

    /**
     * Returns the message as string.
     *
     * @return string The message as string
     */
    public function __toString()
    {
        return $this->message;
    }
}


1			<?php
2
3			/**
4			* AppserverIo\Messaging\StringMessage
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2015 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link https://github.com/appserver-io/messaging
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Messaging;
22
23			use Rhumsaa\Uuid\Uuid;
24
25			/**
26			* The implementation for sending a message containing
27			* data encapsulated in a string.
28			*
29			* @author Tim Wagner <[email protected]>
30			* @copyright 2015 TechDivision GmbH <[email protected]>
31			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
32			* @link https://github.com/appserver-io/messaging
33			* @link http://www.appserver.io
34			*/
35		View Code Duplication	class StringMessage extends AbstractMessage
			0 ignored issues – show Duplication introduced 2016-03-14 13:18 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36			{
37
38			/**
39			* The message id as hash value.
40			*
41			* @var string
42			*/
43			protected $messageId = null;
44
45			/**
46			* The message itself.
47			*
48			* @var string
49			*/
50			protected $message = null;
51
52			/**
53			* Initializes the message with the String
54			* to send to the queue.
55			*
56			* @param string $message The string with the data to send
57			*
58			* @throws \Exception Is thrown if the passed message is not a valid string value
59			*/
60	1		public function __construct($message)
61			{
62
63			// call parent constructor
64	1		parent::__construct();
65
66			// check if we've an string passed
67	1		if (is_string($message) === false) {
68			throw new \Exception(sprintf('Message \'%s\' is not a valid string', $message));
69			}
70
71			// initialize the String sent with the message
72	1		$this->message = $message;
73			// initialize the message-ID
74	1		$this->messageId = Uuid::uuid4()->__toString();
75	1		}
76
77			/**
78			* Returns the unique message-ID.
79			*
80			* @return string The unique message-ID
81			*/
82			public function getMessageId()
83			{
84			return $this->messageId;
85			}
86
87			/**
88			* The message itself.
89			*
90			* @return string The message itself
91			*/
92			public function getMessage()
93			{
94			return $this->message;
			0 ignored issues – show Bug Best Practice introduced 2016-03-14 13:18 UTC by Report Bug Copy Issue Report The return type of `return $this->message;` (`string`) is incompatible with the return type declared by the interface `AppserverIo\Psr\Pms\MessageInterface::getMessage` of type `object`. 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...
95			}
96
97			/**
98			* Returns the message as string.
99			*
100			* @return string The message as string
101			*/
102			public function __toString()
103			{
104			return $this->message;
105			}
106			}
107

appserver-io / messaging

StringMessage::__construct() A last analyzed 2018-07-18 09:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

StringMessage::__construct() A
last analyzed 2018-07-18 09:55 UTC