AbstractMessageBuilder::createMessage() - Code Metrics - Miliooo/MilioooMessageBundle - Measure and Improve Code Quality continuously with Scrutinizer

AbstractMessageBuilder::createMessage() A
last analyzed 2017-02-15 05:46 UTC

↳ Parent: AbstractMessageBuilder

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
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/*
 * This file is part of the MilioooMessageBundle package.
 *
 * (c) Michiel boeckaert <[email protected]>
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Miliooo\Messaging\Builder\Message;

use Miliooo\Messaging\Model\ThreadInterface;
use Miliooo\Messaging\User\ParticipantInterface;
use Miliooo\Messaging\Model\ThreadMetaInterface;
use Miliooo\Messaging\Model\MessageInterface;
use Miliooo\Messaging\Model\MessageMetaInterface;
use Miliooo\Messaging\Model\BuilderInterface;
use Miliooo\Messaging\ValueObjects\ThreadStatus;

/**
 * Description of AbstractMessageBuilder
 *
 * @author Michiel Boeckaert <[email protected]>
 */
abstract class AbstractMessageBuilder
{
    /**
     * Fully qualified namespace of the custom message class
     *
     * @var string
     */
    protected $messageClass;

    /**
     * Fully qualified names of the message meta class
     *
     * @var string
     */
    protected $messageMetaClass;

    /**
     * Fully qualified name of the thread class
     *
     * @var string
     */
    protected $threadClass;

    /**
     * Fully qualified name of the thread meta class
     *
     * @var string
     */
    protected $threadMetaClass;

    /**
     * Sets the message class
     *
     * @param string $messageClass Fully qualified name of message class
     */
    public function setMessageClass($messageClass)
    {
        $this->messageClass = $messageClass;
    }

    /**
     * Sets the message meta class
     *
     * @param string $messageMetaClass Fully qualified name the message meta class
     */
    public function setMessageMetaClass($messageMetaClass)
    {
        $this->messageMetaClass = $messageMetaClass;
    }

    /**
     * Sets the thread class
     *
     * @param string $threadClass Fully qualified name of the thread class
     */
    public function setThreadClass($threadClass)
    {
        $this->threadClass = $threadClass;
    }

    /**
     * Sets the thread meta class
     *
     * @param string $threadMetaClass Fully qualified name of the thread meta class
     */
    public function setThreadMetaClass($threadMetaClass)
    {
        $this->threadMetaClass = $threadMetaClass;
    }

    /**
     * Builds a new message
     *
     * @param ThreadInterface $thread
     */
    protected function buildNewMessage(ThreadInterface $thread)
    {
        //creates a blank message
        $message = $this->createMessage();

        //adds data to the message
        $this->setMessageData($message);

        //adds the thread to the message
        $message->setThread($thread);

        //adds the message to the thread
        $thread->addMessage($message);

        //sets the last message
        $thread->setLastMessage($message);

        //creates message meta
        $this->createMessageMetaForNewMessage($message);
    }

    /**
     * Creates new message meta for the participant
     *
     * @param MessageInterface     $message     The message the meta belongs
     * @param ParticipantInterface $participant The participant in the thread this message belongs to
     *
     * @return MessageMetaInterface
     */
    private function createNewMessageMetaForParticipant(MessageInterface $message, ParticipantInterface $participant)
    {
        //creates an empty message meta object
        $messageMeta = $this->createMessageMeta();

        //adds the message to the message meta
        $messageMeta->setMessage($message);

        //adds the participant to the message meta
        $messageMeta->setParticipant($participant);

        //adds the message meta to the message
        $message->addMessageMeta($messageMeta);

        return $messageMeta;
    }

    /**
     * Updates the message with the message data in the builder model
     *
     * @param MessageInterface $message
     */
    protected function setMessageData(MessageInterface $message)
    {
        $this->processbuilderModel('getMessageData', null, $message);
    }

    /**
     * Updates the message meta for the sender.
     *
     * It processes first the message meta for all participants
     * Then it processes the message meta specific for the sender
     *
     * @param MessageMetaInterface $messageMeta
     */
    protected function updateMessageMetaForSender(MessageMetaInterface $messageMeta)
    {
        $this->processBuilderModel('getMessageMeta', 'all', $messageMeta);
        $this->processBuilderModel('getMessageMeta', 'sender', $messageMeta);
    }

