Event - Code Metrics - Inspection of "Merge pull request #2092 from nextcloud/activity-f..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3c00ff...81e983 )

by Joas

created 2016-11-16 10:47 UTC

Event F

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	522
Duplicated Lines	21.84 %

Coupling/Cohesion

Components	4
Dependencies	1

Importance

Changes

Metric	Value
dl	114
loc	522
rs	1.5789
c	0
b	0
f	0
wmc	84
lcom	4
cbo	1

40 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setApp()	7	7	4
A	getApp()	0	3	1
A	setType()	7	7	4
A	getType()	0	3	1
A	setAffectedUser()	7	7	4
A	getAffectedUser()	0	3	1
A	setAuthor()	7	7	3
A	getAuthor()	0	3	1
A	setTimestamp()	0	7	2
A	getTimestamp()	0	3	1
A	setSubject()	8	8	3
A	getSubject()	0	3	1
A	getSubjectParameters()	0	3	1
A	setParsedSubject()	7	7	3
A	getParsedSubject()	0	3	1
A	setRichSubject()	13	13	4
A	getRichSubject()	0	3	1
A	getRichSubjectParameters()	0	3	1
A	setMessage()	8	8	3
A	getMessage()	0	3	1
A	getMessageParameters()	0	3	1
A	setParsedMessage()	0	7	2
A	getParsedMessage()	0	3	1
A	setRichMessage()	13	13	3
A	getRichMessage()	0	3	1
A	getRichMessageParameters()	0	3	1
B	setObject()	0	15	6
A	getObjectType()	0	3	1
A	getObjectId()	0	3	1
A	getObjectName()	0	3	1
A	setLink()	7	7	3
A	getLink()	0	3	1
A	setIcon()	7	7	3
A	getIcon()	0	3	1
A	setChildEvent()	0	3	1
A	getChildEvent()	0	3	1
A	isValid()	0	7	2
C	isValidParsed()	23	23	8
A	isValidCommon()	0	18	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Event often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Event, and based on these observations, apply Extract Interface, too.

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Joas Schilling <[email protected]>
 * @author Phil Davis <[email protected]>
 *
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OC\Activity;

use OCP\Activity\IEvent;
use OCP\RichObjectStrings\InvalidObjectExeption;
use OCP\RichObjectStrings\IValidator;

class Event implements IEvent {

	/** @var string */
	protected $app = '';
	/** @var string */
	protected $type = '';
	/** @var string */
	protected $affectedUser = '';
	/** @var string */
	protected $author = '';
	/** @var int */
	protected $timestamp = 0;
	/** @var string */
	protected $subject = '';
	/** @var array */
	protected $subjectParameters = [];
	/** @var string */
	protected $subjectParsed;
	/** @var string */
	protected $subjectRich;
	/** @var array */
	protected $subjectRichParameters;
	/** @var string */
	protected $message = '';
	/** @var array */
	protected $messageParameters = [];
	/** @var string */
	protected $messageParsed;
	/** @var string */
	protected $messageRich;
	/** @var array */
	protected $messageRichParameters;
	/** @var string */
	protected $objectType = '';
	/** @var int */
	protected $objectId = 0;
	/** @var string */
	protected $objectName = '';
	/** @var string */
	protected $link = '';
	/** @var string */
	protected $icon = '';

	/** @var IEvent */
	protected $child = null;
	/** @var IValidator */
	protected $richValidator;

	/**
	 * @param IValidator $richValidator
	 */
	public function __construct(IValidator $richValidator) {
		$this->richValidator = $richValidator;
	}

