NotificationsService::enqueueEvent() - Code Metrics - Inspection of "just log it in as a normal user" - gctools-outilsgc/gcconnex - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — solr-auth-refactor ( 3bee90 )

by Ilia

created 2019-01-18 17:02 UTC

NotificationsService::enqueueEvent() B

↳ Parent: NotificationsService

Complexity

Conditions	7
Paths	9

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	7

Importance

Changes

Metric	Value
cc	7
nc	9
nop	3
dl	0
loc	25
ccs	21
cts	21
cp	1
crap	7
rs	8.5866
c	0
b	0
f	0

<?php
namespace Elgg\Notifications;

use ElggEntity;

/**
 * WARNING: API IN FLUX. DO NOT USE DIRECTLY.
 *
 * @access private
 * 
 * @package    Elgg.Core
 * @subpackage Notifications
 * @since      1.9.0
 */
class NotificationsService {

	const QUEUE_NAME = 'notifications';

	/** @var \Elgg\Notifications\SubscriptionsService */
	protected $subscriptions;

	/** @var \Elgg\Queue\Queue */
	protected $queue;

	/** @var \Elgg\PluginHooksService */
	protected $hooks;

	/** @var \ElggSession */
	protected $session;

	/** @var array Registered notification events */
	protected $events = array();

	/** @var array Registered notification methods */
	protected $methods = array();

	/** @var array Deprecated notification handlers */
	protected $deprHandlers = array();

	/** @var array Deprecated message subjects */
	protected $deprSubjects = array();

	/**
	 * Constructor
	 *
	 * @param \Elgg\Notifications\SubscriptionsService $subscriptions Subscription service
	 * @param \Elgg\Queue\Queue                        $queue         Queue
	 * @param \Elgg\PluginHooksService                 $hooks         Plugin hook service
	 * @param \ElggSession                             $session       Session service
	 */
	public function __construct(\Elgg\Notifications\SubscriptionsService $subscriptions,
			\Elgg\Queue\Queue $queue, \Elgg\PluginHooksService $hooks, \ElggSession $session) {
		$this->subscriptions = $subscriptions;
		$this->queue = $queue;
		$this->hooks = $hooks;
		$this->session = $session;
	}

	/**
	 * @see elgg_register_notification_event()
	 * @access private
	 */
	public function registerEvent($type, $subtype, array $actions = array()) {

		if (!isset($this->events[$type])) {
			$this->events[$type] = array();
		}
		if (!isset($this->events[$type][$subtype])) {
			$this->events[$type][$subtype] = array();
		}

		$action_list =& $this->events[$type][$subtype];
		if ($actions) {

			$action_list = array_unique(array_merge($action_list, $actions));
		} elseif (!in_array('create', $action_list)) {
			$action_list[] = 'create';
		}
	}

	/**
	 * @see elgg_unregister_notification_event()
	 * @access private
	 */
	public function unregisterEvent($type, $subtype) {

		if (!isset($this->events[$type]) || !isset($this->events[$type][$subtype])) {
			return false;
		}

		unset($this->events[$type][$subtype]);

		return true;
	}

	/**
	 * @access private
	 */
	public function getEvents() {
		return $this->events;
	}

	/**
	 * @see elgg_register_notification_method()
	 * @access private
	 */
	public function registerMethod($name) {
		$this->methods[$name] = $name;
	}

	/**
	 * @see elgg_unregister_notification_method()
	 * @access private
	 */
	public function unregisterMethod($name) {
		if (isset($this->methods[$name])) {
			unset($this->methods[$name]);
			return true;
		}
		return false;
	}

	/**
	 * @access private
	 */
	public function getMethods() {
		return $this->methods;
	}

	/**
	 * Add a notification event to the queue
	 * 
	 * @param string   $action Action name
	 * @param string   $type   Type of the object of the action
	 * @param \ElggData $object The object of the action 
	 * @return void
	 * @access private
	 */
	public function enqueueEvent($action, $type, $object) {
		if ($object instanceof \ElggData) {
			$object_type = $object->getType();
			$object_subtype = $object->getSubtype();

			$registered = false;
			if (isset($this->events[$object_type])
				&& isset($this->events[$object_type][$object_subtype])
				&& in_array($action, $this->events[$object_type][$object_subtype])) {
				$registered = true;
			}

			if ($registered) {
				$params = array(
					'action' => $action,
					'object' => $object,
				);
				$registered = $this->hooks->trigger('enqueue', 'notification', $params, $registered);
			}

			if ($registered) {
				$this->queue->enqueue(new \Elgg\Notifications\Event($object, $action));
			}
		}
	}