    /**
     * Updates the message meta for the recipient.
     *
     * It processes first the message meta for all participants
     * Then it processes the message meta specific for the recipient.
     *
     * @param MessageMetaInterface $messageMeta
     */
    protected function updateMessageMetaForRecipient(MessageMetaInterface $messageMeta)
    {
        //process the data for all participants
        $this->processBuilderModel('getMessageMeta', 'all', $messageMeta);

        //process the data for the recipients
        $this->processBuilderModel('getMessageMeta', 'recipients', $messageMeta);
    }

    /**
     * Updates the given object with the given methodName and argumentName
     *
     * @param string           $callMethodName     Calls the builder with this methodName
     * @param string|null      $callMethodArgument Calls the builder with this argument for the given methodName
     * @param BuilderInterface $object             The object which gets updated
     */
    protected function processBuilderModel($callMethodName, $callMethodArgument, BuilderInterface $object)
    {
        $data = $this->builderModel->$callMethodName($callMethodArgument);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        if (!$data) {
            return;
        }

        foreach ($data as $key => $value) {
            $setterMethod = $this->getSetter($key, $object);
            $object->$setterMethod($value);
        }
    }

    /**
     * Gets the setter method for the given key.
     *
     * This function tries to find the setter for the given key. By convention this should be setKey.
     *
     * It checks the object if there is a method which is named setKey and if that method is callable (is public)
     * If not it throws an invalidArgumentException
     *
     * @param string $key
     * @param object $object
     *
     * @return string The callable setter method
     *
     * @throws \InvalidArgumentException If no callable setter found
     */
    protected function getSetter($key, $object)
    {
        if (!is_string($key)) {
            throw new \InvalidArgumentException('could not create setter method, no string given');
        }

        //try with setMethodName
        $setMethodName = 'set' . ucFirst($key);

        if (method_exists($object, $setMethodName) && is_callable([$object, $setMethodName])) {
            return $setMethodName;
        }

        throw new \InvalidArgumentException(sprintf('could not find setter for %s', $key));
    }

    /**
     * creates a new message object
     *
     * @return MessageInterface
     */
    private function createMessage()
    {
        return new $this->messageClass;
    }

    /**
     * creates a new message meta object
     *
     * @return MessageMetaInterface
     */
    private function createMessageMeta()
    {
        return new $this->messageMetaClass;
    }

