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

ThreadMetaInterface::setStatus()
last analyzed 2017-02-15 05:46 UTC

↳ Parent: ThreadMetaInterface

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;

/**
 * The interface for the threadmeta class
 *
 * @author Michiel Boeckaert <[email protected]>
 */
interface ThreadMetaInterface extends BuilderInterface
{
    const STATUS_ACTIVE = 1;
    const STATUS_ARCHIVED = 2;

    /**
     * Gets the unique id of the thread meta
     *
     * @return integer
     */
    public function getId();

    /**
     * Gets the participant of the thread meta
     *
     * @return ParticipantInterface
     */
    public function getParticipant();

    /**
     * Sets the participant of the thread meta
     *
     * @param ParticipantInterface $participant The participant
     */
    public function setParticipant(ParticipantInterface $participant);


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


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

    /**
     * Gets the status of the given thread for the participant of the threadMeta.
     *
     * @return integer one of the status constants
     */
    public function getStatus();

    /**
     * Sets the status of the thread for the given participant.
     *
     * @param integer $status
     */
    public function setStatus($status);


    /**
     * Gets the datetime when the participant has written his last message for
     * the given thread
     *
     * @return \DateTime
     */
    public function getLastParticipantMessageDate();

    /**
     * Sets the datetime when the participant has written his last message for the given thread
     *
     * @param \DateTime $dateTime DateTime of participant's last message
     */
    public function setLastParticipantMessageDate(\DateTime $dateTime);


    /**
     * Gets the date time of the last message written by another participant
     *
     * @return \DateTime datetime of the last message written by another participant
     */
    public function getLastMessageDate();

    /**
     * Sets the date of the last message written by another participant
     *
     * @param \DateTime $lastMessageDate datetime of the last message by another participant
     */
    public function setLastMessageDate(\DateTime $lastMessageDate);


    /**
     * Gets the number of unread messages for the participant from the given thread.
     *
     * @return integer The number of unread messages from the thread for the given participant
     */
    public function getUnreadMessageCount();

    /**
     * Sets the number of unread messages for the participant from the given thread.
     *
     * @param integer $unreadCount The number of unread messages from the thread for the given participant
     */
    public function setUnreadMessageCount($unreadCount);

}


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
15			/**
16			* The interface for the threadmeta class
17			*
18			* @author Michiel Boeckaert <[email protected]>
19			*/
20			interface ThreadMetaInterface extends BuilderInterface
21			{
22			const STATUS_ACTIVE = 1;
23			const STATUS_ARCHIVED = 2;
24
25			/**
26			* Gets the unique id of the thread meta
27			*
28			* @return integer
29			*/
30			public function getId();
31
32			/**
33			* Gets the participant of the thread meta
34			*
35			* @return ParticipantInterface
36			*/
37			public function getParticipant();
38
39			/**
40			* Sets the participant of the thread meta
41			*
42			* @param ParticipantInterface $participant The participant
43			*/
44			public function setParticipant(ParticipantInterface $participant);
			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...
45
46			/**
47			* Sets the thread for this thread meta
48			*
49			* @param ThreadInterface $thread The thread this meta belongs to
50			*/
51			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...
52
53			/**
54			* Gets the thread for this thread meta
55			*
56			* @return ThreadInterface the thread this meta belongs to
57			*/
58			public function getThread();
59
60			/**
61			* Gets the status of the given thread for the participant of the threadMeta.
62			*
63			* @return integer one of the status constants
64			*/
65			public function getStatus();
66
67			/**
68			* Sets the status of the thread for the given participant.
69			*
70			* @param integer $status
71			*/
72			public function setStatus($status);
			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...
73
74			/**
75			* Gets the datetime when the participant has written his last message for
76			* the given thread
77			*
78			* @return \DateTime
79			*/
80			public function getLastParticipantMessageDate();
81
82			/**
83			* Sets the datetime when the participant has written his last message for the given thread
84			*
85			* @param \DateTime $dateTime DateTime of participant's last message
86			*/
87			public function setLastParticipantMessageDate(\DateTime $dateTime);
			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...
88
89			/**
90			* Gets the date time of the last message written by another participant
91			*
92			* @return \DateTime datetime of the last message written by another participant
93			*/
94			public function getLastMessageDate();
95
96			/**
97			* Sets the date of the last message written by another participant
98			*
99			* @param \DateTime $lastMessageDate datetime of the last message by another participant
100			*/
101			public function setLastMessageDate(\DateTime $lastMessageDate);
			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...
102
103			/**
104			* Gets the number of unread messages for the participant from the given thread.
105			*
106			* @return integer The number of unread messages from the thread for the given participant
107			*/
108			public function getUnreadMessageCount();
109
110			/**
111			* Sets the number of unread messages for the participant from the given thread.
112			*
113			* @param integer $unreadCount The number of unread messages from the thread for the given participant
114			*/
115			public function setUnreadMessageCount($unreadCount);
			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...
116			}
117

Miliooo / MilioooMessageBundle

ThreadMetaInterface::setStatus() last analyzed 2017-02-15 05:46 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ThreadMetaInterface::setStatus()
last analyzed 2017-02-15 05:46 UTC