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

ArrayMessage::__toString() A
last analyzed 2018-07-18 09:55 UTC

↳ Parent: ArrayMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

/**
 * AppserverIo\Messaging\ArrayMessage
 *
 * 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 an array.
 *
 * @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 ArrayMessage extends AbstractMessage
{

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

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

    /**
     * Initializes the message with the array
     * to send to the queue.
     *
     * @param array $message The array with the data to send
     */
    public function __construct(array $message)
    {

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

        // initialize the HashMap 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 array 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 serialize($this->message);
    }
}


1			<?php
2
3			/**
4			* AppserverIo\Messaging\ArrayMessage
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 an array.
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			class ArrayMessage extends AbstractMessage
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 array
49			*/
50			protected $message = null;
51
52			/**
53			* Initializes the message with the array
54			* to send to the queue.
55			*
56			* @param array $message The array with the data to send
57			*/
58			public function __construct(array $message)
59			{
60
61			// call parent constructor
62			parent::__construct();
63
64			// initialize the HashMap sent with the message
65			$this->message = $message;
66			// initialize the message id
67			$this->messageId = Uuid::uuid4()->__toString();
68			}
69
70			/**
71			* Returns the unique message-ID.
72			*
73			* @return string The unique message-ID
74			*/
75			public function getMessageId()
76			{
77			return $this->messageId;
78			}
79
80			/**
81			* The message itself.
82			*
83			* @return array The message itself
84			*/
85			public function getMessage()
86			{
87			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;` (`array`) 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...
88			}
89
90			/**
91			* Returns the message as string.
92			*
93			* @return string The message as string
94			*/
95			public function __toString()
96			{
97			return serialize($this->message);
98			}
99			}
100

appserver-io / messaging

ArrayMessage::__toString() A last analyzed 2018-07-18 09:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ArrayMessage::__toString() A
last analyzed 2018-07-18 09:55 UTC