    /**
     * Creates the message meta for a new message.
     *
     * @param MessageInterface $message
     */
    private function createMessageMetaForNewMessage(MessageInterface $message)
    {
        $messageMeta = $this->createNewMessageMetaForParticipant($message, $this->sender);
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->updateMessageMetaForSender($messageMeta);

        foreach ($this->recipients as $recipient) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $messageMeta = $this->createNewMessageMetaForParticipant($message, $recipient);
            $this->updateMessageMetaForRecipient($messageMeta);
        }
    }

    /**
     * Updates the thread meta with settings specific for the sender
     *
     * @param ThreadMetaInterface $threadMeta
     */
    protected function updateThreadMetaForSender(ThreadMetaInterface $threadMeta)
    {
        $this->processBuilderModel('getThreadMeta', 'all', $threadMeta);
        $this->processBuilderModel('getThreadMeta', 'sender', $threadMeta);
    }

    /**
     * Updates the thread meta with the settings specific for the recipient
     *
     * This processes the builder model
     *
     * @param ThreadMetaInterface $threadMeta
     */
    protected function updateThreadMetaForRecipient(ThreadMetaInterface $threadMeta)
    {
        $this->processBuilderModel('getThreadMeta', 'all', $threadMeta);
        $this->processBuilderModel('getThreadMeta', 'recipients', $threadMeta);
        $this->increaseUnreadMessageCountRecipient($threadMeta);
        $this->maybeUpdateThreadStatusForRecipient($threadMeta);
    }

    /**
     * Increases the unread message count for the recipient.
     *
     * Since the recipient has received a new message we need to increase the unread message count for the recipient.
     * When it's a new thread this count should become one.
     * When it's a we should add +1 to the current unread count.
     *
     * @param ThreadMetaInterface $threadMeta
     */
    protected function increaseUnreadMessageCountRecipient(ThreadMetaInterface $threadMeta)
    {
        //updates the unread message count for the recipient.
        $previousUnreadCount = intval($threadMeta->getUnreadMessageCount());
        $threadMeta->setUnreadMessageCount(++$previousUnreadCount);
    }

    /**
     * If the recipient has marked his message as archived but receives a new message that message would not appear
     * in his inbox folder. This feels wrong since now there is an unread message count in the archived box.
     *
     * Archived also means no longer active, but receiving a new reply makes it active again. So it makes sense to put
     * this back in the inbox folder.
     *
     * To consider: using the thread status manager for this, since there is also an event bound to the thread status
     * manager which we are not receiving now...
     *
     * @param ThreadMetaInterface $threadMeta
     */
    protected function maybeUpdateThreadStatusForRecipient(ThreadMetaInterface $threadMeta)
    {
        //updates the thread meta status for the recipient
        //Not sure if the best way is to do this here or to use the thread status manager, this way we loose the event
        // but is there really a good reason we need the event?
        $status = $threadMeta->getStatus();
        if (in_array($status, [ThreadMetaInterface::STATUS_ARCHIVED], true)) {
            $updateStatus = new ThreadStatus(ThreadMetaInterface::STATUS_ACTIVE);
            $threadMeta->setStatus($updateStatus->getThreadStatus());
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the MilioooMessageBundle package.
5			*
6			* (c) Michiel boeckaert <[email protected]>
7			* This source file is subject to the MIT license that is bundled
8			* with this source code in the file LICENSE.
9			*/
10
11			namespace Miliooo\Messaging\Builder\Message;
12
13			use Miliooo\Messaging\Model\ThreadInterface;
14			use Miliooo\Messaging\User\ParticipantInterface;
15			use Miliooo\Messaging\Model\ThreadMetaInterface;
16			use Miliooo\Messaging\Model\MessageInterface;
17			use Miliooo\Messaging\Model\MessageMetaInterface;
18			use Miliooo\Messaging\Model\BuilderInterface;
19			use Miliooo\Messaging\ValueObjects\ThreadStatus;
20
21			/**
22			* Description of AbstractMessageBuilder
23			*
24			* @author Michiel Boeckaert <[email protected]>
25			*/
26			abstract class AbstractMessageBuilder
27			{
28			/**
29			* Fully qualified namespace of the custom message class
30			*
31			* @var string
32			*/
33			protected $messageClass;
34
35			/**
36			* Fully qualified names of the message meta class
37			*
38			* @var string
39			*/
40			protected $messageMetaClass;
41
42			/**
43			* Fully qualified name of the thread class
44			*
45			* @var string
46			*/
47			protected $threadClass;
48
49			/**
50			* Fully qualified name of the thread meta class
51			*
52			* @var string
53			*/
54			protected $threadMetaClass;
55
56			/**
57			* Sets the message class
58			*
59			* @param string $messageClass Fully qualified name of message class
60			*/
61			public function setMessageClass($messageClass)
62			{
63			$this->messageClass = $messageClass;
64			}
65
66			/**
67			* Sets the message meta class
68			*
69			* @param string $messageMetaClass Fully qualified name the message meta class
70			*/
71			public function setMessageMetaClass($messageMetaClass)
72			{
73			$this->messageMetaClass = $messageMetaClass;
74			}
75
76			/**
77			* Sets the thread class
78			*
79			* @param string $threadClass Fully qualified name of the thread class
80			*/
81			public function setThreadClass($threadClass)
82			{
83			$this->threadClass = $threadClass;
84			}
85
86			/**
87			* Sets the thread meta class
88			*
89			* @param string $threadMetaClass Fully qualified name of the thread meta class
90			*/
91			public function setThreadMetaClass($threadMetaClass)
92			{
93			$this->threadMetaClass = $threadMetaClass;
94			}
95
96			/**
97			* Builds a new message
98			*
99			* @param ThreadInterface $thread
100			*/
101			protected function buildNewMessage(ThreadInterface $thread)
102			{
103			//creates a blank message
104			$message = $this->createMessage();
105
106			//adds data to the message
107			$this->setMessageData($message);
108
109			//adds the thread to the message
110			$message->setThread($thread);
111
112			//adds the message to the thread
113			$thread->addMessage($message);
114
115			//sets the last message
116			$thread->setLastMessage($message);
117
118			//creates message meta
119			$this->createMessageMetaForNewMessage($message);
120			}
121
122			/**
123			* Creates new message meta for the participant
124			*
125			* @param MessageInterface $message The message the meta belongs
126			* @param ParticipantInterface $participant The participant in the thread this message belongs to
127			*
128			* @return MessageMetaInterface
129			*/
130			private function createNewMessageMetaForParticipant(MessageInterface $message, ParticipantInterface $participant)
131			{
132			//creates an empty message meta object
133			$messageMeta = $this->createMessageMeta();
134
135			//adds the message to the message meta
136			$messageMeta->setMessage($message);
137
138			//adds the participant to the message meta
139			$messageMeta->setParticipant($participant);
140
141			//adds the message meta to the message
142			$message->addMessageMeta($messageMeta);
143
144			return $messageMeta;
145			}
146
147			/**
148			* Updates the message with the message data in the builder model
149			*
150			* @param MessageInterface $message
151			*/
152			protected function setMessageData(MessageInterface $message)
153			{
154			$this->processbuilderModel('getMessageData', null, $message);
155			}
156
157			/**
158			* Updates the message meta for the sender.
159			*
160			* It processes first the message meta for all participants
161			* Then it processes the message meta specific for the sender
162			*
163			* @param MessageMetaInterface $messageMeta
164			*/
165			protected function updateMessageMetaForSender(MessageMetaInterface $messageMeta)
166			{
167			$this->processBuilderModel('getMessageMeta', 'all', $messageMeta);
168			$this->processBuilderModel('getMessageMeta', 'sender', $messageMeta);
169			}
170
171			/**
172			* Updates the message meta for the recipient.
173			*
174			* It processes first the message meta for all participants
175			* Then it processes the message meta specific for the recipient.
176			*
177			* @param MessageMetaInterface $messageMeta
178			*/
179			protected function updateMessageMetaForRecipient(MessageMetaInterface $messageMeta)
180			{
181			//process the data for all participants
182			$this->processBuilderModel('getMessageMeta', 'all', $messageMeta);
183
184			//process the data for the recipients
185			$this->processBuilderModel('getMessageMeta', 'recipients', $messageMeta);
186			}
187
188			/**
189			* Updates the given object with the given methodName and argumentName
190			*
191			* @param string $callMethodName Calls the builder with this methodName
192			* @param string\|null $callMethodArgument Calls the builder with this argument for the given methodName
193			* @param BuilderInterface $object The object which gets updated
194			*/
195			protected function processBuilderModel($callMethodName, $callMethodArgument, BuilderInterface $object)
196			{
197			$data = $this->builderModel->$callMethodName($callMethodArgument);
			0 ignored issues – show Bug introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report The property `builderModel` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
198
199			if (!$data) {
200			return;
201			}
202
203			foreach ($data as $key => $value) {
204			$setterMethod = $this->getSetter($key, $object);
205			$object->$setterMethod($value);
206			}
207			}
208
209			/**
210			* Gets the setter method for the given key.
211			*
212			* This function tries to find the setter for the given key. By convention this should be setKey.
213			*
214			* It checks the object if there is a method which is named setKey and if that method is callable (is public)
215			* If not it throws an invalidArgumentException
216			*
217			* @param string $key
218			* @param object $object
219			*
220			* @return string The callable setter method
221			*
222			* @throws \InvalidArgumentException If no callable setter found
223			*/
224			protected function getSetter($key, $object)
225			{
226			if (!is_string($key)) {
227			throw new \InvalidArgumentException('could not create setter method, no string given');
228			}
229
230			//try with setMethodName
231			$setMethodName = 'set' . ucFirst($key);
232
233			if (method_exists($object, $setMethodName) && is_callable([$object, $setMethodName])) {
234			return $setMethodName;
235			}
236
237			throw new \InvalidArgumentException(sprintf('could not find setter for %s', $key));
238			}
239
240			/**
241			* creates a new message object
242			*
243			* @return MessageInterface
244			*/
245			private function createMessage()
246			{
247			return new $this->messageClass;
248			}
249
250			/**
251			* creates a new message meta object
252			*
253			* @return MessageMetaInterface
254			*/
255			private function createMessageMeta()
256			{
257			return new $this->messageMetaClass;
258			}
259
260			/**
261			* Creates the message meta for a new message.
262			*
263			* @param MessageInterface $message
264			*/
265			private function createMessageMetaForNewMessage(MessageInterface $message)
266			{
267			$messageMeta = $this->createNewMessageMetaForParticipant($message, $this->sender);
			0 ignored issues – show Bug introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report The property `sender` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
268			$this->updateMessageMetaForSender($messageMeta);
269
270			foreach ($this->recipients as $recipient) {
			0 ignored issues – show Bug introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report The property `recipients` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
271			$messageMeta = $this->createNewMessageMetaForParticipant($message, $recipient);
272			$this->updateMessageMetaForRecipient($messageMeta);
273			}
274			}
275
276			/**
277			* Updates the thread meta with settings specific for the sender
278			*
279			* @param ThreadMetaInterface $threadMeta
280			*/
281			protected function updateThreadMetaForSender(ThreadMetaInterface $threadMeta)
282			{
283			$this->processBuilderModel('getThreadMeta', 'all', $threadMeta);
284			$this->processBuilderModel('getThreadMeta', 'sender', $threadMeta);
285			}
286
287			/**
288			* Updates the thread meta with the settings specific for the recipient
289			*
290			* This processes the builder model
291			*
292			* @param ThreadMetaInterface $threadMeta
293			*/
294			protected function updateThreadMetaForRecipient(ThreadMetaInterface $threadMeta)
295			{
296			$this->processBuilderModel('getThreadMeta', 'all', $threadMeta);
297			$this->processBuilderModel('getThreadMeta', 'recipients', $threadMeta);
298			$this->increaseUnreadMessageCountRecipient($threadMeta);
299			$this->maybeUpdateThreadStatusForRecipient($threadMeta);
300			}
301
302			/**
303			* Increases the unread message count for the recipient.
304			*
305			* Since the recipient has received a new message we need to increase the unread message count for the recipient.
306			* When it's a new thread this count should become one.
307			* When it's a we should add +1 to the current unread count.
308			*
309			* @param ThreadMetaInterface $threadMeta
310			*/
311			protected function increaseUnreadMessageCountRecipient(ThreadMetaInterface $threadMeta)
312			{
313			//updates the unread message count for the recipient.
314			$previousUnreadCount = intval($threadMeta->getUnreadMessageCount());
315			$threadMeta->setUnreadMessageCount(++$previousUnreadCount);
316			}
317
318			/**
319			* If the recipient has marked his message as archived but receives a new message that message would not appear
320			* in his inbox folder. This feels wrong since now there is an unread message count in the archived box.
321			*
322			* Archived also means no longer active, but receiving a new reply makes it active again. So it makes sense to put
323			* this back in the inbox folder.
324			*
325			* To consider: using the thread status manager for this, since there is also an event bound to the thread status
326			* manager which we are not receiving now...
327			*
328			* @param ThreadMetaInterface $threadMeta
329			*/
330			protected function maybeUpdateThreadStatusForRecipient(ThreadMetaInterface $threadMeta)
331			{
332			//updates the thread meta status for the recipient
333			//Not sure if the best way is to do this here or to use the thread status manager, this way we loose the event
334			// but is there really a good reason we need the event?
335			$status = $threadMeta->getStatus();
336			if (in_array($status, [ThreadMetaInterface::STATUS_ARCHIVED], true)) {
337			$updateStatus = new ThreadStatus(ThreadMetaInterface::STATUS_ACTIVE);
338			$threadMeta->setStatus($updateStatus->getThreadStatus());
339			}
340			}
341			}
342

Miliooo / MilioooMessageBundle

AbstractMessageBuilder::createMessage() A last analyzed 2017-02-15 05:46 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractMessageBuilder::createMessage() A
last analyzed 2017-02-15 05:46 UTC