	/**
	 * Set the app of the activity
	 *
	 * @param string $app
	 * @return IEvent
	 * @throws \InvalidArgumentException if the app id is invalid
	 * @since 8.2.0
	 */
	public function setApp($app) {

		if (!is_string($app) || $app === '' || isset($app[32])) {
			throw new \InvalidArgumentException('The given app is invalid');
		}
		$this->app = (string) $app;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getApp() {
		return $this->app;
	}

	/**
	 * Set the type of the activity
	 *
	 * @param string $type
	 * @return IEvent
	 * @throws \InvalidArgumentException if the type is invalid
	 * @since 8.2.0
	 */
	public function setType($type) {

		if (!is_string($type) || $type === '' || isset($type[255])) {
			throw new \InvalidArgumentException('The given type is invalid');
		}
		$this->type = (string) $type;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getType() {
		return $this->type;
	}

	/**
	 * Set the affected user of the activity
	 *
	 * @param string $affectedUser
	 * @return IEvent
	 * @throws \InvalidArgumentException if the affected user is invalid
	 * @since 8.2.0
	 */
	public function setAffectedUser($affectedUser) {

		if (!is_string($affectedUser) || $affectedUser === '' || isset($affectedUser[64])) {
			throw new \InvalidArgumentException('The given affected user is invalid');
		}
		$this->affectedUser = (string) $affectedUser;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getAffectedUser() {
		return $this->affectedUser;
	}

	/**
	 * Set the author of the activity
	 *
	 * @param string $author
	 * @return IEvent
	 * @throws \InvalidArgumentException if the author is invalid
	 * @since 8.2.0
	 */
	public function setAuthor($author) {

		if (!is_string($author) || isset($author[64])) {
			throw new \InvalidArgumentException('The given author user is invalid'. serialize($author));
		}
		$this->author = (string) $author;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getAuthor() {
		return $this->author;
	}

	/**
	 * Set the timestamp of the activity
	 *
	 * @param int $timestamp
	 * @return IEvent
	 * @throws \InvalidArgumentException if the timestamp is invalid
	 * @since 8.2.0
	 */
	public function setTimestamp($timestamp) {
		if (!is_int($timestamp)) {
			throw new \InvalidArgumentException('The given timestamp is invalid');
		}
		$this->timestamp = (int) $timestamp;
		return $this;
	}

	/**
	 * @return int
	 */
	public function getTimestamp() {
		return $this->timestamp;
	}

	/**
	 * Set the subject of the activity
	 *
	 * @param string $subject
	 * @param array $parameters
	 * @return IEvent
	 * @throws \InvalidArgumentException if the subject or parameters are invalid
	 * @since 8.2.0
	 */
	public function setSubject($subject, array $parameters = []) {

		if (!is_string($subject) || isset($subject[255])) {
			throw new \InvalidArgumentException('The given subject is invalid');
		}
		$this->subject = (string) $subject;
		$this->subjectParameters = $parameters;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getSubject() {
		return $this->subject;
	}

	/**
	 * @return array
	 */
	public function getSubjectParameters() {
		return $this->subjectParameters;
	}

	/**
	 * @param string $subject
	 * @return $this
	 * @throws \InvalidArgumentException if the subject is invalid
	 * @since 11.0.0
	 */
	public function setParsedSubject($subject) {

		if (!is_string($subject) || $subject === '') {
			throw new \InvalidArgumentException('The given parsed subject is invalid');
		}
		$this->subjectParsed = $subject;
		return $this;
	}

	/**
	 * @return string
	 * @since 11.0.0
	 */
	public function getParsedSubject() {
		return $this->subjectParsed;
	}

	/**
	 * @param string $subject
	 * @param array $parameters
	 * @return $this
	 * @throws \InvalidArgumentException if the subject or parameters are invalid
	 * @since 11.0.0
	 */
	public function setRichSubject($subject, array $parameters = []) {

		if (!is_string($subject) || $subject === '') {
			throw new \InvalidArgumentException('The given parsed subject is invalid');
		}
		$this->subjectRich = $subject;

		if (!is_array($parameters)) {
			throw new \InvalidArgumentException('The given subject parameters are invalid');
		}
		$this->subjectRichParameters = $parameters;

		return $this;
	}

	/**
	 * @return string
	 * @since 11.0.0
	 */
	public function getRichSubject() {
		return $this->subjectRich;
	}

	/**
	 * @return array[]
	 * @since 11.0.0
	 */
	public function getRichSubjectParameters() {
		return $this->subjectRichParameters;
	}

	/**
	 * Set the message of the activity
	 *
	 * @param string $message
	 * @param array $parameters
	 * @return IEvent
	 * @throws \InvalidArgumentException if the message or parameters are invalid
	 * @since 8.2.0
	 */
	public function setMessage($message, array $parameters = []) {

		if (!is_string($message) || isset($message[255])) {
			throw new \InvalidArgumentException('The given message is invalid');
		}
		$this->message = (string) $message;
		$this->messageParameters = $parameters;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getMessage() {
		return $this->message;
	}

	/**
	 * @return array
	 */
	public function getMessageParameters() {
		return $this->messageParameters;
	}

	/**
	 * @param string $message
	 * @return $this
	 * @throws \InvalidArgumentException if the message is invalid
	 * @since 11.0.0
	 */
	public function setParsedMessage($message) {
		if (!is_string($message)) {
			throw new \InvalidArgumentException('The given parsed message is invalid');
		}
		$this->messageParsed = $message;
		return $this;
	}

	/**
	 * @return string
	 * @since 11.0.0
	 */
	public function getParsedMessage() {
		return $this->messageParsed;
	}

	/**
	 * @param string $message
	 * @param array $parameters
	 * @return $this
	 * @throws \InvalidArgumentException if the subject or parameters are invalid
	 * @since 11.0.0
	 */
	public function setRichMessage($message, array $parameters = []) {

		if (!is_string($message)) {
			throw new \InvalidArgumentException('The given parsed message is invalid');
		}
		$this->messageRich = $message;

		if (!is_array($parameters)) {
			throw new \InvalidArgumentException('The given message parameters are invalid');
		}
		$this->messageRichParameters = $parameters;

		return $this;
	}

	/**
	 * @return string
	 * @since 11.0.0
	 */
	public function getRichMessage() {
		return $this->messageRich;
	}

	/**
	 * @return array[]
	 * @since 11.0.0
	 */
	public function getRichMessageParameters() {
		return $this->messageRichParameters;
	}

	/**
	 * Set the object of the activity
	 *
	 * @param string $objectType
	 * @param int $objectId
	 * @param string $objectName
	 * @return IEvent
	 * @throws \InvalidArgumentException if the object is invalid
	 * @since 8.2.0
	 */
	public function setObject($objectType, $objectId, $objectName = '') {
		if (!is_string($objectType) || isset($objectType[255])) {
			throw new \InvalidArgumentException('The given object type is invalid');
		}
		if (!is_int($objectId)) {
			throw new \InvalidArgumentException('The given object id is invalid');
		}
		if (!is_string($objectName) || isset($objectName[4000])) {
			throw new \InvalidArgumentException('The given object name is invalid');
		}
		$this->objectType = (string) $objectType;
		$this->objectId = (int) $objectId;
		$this->objectName = (string) $objectName;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getObjectType() {
		return $this->objectType;
	}

	/**
	 * @return string
	 */
	public function getObjectId() {
		return $this->objectId;
	}

	/**
	 * @return string
	 */
	public function getObjectName() {
		return $this->objectName;
	}

	/**
	 * Set the link of the activity
	 *
	 * @param string $link
	 * @return IEvent
	 * @throws \InvalidArgumentException if the link is invalid
	 * @since 8.2.0
	 */
	public function setLink($link) {

		if (!is_string($link) || isset($link[4000])) {
			throw new \InvalidArgumentException('The given link is invalid');
		}
		$this->link = (string) $link;
		return $this;
	}

	/**
	 * @return string
	 */
	public function getLink() {
		return $this->link;
	}

	/**
	 * @param string $icon
	 * @return $this
	 * @throws \InvalidArgumentException if the icon is invalid
	 * @since 11.0.0
	 */
	public function setIcon($icon) {

		if (!is_string($icon) || isset($icon[4000])) {
			throw new \InvalidArgumentException('The given icon is invalid');
		}
		$this->icon = $icon;
		return $this;
	}

	/**
	 * @return string
	 * @since 11.0.0
	 */
	public function getIcon() {
		return $this->icon;
	}

	/**
	 * @param IEvent $child
	 * @since 11.0.0
	 */
	public function setChildEvent(IEvent $child) {
		$this->child = $child;
	}

	/**
	 * @return IEvent|null
	 * @since 11.0.0
	 */
	public function getChildEvent() {
		return $this->child;
	}

	/**
	 * @return bool
	 * @since 8.2.0
	 */
	public function isValid() {
		return
			$this->isValidCommon()
			&&
			$this->getSubject() !== ''
		;
	}

	/**
	 * @return bool
	 * @since 8.2.0
	 */
	public function isValidParsed() {

		if ($this->getRichSubject() !== '' || !empty($this->getRichSubjectParameters())) {
			try {
				$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
			} catch (InvalidObjectExeption $e) {
				return false;
			}
		}

		if ($this->getRichMessage() !== '' || !empty($this->getRichMessageParameters())) {
			try {
				$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
			} catch (InvalidObjectExeption $e) {
				return false;
			}
		}

		return
			$this->isValidCommon()
			&&
			$this->getParsedSubject() !== ''
		;
	}

	/**
	 * @return bool
	 */
	protected function isValidCommon() {
		return
			$this->getApp() !== ''
			&&
			$this->getType() !== ''
			&&
			$this->getAffectedUser() !== ''
			&&
			$this->getTimestamp() !== 0
			/**
			 * Disabled for BC with old activities
			&&
			$this->getObjectType() !== ''
			&&
			$this->getObjectId() !== 0
			 */
		;
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Joas Schilling <[email protected]>
6		* @author Phil Davis <[email protected]>
7		*
8		* @license AGPL-3.0
9		*
10		* This code is free software: you can redistribute it and/or modify
11		* it under the terms of the GNU Affero General Public License, version 3,
12		* as published by the Free Software Foundation.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU Affero General Public License for more details.
18		*
19		* You should have received a copy of the GNU Affero General Public License, version 3,
20		* along with this program. If not, see <http://www.gnu.org/licenses/>
21		*
22		*/
23
24		namespace OC\Activity;
25
26		use OCP\Activity\IEvent;
27		use OCP\RichObjectStrings\InvalidObjectExeption;
28		use OCP\RichObjectStrings\IValidator;
29
30		class Event implements IEvent {
31
32		/** @var string */
33		protected $app = '';
34		/** @var string */
35		protected $type = '';
36		/** @var string */
37		protected $affectedUser = '';
38		/** @var string */
39		protected $author = '';
40		/** @var int */
41		protected $timestamp = 0;
42		/** @var string */
43		protected $subject = '';
44		/** @var array */
45		protected $subjectParameters = [];
46		/** @var string */
47		protected $subjectParsed;
48		/** @var string */
49		protected $subjectRich;
50		/** @var array */
51		protected $subjectRichParameters;
52		/** @var string */
53		protected $message = '';
54		/** @var array */
55		protected $messageParameters = [];
56		/** @var string */
57		protected $messageParsed;
58		/** @var string */
59		protected $messageRich;
60		/** @var array */
61		protected $messageRichParameters;
62		/** @var string */
63		protected $objectType = '';
64		/** @var int */
65		protected $objectId = 0;
66		/** @var string */
67		protected $objectName = '';
68		/** @var string */
69		protected $link = '';
70		/** @var string */
71		protected $icon = '';
72
73		/** @var IEvent */
74		protected $child = null;
75		/** @var IValidator */
76		protected $richValidator;
77
78		/**
79		* @param IValidator $richValidator
80		*/
81		public function __construct(IValidator $richValidator) {
82		$this->richValidator = $richValidator;
83		}
84
85		/**
86		* Set the app of the activity
87		*
88		* @param string $app
89		* @return IEvent
90		* @throws \InvalidArgumentException if the app id is invalid
91		* @since 8.2.0
92		*/
93	View Code Duplication	public function setApp($app) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
94		if (!is_string($app) \|\| $app === '' \|\| isset($app[32])) {
95		throw new \InvalidArgumentException('The given app is invalid');
96		}
97		$this->app = (string) $app;
98		return $this;
99		}
100
101		/**
102		* @return string
103		*/
104		public function getApp() {
105		return $this->app;
106		}
107
108		/**
109		* Set the type of the activity
110		*
111		* @param string $type
112		* @return IEvent
113		* @throws \InvalidArgumentException if the type is invalid
114		* @since 8.2.0
115		*/
116	View Code Duplication	public function setType($type) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
117		if (!is_string($type) \|\| $type === '' \|\| isset($type[255])) {
118		throw new \InvalidArgumentException('The given type is invalid');
119		}
120		$this->type = (string) $type;
121		return $this;
122		}
123
124		/**
125		* @return string
126		*/
127		public function getType() {
128		return $this->type;
129		}
130
131		/**
132		* Set the affected user of the activity
133		*
134		* @param string $affectedUser
135		* @return IEvent
136		* @throws \InvalidArgumentException if the affected user is invalid
137		* @since 8.2.0
138		*/
139	View Code Duplication	public function setAffectedUser($affectedUser) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
140		if (!is_string($affectedUser) \|\| $affectedUser === '' \|\| isset($affectedUser[64])) {
141		throw new \InvalidArgumentException('The given affected user is invalid');
142		}
143		$this->affectedUser = (string) $affectedUser;
144		return $this;
145		}
146
147		/**
148		* @return string
149		*/
150		public function getAffectedUser() {
151		return $this->affectedUser;
152		}
153
154		/**
155		* Set the author of the activity
156		*
157		* @param string $author
158		* @return IEvent
159		* @throws \InvalidArgumentException if the author is invalid
160		* @since 8.2.0
161		*/
162	View Code Duplication	public function setAuthor($author) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
163		if (!is_string($author) \|\| isset($author[64])) {
164		throw new \InvalidArgumentException('The given author user is invalid'. serialize($author));
165		}
166		$this->author = (string) $author;
167		return $this;
168		}
169
170		/**
171		* @return string
172		*/
173		public function getAuthor() {
174		return $this->author;
175		}
176
177		/**
178		* Set the timestamp of the activity
179		*
180		* @param int $timestamp
181		* @return IEvent
182		* @throws \InvalidArgumentException if the timestamp is invalid
183		* @since 8.2.0
184		*/
185		public function setTimestamp($timestamp) {
186		if (!is_int($timestamp)) {
187		throw new \InvalidArgumentException('The given timestamp is invalid');
188		}
189		$this->timestamp = (int) $timestamp;
190		return $this;
191		}
192
193		/**
194		* @return int
195		*/
196		public function getTimestamp() {
197		return $this->timestamp;
198		}
199
200		/**
201		* Set the subject of the activity
202		*
203		* @param string $subject
204		* @param array $parameters
205		* @return IEvent
206		* @throws \InvalidArgumentException if the subject or parameters are invalid
207		* @since 8.2.0
208		*/
209	View Code Duplication	public function setSubject($subject, array $parameters = []) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
210		if (!is_string($subject) \|\| isset($subject[255])) {
211		throw new \InvalidArgumentException('The given subject is invalid');
212		}
213		$this->subject = (string) $subject;
214		$this->subjectParameters = $parameters;
215		return $this;
216		}
217
218		/**
219		* @return string
220		*/
221		public function getSubject() {
222		return $this->subject;
223		}
224
225		/**
226		* @return array
227		*/
228		public function getSubjectParameters() {
229		return $this->subjectParameters;
230		}
231
232		/**
233		* @param string $subject
234		* @return $this
235		* @throws \InvalidArgumentException if the subject is invalid
236		* @since 11.0.0
237		*/
238	View Code Duplication	public function setParsedSubject($subject) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
239		if (!is_string($subject) \|\| $subject === '') {
240		throw new \InvalidArgumentException('The given parsed subject is invalid');
241		}
242		$this->subjectParsed = $subject;
243		return $this;
244		}
245
246		/**
247		* @return string
248		* @since 11.0.0
249		*/
250		public function getParsedSubject() {
251		return $this->subjectParsed;
252		}
253
254		/**
255		* @param string $subject
256		* @param array $parameters
257		* @return $this
258		* @throws \InvalidArgumentException if the subject or parameters are invalid
259		* @since 11.0.0
260		*/
261	View Code Duplication	public function setRichSubject($subject, array $parameters = []) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
262		if (!is_string($subject) \|\| $subject === '') {
263		throw new \InvalidArgumentException('The given parsed subject is invalid');
264		}
265		$this->subjectRich = $subject;
266
267		if (!is_array($parameters)) {
268		throw new \InvalidArgumentException('The given subject parameters are invalid');
269		}
270		$this->subjectRichParameters = $parameters;
271
272		return $this;
273		}
274
275		/**
276		* @return string
277		* @since 11.0.0
278		*/
279		public function getRichSubject() {
280		return $this->subjectRich;
281		}
282
283		/**
284		* @return array[]
285		* @since 11.0.0
286		*/
287		public function getRichSubjectParameters() {
288		return $this->subjectRichParameters;
289		}
290
291		/**
292		* Set the message of the activity
293		*
294		* @param string $message
295		* @param array $parameters
296		* @return IEvent
297		* @throws \InvalidArgumentException if the message or parameters are invalid
298		* @since 8.2.0
299		*/
300	View Code Duplication	public function setMessage($message, array $parameters = []) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
301		if (!is_string($message) \|\| isset($message[255])) {
302		throw new \InvalidArgumentException('The given message is invalid');
303		}
304		$this->message = (string) $message;
305		$this->messageParameters = $parameters;
306		return $this;
307		}
308
309		/**
310		* @return string
311		*/
312		public function getMessage() {
313		return $this->message;
314		}
315
316		/**
317		* @return array
318		*/
319		public function getMessageParameters() {
320		return $this->messageParameters;
321		}
322
323		/**
324		* @param string $message
325		* @return $this
326		* @throws \InvalidArgumentException if the message is invalid
327		* @since 11.0.0
328		*/
329		public function setParsedMessage($message) {
330		if (!is_string($message)) {
331		throw new \InvalidArgumentException('The given parsed message is invalid');
332		}
333		$this->messageParsed = $message;
334		return $this;
335		}
336
337		/**
338		* @return string
339		* @since 11.0.0
340		*/
341		public function getParsedMessage() {
342		return $this->messageParsed;
343		}
344
345		/**
346		* @param string $message
347		* @param array $parameters
348		* @return $this
349		* @throws \InvalidArgumentException if the subject or parameters are invalid
350		* @since 11.0.0
351		*/
352	View Code Duplication	public function setRichMessage($message, array $parameters = []) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
353		if (!is_string($message)) {
354		throw new \InvalidArgumentException('The given parsed message is invalid');
355		}
356		$this->messageRich = $message;
357
358		if (!is_array($parameters)) {
359		throw new \InvalidArgumentException('The given message parameters are invalid');
360		}
361		$this->messageRichParameters = $parameters;
362
363		return $this;
364		}
365
366		/**
367		* @return string
368		* @since 11.0.0
369		*/
370		public function getRichMessage() {
371		return $this->messageRich;
372		}
373
374		/**
375		* @return array[]
376		* @since 11.0.0
377		*/
378		public function getRichMessageParameters() {
379		return $this->messageRichParameters;
380		}
381
382		/**
383		* Set the object of the activity
384		*
385		* @param string $objectType
386		* @param int $objectId
387		* @param string $objectName
388		* @return IEvent
389		* @throws \InvalidArgumentException if the object is invalid
390		* @since 8.2.0
391		*/
392		public function setObject($objectType, $objectId, $objectName = '') {
393		if (!is_string($objectType) \|\| isset($objectType[255])) {
394		throw new \InvalidArgumentException('The given object type is invalid');
395		}
396		if (!is_int($objectId)) {
397		throw new \InvalidArgumentException('The given object id is invalid');
398		}
399		if (!is_string($objectName) \|\| isset($objectName[4000])) {
400		throw new \InvalidArgumentException('The given object name is invalid');
401		}
402		$this->objectType = (string) $objectType;
403		$this->objectId = (int) $objectId;
404		$this->objectName = (string) $objectName;
405		return $this;
406		}
407
408		/**
409		* @return string
410		*/
411		public function getObjectType() {
412		return $this->objectType;
413		}
414
415		/**
416		* @return string
417		*/
418		public function getObjectId() {
419		return $this->objectId;
420		}
421
422		/**
423		* @return string
424		*/
425		public function getObjectName() {
426		return $this->objectName;
427		}
428
429		/**
430		* Set the link of the activity
431		*
432		* @param string $link
433		* @return IEvent
434		* @throws \InvalidArgumentException if the link is invalid
435		* @since 8.2.0
436		*/
437	View Code Duplication	public function setLink($link) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
438		if (!is_string($link) \|\| isset($link[4000])) {
439		throw new \InvalidArgumentException('The given link is invalid');
440		}
441		$this->link = (string) $link;
442		return $this;
443		}
444
445		/**
446		* @return string
447		*/
448		public function getLink() {
449		return $this->link;
450		}
451
452		/**
453		* @param string $icon
454		* @return $this
455		* @throws \InvalidArgumentException if the icon is invalid
456		* @since 11.0.0
457		*/
458	View Code Duplication	public function setIcon($icon) {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
459		if (!is_string($icon) \|\| isset($icon[4000])) {
460		throw new \InvalidArgumentException('The given icon is invalid');
461		}
462		$this->icon = $icon;
463		return $this;
464		}
465
466		/**
467		* @return string
468		* @since 11.0.0
469		*/
470		public function getIcon() {
471		return $this->icon;
472		}
473
474		/**
475		* @param IEvent $child
476		* @since 11.0.0
477		*/
478		public function setChildEvent(IEvent $child) {
479		$this->child = $child;
480		}
481
482		/**
483		* @return IEvent\|null
484		* @since 11.0.0
485		*/
486		public function getChildEvent() {
487		return $this->child;
488		}
489
490		/**
491		* @return bool
492		* @since 8.2.0
493		*/
494		public function isValid() {
495		return
496		$this->isValidCommon()
497		&&
498		$this->getSubject() !== ''
499		;
500		}
501
502		/**
503		* @return bool
504		* @since 8.2.0
505		*/
506	View Code Duplication	public function isValidParsed() {
		0 ignored issues – show Duplication introduced 2016-11-11 11:07 UTC by Report Bug Copy Issue Report This method 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...
507		if ($this->getRichSubject() !== '' \|\| !empty($this->getRichSubjectParameters())) {
508		try {
509		$this->richValidator->validate($this->getRichSubject(), $this->getRichSubjectParameters());
510		} catch (InvalidObjectExeption $e) {
511		return false;
512		}
513		}
514
515		if ($this->getRichMessage() !== '' \|\| !empty($this->getRichMessageParameters())) {
516		try {
517		$this->richValidator->validate($this->getRichMessage(), $this->getRichMessageParameters());
518		} catch (InvalidObjectExeption $e) {
519		return false;
520		}
521		}
522
523		return
524		$this->isValidCommon()
525		&&
526		$this->getParsedSubject() !== ''
527		;
528		}
529
530		/**
531		* @return bool
532		*/
533		protected function isValidCommon() {
534		return
535		$this->getApp() !== ''
536		&&
537		$this->getType() !== ''
538		&&
539		$this->getAffectedUser() !== ''
540		&&
541		$this->getTimestamp() !== 0
542		/**
543		* Disabled for BC with old activities
544		&&
545		$this->getObjectType() !== ''
546		&&
547		$this->getObjectId() !== 0
548		*/
549		;
550		}
551		}
552

nextcloud / server