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

MessageInterface::setBody()
last analyzed 2017-02-15 05:46 UTC

↳ Parent: MessageInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	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\Model;

use Miliooo\Messaging\User\ParticipantInterface;
use Doctrine\Common\Collections\ArrayCollection;

/**
 * The message Interface
 *
 * @author Michiel Boeckaert <[email protected]>
 */
interface MessageInterface extends BuilderInterface
{
    /**
     * Gets the unique id of the message
     *
     * @return integer The unique id of the message
     */
    public function getId();

    /**
     * Gets the creation time of the message
     *
     * @return \DateTime
     */
    public function getCreatedAt();

    /**
     * Sets the creation time of the message
     *
     * @param \DateTime $createdAt The time the message was created
     */
    public function setCreatedAt(\DateTime $createdAt);


    /**
     * Gets the body of the message
     *
     * @return string The body
     */
    public function getBody();

    /**
     * Sets the body of the message
     *
     * @param string $body The body
     */
    public function setBody($body);


    /**
     * Sets the sender of the message
     *
     * @param ParticipantInterface $sender The sender of the message
     */
    public function setSender(ParticipantInterface $sender);


    /**
     * Gets the sender of the message
     *
     * @return ParticipantInterface
     */
    public function getSender();

    /**
     * Adds message meta to the messageMeta collection
     *
     * @param MessageMetaInterface $messageMeta
     */
    public function addMessageMeta(MessageMetaInterface $messageMeta);


    /**
     * Returns an array collection with message meta
     *
     * @return ArrayCollection An ArrayCollection of messageMeta
     */
    public function getMessageMeta();

    /**
     * Gets message meta for the given participant
     *
     * @param ParticipantInterface $participant The participant
     *
     * @return MessageMetaInterface|null The messagemeta or null when not found
     */
    public function getMessageMetaForParticipant(ParticipantInterface $participant);

    /**
     * Sets the thread this message belongs to
     *
     * @param ThreadInterface $thread The thread this message belongs to
     */
    public function setThread(ThreadInterface $thread);


    /**
     * Gets the thread this message belongs to
     *
     * @return ThreadInterface the thread this message belongs to
     */
    public function getThread();
}


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\Model;
12
13			use Miliooo\Messaging\User\ParticipantInterface;
14			use Doctrine\Common\Collections\ArrayCollection;
15
16			/**
17			* The message Interface
18			*
19			* @author Michiel Boeckaert <[email protected]>
20			*/
21			interface MessageInterface extends BuilderInterface
22			{
23			/**
24			* Gets the unique id of the message
25			*
26			* @return integer The unique id of the message
27			*/
28			public function getId();
29
30			/**
31			* Gets the creation time of the message
32			*
33			* @return \DateTime
34			*/
35			public function getCreatedAt();
36
37			/**
38			* Sets the creation time of the message
39			*
40			* @param \DateTime $createdAt The time the message was created
41			*/
42			public function setCreatedAt(\DateTime $createdAt);
			0 ignored issues – show Documentation introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
43
44			/**
45			* Gets the body of the message
46			*
47			* @return string The body
48			*/
49			public function getBody();
50
51			/**
52			* Sets the body of the message
53			*
54			* @param string $body The body
55			*/
56			public function setBody($body);
			0 ignored issues – show Documentation introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
57
58			/**
59			* Sets the sender of the message
60			*
61			* @param ParticipantInterface $sender The sender of the message
62			*/
63			public function setSender(ParticipantInterface $sender);
			0 ignored issues – show Documentation introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
64
65			/**
66			* Gets the sender of the message
67			*
68			* @return ParticipantInterface
69			*/
70			public function getSender();
71
72			/**
73			* Adds message meta to the messageMeta collection
74			*
75			* @param MessageMetaInterface $messageMeta
76			*/
77			public function addMessageMeta(MessageMetaInterface $messageMeta);
			0 ignored issues – show Documentation introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
78
79			/**
80			* Returns an array collection with message meta
81			*
82			* @return ArrayCollection An ArrayCollection of messageMeta
83			*/
84			public function getMessageMeta();
85
86			/**
87			* Gets message meta for the given participant
88			*
89			* @param ParticipantInterface $participant The participant
90			*
91			* @return MessageMetaInterface\|null The messagemeta or null when not found
92			*/
93			public function getMessageMetaForParticipant(ParticipantInterface $participant);
94
95			/**
96			* Sets the thread this message belongs to
97			*
98			* @param ThreadInterface $thread The thread this message belongs to
99			*/
100			public function setThread(ThreadInterface $thread);
			0 ignored issues – show Documentation introduced 2016-03-28 11:28 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
101
102			/**
103			* Gets the thread this message belongs to
104			*
105			* @return ThreadInterface the thread this message belongs to
106			*/
107			public function getThread();
108			}
109

Miliooo / MilioooMessageBundle

MessageInterface::setBody() last analyzed 2017-02-15 05:46 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MessageInterface::setBody()
last analyzed 2017-02-15 05:46 UTC