	/**
	 * Pull notification events from queue until stop time is reached
	 *
	 * @param int $stopTime The Unix time to stop sending notifications
	 * @return int The number of notification events handled
	 * @access private
	 */
	public function processQueue($stopTime) {

		$this->subscriptions->methods = $this->methods;

		$count = 0;

		// @todo grab mutex
		
		$ia = $this->session->setIgnoreAccess(true);

		while (time() < $stopTime) {
			// dequeue notification event
			$event = $this->queue->dequeue();
			if (!$event) {
				break;
			}

			// test for usage of the deprecated override hook
			if ($this->existsDeprecatedNotificationOverride($event)) {
				continue;
			}

			$subscriptions = $this->subscriptions->getSubscriptions($event);

			// return false to stop the default notification sender
			$params = array('event' => $event, 'subscriptions' => $subscriptions);
			if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
				$this->sendNotifications($event, $subscriptions);
			}
			$this->hooks->trigger('send:after', 'notifications', $params);
			$count++;
		}

		// release mutex

		$this->session->setIgnoreAccess($ia);

		return $count;
	}

	/**
	 * Sends the notifications based on subscriptions
	 *
	 * @param \Elgg\Notifications\Event $event         Notification event
	 * @param array                    $subscriptions Subscriptions for this event
	 * @return int The number of notifications handled
	 * @access private
	 */
	protected function sendNotifications($event, $subscriptions) {

		if (!$this->methods) {

			return 0;
		}

		$count = 0;
		foreach ($subscriptions as $guid => $methods) {
			foreach ($methods as $method) {
				if (in_array($method, $this->methods)) {
					if ($this->sendNotification($event, $guid, $method)) {
						$count++;
					}
				}
			}
		}
		return $count;
	}

	/**
	 * Send a notification to a subscriber
	 *
	 * @param \Elgg\Notifications\Event $event  The notification event
	 * @param int                      $guid   The guid of the subscriber
	 * @param string                   $method The notification method
	 * @return bool
	 * @access private
	 */
	protected function sendNotification(\Elgg\Notifications\Event $event, $guid, $method) {

		$recipient = get_user($guid);
		if (!$recipient || $recipient->isBanned()) {
			return false;
		}

		// don't notify the creator of the content
		if ($recipient->getGUID() == $event->getActorGUID()) {
			return false;
		}

		$actor = $event->getActor();
		$object = $event->getObject();
		if (!$actor || !$object) {
			return false;
		}

		if (($object instanceof ElggEntity) && !has_access_to_entity($object, $recipient)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			return false;
		}

		$language = $recipient->language;
		$params = array(
			'event' => $event,
			'method' => $method,
			'recipient' => $recipient,
			'language' => $language,
			'object' => $object,
		);

		$subject = _elgg_services()->translator->translate('notification:subject', array($actor->name), $language);
		$body = _elgg_services()->translator->translate('notification:body', array($object->getURL()), $language);
		$notification = new \Elgg\Notifications\Notification($event->getActor(), $recipient, $language, $subject, $body, '', $params);

		$type = 'notification:' . $event->getDescription();
		if ($this->hooks->hasHandler('prepare', $type)) {
			$notification = $this->hooks->trigger('prepare', $type, $params, $notification);
		} else {
			// pre Elgg 1.9 notification message generation
			$notification = $this->getDeprecatedNotificationBody($notification, $event, $method);
		}

		if ($this->hooks->hasHandler('send', "notification:$method")) {
			// return true to indicate the notification has been sent
			$params = array(
				'notification' => $notification,
				'event' => $event,
			);
			return $this->hooks->trigger('send', "notification:$method", $params, false);
		} else {
			// pre Elgg 1.9 notification handler
			$userGuid = $notification->getRecipientGUID();
			$senderGuid = $notification->getSenderGUID();
			$subject = $notification->subject;
			$body = $notification->body;
			$params = $notification->params;
			return (bool)_elgg_notify_user($userGuid, $senderGuid, $subject, $body, $params, array($method));
		}
	}

	/**
	 * Register a deprecated notification handler
	 * 
	 * @param string $method  Method name
	 * @param string $handler Handler callback
	 * @return void
	 */
	public function registerDeprecatedHandler($method, $handler) {
		$this->deprHandlers[$method] = $handler;
	}

	/**
	 * Get a deprecated notification handler callback
	 * 
	 * @param string $method Method name
	 * @return callback|null
	 */
	public function getDeprecatedHandler($method) {
		if (isset($this->deprHandlers[$method])) {
			return $this->deprHandlers[$method];
		} else {
			return null;
		}
	}

	/**
	 * Provides a way to incrementally wean Elgg's notifications code from the
	 * global $NOTIFICATION_HANDLERS
	 * 
	 * @return array
	 */
	public function getMethodsAsDeprecatedGlobal() {
		$data = array();
		foreach ($this->methods as $method) {
			$data[$method] = 'empty';
		}
		return $data;
	}

	/**
	 * Get the notification body using a pre-Elgg 1.9 plugin hook
	 * 
	 * @param \Elgg\Notifications\Notification $notification Notification
	 * @param \Elgg\Notifications\Event        $event        Event
	 * @param string                           $method       Method
	 * @return \Elgg\Notifications\Notification
	 */
	protected function getDeprecatedNotificationBody(\Elgg\Notifications\Notification $notification, \Elgg\Notifications\Event $event, $method) {
		$entity = $event->getObject();
		$params = array(
			'entity' => $entity,
			'to_entity' => $notification->getRecipient(),
			'method' => $method,
		);
		$subject = $this->getDeprecatedNotificationSubject($entity->getType(), $entity->getSubtype());
		$string = $subject . ": " . $entity->getURL();
		$body = $this->hooks->trigger('notify:entity:message', $entity->getType(), $params, $string);

		if ($subject) {
			$notification->subject = $subject;
			$notification->body = $body;
		}

		return $notification;
	}

	/**
	 * Set message subject for deprecated notification code
	 * 
	 * @param string $type    Entity type
	 * @param string $subtype Entity subtype
	 * @param string $subject Subject line
	 * @return void
	 */
	public function setDeprecatedNotificationSubject($type, $subtype, $subject) {
		if ($type == '') {
			$type = '__BLANK__';
		}
		if ($subtype == '') {
			$subtype = '__BLANK__';
		}

		if (!isset($this->deprSubjects[$type])) {
			$this->deprSubjects[$type] = array();
		}

		$this->deprSubjects[$type][$subtype] = $subject;
	}

	/**
	 * Get the deprecated subject
	 * 
	 * @param string $type    Entity type
	 * @param string $subtype Entity subtype
	 * @return string
	 */
	protected function getDeprecatedNotificationSubject($type, $subtype) {
		if ($type == '') {
			$type = '__BLANK__';
		}
		if ($subtype == '') {
			$subtype = '__BLANK__';
		}

		if (!isset($this->deprSubjects[$type])) {
			return '';
		}

		if (!isset($this->deprSubjects[$type][$subtype])) {
			return '';
		}

		return $this->deprSubjects[$type][$subtype];
	}

	/**
	 * Is someone using the deprecated override
	 * 
	 * @param \Elgg\Notifications\Event $event Event
	 * @return boolean
	 */
	protected function existsDeprecatedNotificationOverride(\Elgg\Notifications\Event $event) {
		$entity = $event->getObject();
		if (!elgg_instanceof($entity)) {
			return false;
		}
		$params = array(
			'event' => $event->getAction(),
			'object_type' => $entity->getType(),
			'object' => $entity,
		);
		$hookresult = $this->hooks->trigger('object:notifications', $entity->getType(), $params, false);
		if ($hookresult === true) {
			elgg_deprecated_notice("Using the plugin hook 'object:notifications' has been deprecated by the hook 'send:before', 'notifications'", 1.9);
			return true;
		} else {
			return false;
		}
	}
}


1		<?php
2		namespace Elgg\Notifications;
3
4		use ElggEntity;
5
6		/**
7		* WARNING: API IN FLUX. DO NOT USE DIRECTLY.
8		*
9		* @access private
10		*
11		* @package Elgg.Core
12		* @subpackage Notifications
13		* @since 1.9.0
14		*/
15		class NotificationsService {
16
17		const QUEUE_NAME = 'notifications';
18
19		/** @var \Elgg\Notifications\SubscriptionsService */
20		protected $subscriptions;
21
22		/** @var \Elgg\Queue\Queue */
23		protected $queue;
24
25		/** @var \Elgg\PluginHooksService */
26		protected $hooks;
27
28		/** @var \ElggSession */
29		protected $session;
30
31		/** @var array Registered notification events */
32		protected $events = array();
33
34		/** @var array Registered notification methods */
35		protected $methods = array();
36
37		/** @var array Deprecated notification handlers */
38		protected $deprHandlers = array();
39
40		/** @var array Deprecated message subjects */
41		protected $deprSubjects = array();
42
43		/**
44		* Constructor
45		*
46		* @param \Elgg\Notifications\SubscriptionsService $subscriptions Subscription service
47		* @param \Elgg\Queue\Queue $queue Queue
48		* @param \Elgg\PluginHooksService $hooks Plugin hook service
49		* @param \ElggSession $session Session service
50		*/
51	10	public function __construct(\Elgg\Notifications\SubscriptionsService $subscriptions,
52		\Elgg\Queue\Queue $queue, \Elgg\PluginHooksService $hooks, \ElggSession $session) {
53	10	$this->subscriptions = $subscriptions;
54	10	$this->queue = $queue;
55	10	$this->hooks = $hooks;
56	10	$this->session = $session;
57	10	}
58
59		/**
60		* @see elgg_register_notification_event()
61		* @access private
62		*/
63	7	public function registerEvent($type, $subtype, array $actions = array()) {
64
65	7	if (!isset($this->events[$type])) {
66	7	$this->events[$type] = array();
67	7	}
68	7	if (!isset($this->events[$type][$subtype])) {
69	7	$this->events[$type][$subtype] = array();
70	7	}
71
72	7	$action_list =& $this->events[$type][$subtype];
73	7	if ($actions) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The expression `$actions` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
74	1	$action_list = array_unique(array_merge($action_list, $actions));
75	7	} elseif (!in_array('create', $action_list)) {
76	7	$action_list[] = 'create';
77	7	}
78	7	}
79
80		/**
81		* @see elgg_unregister_notification_event()
82		* @access private
83		*/
84	1	public function unregisterEvent($type, $subtype) {
85
86	1	if (!isset($this->events[$type]) \|\| !isset($this->events[$type][$subtype])) {
87	1	return false;
88		}
89
90	1	unset($this->events[$type][$subtype]);
91
92	1	return true;
93		}
94
95		/**
96		* @access private
97		*/
98	2	public function getEvents() {
99	2	return $this->events;
100		}
101
102		/**
103		* @see elgg_register_notification_method()
104		* @access private
105		*/
106	2	public function registerMethod($name) {
107	2	$this->methods[$name] = $name;
108	2	}
109
110		/**
111		* @see elgg_unregister_notification_method()
112		* @access private
113		*/
114	1	public function unregisterMethod($name) {
115	1	if (isset($this->methods[$name])) {
116	1	unset($this->methods[$name]);
117	1	return true;
118		}
119	1	return false;
120		}
121
122		/**
123		* @access private
124		*/
125	2	public function getMethods() {
126	2	return $this->methods;
127		}
128
129		/**
130		* Add a notification event to the queue
131		*
132		* @param string $action Action name
133		* @param string $type Type of the object of the action
134		* @param \ElggData $object The object of the action
135		* @return void
136		* @access private
137		*/
138	5	public function enqueueEvent($action, $type, $object) {
139	5	if ($object instanceof \ElggData) {
140	5	$object_type = $object->getType();
141	5	$object_subtype = $object->getSubtype();
142
143	5	$registered = false;
144	5	if (isset($this->events[$object_type])
145	5	&& isset($this->events[$object_type][$object_subtype])
146	5	&& in_array($action, $this->events[$object_type][$object_subtype])) {
147	5	$registered = true;
148	5	}
149
150	5	if ($registered) {
151		$params = array(
152	5	'action' => $action,
153	5	'object' => $object,
154	5	);
155	5	$registered = $this->hooks->trigger('enqueue', 'notification', $params, $registered);
156	5	}
157
158	5	if ($registered) {
159	3	$this->queue->enqueue(new \Elgg\Notifications\Event($object, $action));
160	3	}
161	5	}
162	5	}
163
164		/**
165		* Pull notification events from queue until stop time is reached
166		*
167		* @param int $stopTime The Unix time to stop sending notifications
168		* @return int The number of notification events handled
169		* @access private
170		*/
171	3	public function processQueue($stopTime) {
172
173	3	$this->subscriptions->methods = $this->methods;
174
175	3	$count = 0;
176
177		// @todo grab mutex
178
179	3	$ia = $this->session->setIgnoreAccess(true);
180
181	3	while (time() < $stopTime) {
182		// dequeue notification event
183	2	$event = $this->queue->dequeue();
184	2	if (!$event) {
185	2	break;
186		}
187
188		// test for usage of the deprecated override hook
189	1	if ($this->existsDeprecatedNotificationOverride($event)) {
190		continue;
191		}
192
193	1	$subscriptions = $this->subscriptions->getSubscriptions($event);
194
195		// return false to stop the default notification sender
196	1	$params = array('event' => $event, 'subscriptions' => $subscriptions);
197	1	if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
198	1	$this->sendNotifications($event, $subscriptions);
199	1	}
200	1	$this->hooks->trigger('send:after', 'notifications', $params);
201	1	$count++;
202	1	}
203
204		// release mutex
205
206	3	$this->session->setIgnoreAccess($ia);
207
208	3	return $count;
209		}
210
211		/**
212		* Sends the notifications based on subscriptions
213		*
214		* @param \Elgg\Notifications\Event $event Notification event
215		* @param array $subscriptions Subscriptions for this event
216		* @return int The number of notifications handled
217		* @access private
218		*/
219	1	protected function sendNotifications($event, $subscriptions) {
220
221	1	if (!$this->methods) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report The expression `$this->methods` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
222	1	return 0;
223		}
224
225		$count = 0;
226		foreach ($subscriptions as $guid => $methods) {
227		foreach ($methods as $method) {
228		if (in_array($method, $this->methods)) {
229		if ($this->sendNotification($event, $guid, $method)) {
230		$count++;
231		}
232		}
233		}
234		}
235		return $count;
236		}
237
238		/**
239		* Send a notification to a subscriber
240		*
241		* @param \Elgg\Notifications\Event $event The notification event
242		* @param int $guid The guid of the subscriber
243		* @param string $method The notification method
244		* @return bool
245		* @access private
246		*/
247	3	protected function sendNotification(\Elgg\Notifications\Event $event, $guid, $method) {
248
249		$recipient = get_user($guid);
250		if (!$recipient \|\| $recipient->isBanned()) {
251		return false;
252		}
253
254		// don't notify the creator of the content
255		if ($recipient->getGUID() == $event->getActorGUID()) {
256		return false;
257		}
258
259		$actor = $event->getActor();
260		$object = $event->getObject();
261		if (!$actor \|\| !$object) {
262		return false;
263		}
264
265		if (($object instanceof ElggEntity) && !has_access_to_entity($object, $recipient)) {
		0 ignored issues – show Documentation introduced 2017-09-27 16:16 UTC by Report Bug Copy Issue Report `$recipient` is of type `object<ElggEntity>`, but the function expects a `object<ElggUser>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
266		return false;
267		}
268
269		$language = $recipient->language;
270		$params = array(
271		'event' => $event,
272		'method' => $method,
273		'recipient' => $recipient,
274		'language' => $language,
275		'object' => $object,
276		);
277
278		$subject = _elgg_services()->translator->translate('notification:subject', array($actor->name), $language);
279	3	$body = _elgg_services()->translator->translate('notification:body', array($object->getURL()), $language);
280		$notification = new \Elgg\Notifications\Notification($event->getActor(), $recipient, $language, $subject, $body, '', $params);
281
282		$type = 'notification:' . $event->getDescription();
283		if ($this->hooks->hasHandler('prepare', $type)) {
284		$notification = $this->hooks->trigger('prepare', $type, $params, $notification);
285		} else {
286		// pre Elgg 1.9 notification message generation
287		$notification = $this->getDeprecatedNotificationBody($notification, $event, $method);
288		}
289
290		if ($this->hooks->hasHandler('send', "notification:$method")) {
291		// return true to indicate the notification has been sent
292		$params = array(
293		'notification' => $notification,
294		'event' => $event,
295		);
296		return $this->hooks->trigger('send', "notification:$method", $params, false);
297		} else {
298		// pre Elgg 1.9 notification handler
299		$userGuid = $notification->getRecipientGUID();
300		$senderGuid = $notification->getSenderGUID();
301		$subject = $notification->subject;
302		$body = $notification->body;
303		$params = $notification->params;
304		return (bool)_elgg_notify_user($userGuid, $senderGuid, $subject, $body, $params, array($method));
305		}
306		}
307
308		/**
309		* Register a deprecated notification handler
310		*
311		* @param string $method Method name
312		* @param string $handler Handler callback
313		* @return void
314		*/
315		public function registerDeprecatedHandler($method, $handler) {
316		$this->deprHandlers[$method] = $handler;
317		}
318
319		/**
320		* Get a deprecated notification handler callback
321		*
322		* @param string $method Method name
323		* @return callback\|null
324		*/
325		public function getDeprecatedHandler($method) {
326		if (isset($this->deprHandlers[$method])) {
327		return $this->deprHandlers[$method];
328		} else {
329		return null;
330		}
331		}
332
333		/**
334		* Provides a way to incrementally wean Elgg's notifications code from the
335		* global $NOTIFICATION_HANDLERS
336		*
337		* @return array
338		*/
339		public function getMethodsAsDeprecatedGlobal() {
340		$data = array();
341		foreach ($this->methods as $method) {
342		$data[$method] = 'empty';
343		}
344		return $data;
345		}
346
347		/**
348		* Get the notification body using a pre-Elgg 1.9 plugin hook
349		*
350		* @param \Elgg\Notifications\Notification $notification Notification
351		* @param \Elgg\Notifications\Event $event Event
352		* @param string $method Method
353		* @return \Elgg\Notifications\Notification
354		*/
355		protected function getDeprecatedNotificationBody(\Elgg\Notifications\Notification $notification, \Elgg\Notifications\Event $event, $method) {
356		$entity = $event->getObject();
357		$params = array(
358		'entity' => $entity,
359		'to_entity' => $notification->getRecipient(),
360		'method' => $method,
361		);
362		$subject = $this->getDeprecatedNotificationSubject($entity->getType(), $entity->getSubtype());
363		$string = $subject . ": " . $entity->getURL();
364		$body = $this->hooks->trigger('notify:entity:message', $entity->getType(), $params, $string);
365
366		if ($subject) {
367		$notification->subject = $subject;
368		$notification->body = $body;
369		}
370
371		return $notification;
372		}
373
374		/**
375		* Set message subject for deprecated notification code
376		*
377		* @param string $type Entity type
378		* @param string $subtype Entity subtype
379		* @param string $subject Subject line
380		* @return void
381		*/
382		public function setDeprecatedNotificationSubject($type, $subtype, $subject) {
383		if ($type == '') {
384		$type = '__BLANK__';
385		}
386		if ($subtype == '') {
387		$subtype = '__BLANK__';
388		}
389
390		if (!isset($this->deprSubjects[$type])) {
391		$this->deprSubjects[$type] = array();
392		}
393
394		$this->deprSubjects[$type][$subtype] = $subject;
395		}
396
397		/**
398		* Get the deprecated subject
399		*
400		* @param string $type Entity type
401		* @param string $subtype Entity subtype
402		* @return string
403		*/
404		protected function getDeprecatedNotificationSubject($type, $subtype) {
405		if ($type == '') {
406		$type = '__BLANK__';
407		}
408		if ($subtype == '') {
409		$subtype = '__BLANK__';
410		}
411
412		if (!isset($this->deprSubjects[$type])) {
413		return '';
414		}
415
416		if (!isset($this->deprSubjects[$type][$subtype])) {
417		return '';
418		}
419
420		return $this->deprSubjects[$type][$subtype];
421		}
422
423		/**
424		* Is someone using the deprecated override
425		*
426		* @param \Elgg\Notifications\Event $event Event
427		* @return boolean
428		*/
429	1	protected function existsDeprecatedNotificationOverride(\Elgg\Notifications\Event $event) {
430	1	$entity = $event->getObject();
431	1	if (!elgg_instanceof($entity)) {
432	1	return false;
433		}
434		$params = array(
435		'event' => $event->getAction(),
436		'object_type' => $entity->getType(),
437		'object' => $entity,
438		);
439		$hookresult = $this->hooks->trigger('object:notifications', $entity->getType(), $params, false);
440		if ($hookresult === true) {
441		elgg_deprecated_notice("Using the plugin hook 'object:notifications' has been deprecated by the hook 'send:before', 'notifications'", 1.9);
442		return true;
443		} else {
444		return false;
445		}
446		}
447		}
448

gctools-outilsgc / gcconnex

Push — solr-auth-refactor ( 3bee90 )

NotificationsService::enqueueEvent() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like