NotificationEvent::getNotificationsByUser() - Code Metrics - Inspection of "Merge branch 'master' of github.com:chamilo/chamil..." - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 84ec90...aaa5ed )

by Yannick

created 2024-03-05 23:11 UTC

NotificationEvent::getNotificationsByUser() D

↳ Parent: NotificationEvent

Complexity

Conditions	18
Paths	34

Size

Total Lines	91
Code Lines	59

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	18
eloc	59
c	1
b	0
f	0
nc	34
nop	1
dl	0
loc	91
rs	4.8666

How to fix Long Method Complexity

<?php
/* For licensing terms, see /license.txt */

class NotificationEvent extends Model
{
    const ACCOUNT_EXPIRATION = 1;
    const JUSTIFICATION_EXPIRATION = 2;
    public $table;
    public $columns = [
        'id',
        'title',
        'content',
        'link',
        'persistent',
        'day_diff',
        'event_type',
        'event_id',
    ];
    public string $extraFieldName;

    /**
     * Constructor.
     */
    public function __construct()
    {
        parent::__construct();
        $this->table = 'notification_event';
        $this->extraFieldName = 'notification_event';
    }

    public function eventTypeToString($eventTypeId)
    {
        $list = $this->getEventsForSelect();

        return $list[$eventTypeId];
    }

    public function getEventsForSelect()
    {
        return [
            self::ACCOUNT_EXPIRATION => get_lang('AccountExpiration'),
            self::JUSTIFICATION_EXPIRATION => get_lang('JustificationExpiration'),
        ];
    }

    /**
     * Get a prepared FormValidator form (passed as first param) with the justification fields
     * @param FormValidator $form
     * @param array $data
     * @return FormValidator
     * @throws Exception
     */
    public function getForm(FormValidator $form, array $data = []): FormValidator
    {
        $options = $this->getEventsForSelect();
        $form->addSelect('event_type', get_lang('EventType'), $options);
        $form->freeze('event_type');

        $eventType = $data['event_type'];
        switch ($eventType) {
            case self::JUSTIFICATION_EXPIRATION:
                $plugin = Justification::create();
                $list = $plugin->getList();
                $list = array_column($list, 'name', 'id');
                $form->addSelect('event_id', get_lang('JustificationType'), $list);
                $form->freeze('event_id');

                break;
            default:
                break;
        }

        $form->addText('title', get_lang('Title'));
        $form->addTextarea('content', get_lang('Content'));
        $form->addText('link', get_lang('Link'), false);
        $form->addCheckBox('persistent', get_lang('Persistent'));
        $form->addNumeric('day_diff', get_lang('DayDiff'), false);

        return $form;
    }

    /**
     * Get addition form for the justification notification
     * @param FormValidator $form
     * @return FormValidator
     * @throws Exception
     */
    public function getAddForm(FormValidator $form): FormValidator
    {
        $options = $this->getEventsForSelect();
        $eventType = $form->getSubmitValue('event_type');

        $form->addSelect(
            'event_type',
            get_lang('EventType'),
            $options,
            ['placeholder' => get_lang('Please select an option'), 'onchange' => 'document.add.submit()']
        );

        if (!empty($eventType)) {
            $form->freeze('event_type');
            $form->addText('title', get_lang('Title'));
            $form->addTextarea('content', get_lang('Content'));
            $form->addText('link', get_lang('Link'), false);
            $form->addCheckBox('persistent', get_lang('Persistent'));
            $form->addNumeric('day_diff', get_lang('Time difference'), false);

            switch ($eventType) {
                case self::JUSTIFICATION_EXPIRATION:
                    $plugin = Justification::create();
                    $list = $plugin->getList();
                    $list = array_column($list, 'name', 'id');
                    $form->addSelect('event_id', get_lang('Justification type'), $list);
                    break;
                default:
                    break;
            }
            $form->addButtonSave(get_lang('Save'));
        }

        return $form;
    }

    /**
     * Get notification-related user's extra field value
     * @param int $userId
     * @return string
     */
    public function getUserExtraData(int $userId): string
    {
        $data = UserManager::get_extra_user_data_by_field($userId, $this->extraFieldName);

        return isset($data['notification_event']) ? $data['notification_event'] : '';
    }

    public function getNotificationsByUser($userId)
    {
        $userInfo = api_get_user_info($userId);
        $events = $this->get_all();
        $extraFieldData = $this->getUserExtraData(api_get_user_id());
        $allowJustification = 'true' === api_get_plugin_setting('justification', 'tool_enable');

        $userJustificationList = [];
        if ($allowJustification) {
            $plugin = Justification::create();
            $userJustificationList = $plugin->getUserJustificationList($userId);
        }

        $notifications = [];
        foreach ($events as $event) {
            $days = (int) $event['day_diff'];
            $checkIsRead = 0 == $event['persistent'] ? true : false;
            $eventItemId = $event['event_id'];

            switch ($event['event_type']) {
                case self::ACCOUNT_EXPIRATION:
                    if (empty($userInfo['expiration_date'])) {
                        break;
                    }

                    $id = 'id_'.self::ACCOUNT_EXPIRATION.'_event_'.$event['id'].'_'.$userInfo['id'];

                    $read = false;
                    if ($checkIsRead) {
                        $read = $this->isRead($id, $extraFieldData);
                    }

                    $showNotification = $this->showNotification($userInfo['expiration_date'], $days);
                    if ($showNotification && false === $read) {
                        $notifications[] = [
                            'id' => $id,
                            'title' => $event['title'],
                            'content' => $event['content'],
                            'event_text' => get_lang('ExpirationDate').': '.api_get_local_time($userInfo['expiration_date']),
                            'link' => $event['link'],
                            'persistent' => $event['persistent'],
                        ];
                    }
                    break;
                case self::JUSTIFICATION_EXPIRATION:
                    if (!empty($userJustificationList)) {
                        foreach ($userJustificationList as $userJustification) {
                            if (empty($userJustification['date_validity'])) {
                                continue;
                            }

                            if ($eventItemId != $userJustification['justification_document_id']) {
                                continue;
                            }

                            $showNotification = $this->showNotification($userJustification['date_validity'], $days);

                            $id = 'id_'.self::JUSTIFICATION_EXPIRATION.'_event_'.$event['id'].'_'.$userJustification['id'];

                            $fieldData = $plugin->getJustification($userJustification['justification_document_id']);


                            $read = false;
                            if ($checkIsRead) {
                                $read = $this->isRead($id, $extraFieldData);
                            }

                            $eventText = $plugin->get_lang('Justification').': '.$fieldData['name'].' <br />';
                            $eventText .= $plugin->get_lang('Justification expiration').': '.$userJustification['date_validity'];

                            $url = $event['link'];
                            if (empty($url)) {
                                $url = api_get_path(WEB_CODE_PATH).'auth/justification.php#'.$fieldData['code'];
                            }

                            if ($showNotification && false === $read) {
                                $notifications[] = [
                                    'id' => $id,
                                    'title' => $event['title'],
                                    'content' => $event['content'],
                                    'event_text' => $eventText,
                                    'link' => $url,
                                    'persistent' => $event['persistent'],
                                ];
                            }
                        }
                    }
                    break;
            }
        }

        return $notifications;
    }

    /**
     * Returns whether a notification has already been read by the user or not
     * @param int    $id
     * @param string $extraData
     * @return bool
     */
    public function isRead(int $id, string $extraData): bool
    {
        $userId = api_get_user_id();

        if (empty($extraData)) {
            return false;
        }

        $data = $this->getUserExtraData($userId);
        if (empty($data)) {
            return false;
        }

        $data = json_decode($data);

        if (in_array($id, $data)) {
            return true;
        }

        return false;
    }

    /**
     * Mark a notification as read by the user
     * @param int $id
     * @return bool
     */
    public function markAsRead(int $id): bool
    {
        if (empty($id)) {
            return false;
        }
        $userId = api_get_user_id();
        $data = $this->getUserExtraData($userId);
        if (!empty($data)) {
            $data = json_decode($data);
        } else {
            $data = [];
        }
        $data[] = $id;
        $data = json_encode($data);

        UserManager::update_extra_field_value($userId, $this->extraFieldName, $data);

        return true;
    }

    /**
     * Returns whether to show some notification or not based on dates
     * @param string $date
     * @param int $dayDiff
     * @return bool
     * @throws Exception
     */
    public function showNotification(string $date, int $dayDiff): bool
    {
        $today = api_get_utc_datetime();
        $dayDiff = (string) $dayDiff;
        $expiration = api_get_utc_datetime($date, false, true);
        $interval = new DateInterval('P'.$dayDiff.'D');
        $diff = $expiration->sub($interval);

        if ($diff->format('Y-m-d H:i:s') < $today) {
            return true;
        }

        return false;
    }
}


1			<?php
2			/* For licensing terms, see /license.txt */
3
4			class NotificationEvent extends Model
5			{
6			const ACCOUNT_EXPIRATION = 1;
7			const JUSTIFICATION_EXPIRATION = 2;
8			public $table;
9			public $columns = [
10			'id',
11			'title',
12			'content',
13			'link',
14			'persistent',
15			'day_diff',
16			'event_type',
17			'event_id',
18			];
19			public string $extraFieldName;
20
21			/**
22			* Constructor.
23			*/
24			public function __construct()
25			{
26			parent::__construct();
27			$this->table = 'notification_event';
28			$this->extraFieldName = 'notification_event';
29			}
30
31			public function eventTypeToString($eventTypeId)
32			{
33			$list = $this->getEventsForSelect();
34
35			return $list[$eventTypeId];
36			}
37
38			public function getEventsForSelect()
39			{
40			return [
41			self::ACCOUNT_EXPIRATION => get_lang('AccountExpiration'),
42			self::JUSTIFICATION_EXPIRATION => get_lang('JustificationExpiration'),
43			];
44			}
45
46			/**
47			* Get a prepared FormValidator form (passed as first param) with the justification fields
48			* @param FormValidator $form
49			* @param array $data
50			* @return FormValidator
51			* @throws Exception
52			*/
53			public function getForm(FormValidator $form, array $data = []): FormValidator
54			{
55			$options = $this->getEventsForSelect();
56			$form->addSelect('event_type', get_lang('EventType'), $options);
57			$form->freeze('event_type');
58
59			$eventType = $data['event_type'];
60			switch ($eventType) {
61			case self::JUSTIFICATION_EXPIRATION:
62			$plugin = Justification::create();
63			$list = $plugin->getList();
64			$list = array_column($list, 'name', 'id');
65			$form->addSelect('event_id', get_lang('JustificationType'), $list);
66			$form->freeze('event_id');
67
68			break;
69			default:
70			break;
71			}
72
73			$form->addText('title', get_lang('Title'));
74			$form->addTextarea('content', get_lang('Content'));
75			$form->addText('link', get_lang('Link'), false);
76			$form->addCheckBox('persistent', get_lang('Persistent'));
77			$form->addNumeric('day_diff', get_lang('DayDiff'), false);
78
79			return $form;
80			}
81
82			/**
83			* Get addition form for the justification notification
84			* @param FormValidator $form
85			* @return FormValidator
86			* @throws Exception
87			*/
88			public function getAddForm(FormValidator $form): FormValidator
89			{
90			$options = $this->getEventsForSelect();
91			$eventType = $form->getSubmitValue('event_type');
92
93			$form->addSelect(
94			'event_type',
95			get_lang('EventType'),
96			$options,
97			['placeholder' => get_lang('Please select an option'), 'onchange' => 'document.add.submit()']
98			);
99
100			if (!empty($eventType)) {
101			$form->freeze('event_type');
102			$form->addText('title', get_lang('Title'));
103			$form->addTextarea('content', get_lang('Content'));
104			$form->addText('link', get_lang('Link'), false);
105			$form->addCheckBox('persistent', get_lang('Persistent'));
106			$form->addNumeric('day_diff', get_lang('Time difference'), false);
107
108			switch ($eventType) {
109			case self::JUSTIFICATION_EXPIRATION:
110			$plugin = Justification::create();
111			$list = $plugin->getList();
112			$list = array_column($list, 'name', 'id');
113			$form->addSelect('event_id', get_lang('Justification type'), $list);
114			break;
115			default:
116			break;
117			}
118			$form->addButtonSave(get_lang('Save'));
119			}
120
121			return $form;
122			}
123
124			/**
125			* Get notification-related user's extra field value
126			* @param int $userId
127			* @return string
128			*/
129			public function getUserExtraData(int $userId): string
130			{
131			$data = UserManager::get_extra_user_data_by_field($userId, $this->extraFieldName);
132
133			return isset($data['notification_event']) ? $data['notification_event'] : '';
134			}
135
136			public function getNotificationsByUser($userId)
137			{
138			$userInfo = api_get_user_info($userId);
139			$events = $this->get_all();
140			$extraFieldData = $this->getUserExtraData(api_get_user_id());
141			$allowJustification = 'true' === api_get_plugin_setting('justification', 'tool_enable');
142
143			$userJustificationList = [];
144			if ($allowJustification) {
145			$plugin = Justification::create();
146			$userJustificationList = $plugin->getUserJustificationList($userId);
147			}
148
149			$notifications = [];
150			foreach ($events as $event) {
151			$days = (int) $event['day_diff'];
152			$checkIsRead = 0 == $event['persistent'] ? true : false;
153			$eventItemId = $event['event_id'];
154
155			switch ($event['event_type']) {
156			case self::ACCOUNT_EXPIRATION:
157			if (empty($userInfo['expiration_date'])) {
158			break;
159			}
160
161			$id = 'id_'.self::ACCOUNT_EXPIRATION.'_event_'.$event['id'].'_'.$userInfo['id'];
162
163			$read = false;
164			if ($checkIsRead) {
165			$read = $this->isRead($id, $extraFieldData);
166			}
167
168			$showNotification = $this->showNotification($userInfo['expiration_date'], $days);
169			if ($showNotification && false === $read) {
170			$notifications[] = [
171			'id' => $id,
172			'title' => $event['title'],
173			'content' => $event['content'],
174			'event_text' => get_lang('ExpirationDate').': '.api_get_local_time($userInfo['expiration_date']),
175			'link' => $event['link'],
176			'persistent' => $event['persistent'],
177			];
178			}
179			break;
180			case self::JUSTIFICATION_EXPIRATION:
181			if (!empty($userJustificationList)) {
182			foreach ($userJustificationList as $userJustification) {
183			if (empty($userJustification['date_validity'])) {
184			continue;
185			}
186
187			if ($eventItemId != $userJustification['justification_document_id']) {
188			continue;
189			}
190
191			$showNotification = $this->showNotification($userJustification['date_validity'], $days);
192
193			$id = 'id_'.self::JUSTIFICATION_EXPIRATION.'_event_'.$event['id'].'_'.$userJustification['id'];
194
195			$fieldData = $plugin->getJustification($userJustification['justification_document_id']);
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-12-13 13:45 UTC by Report Bug Copy Issue Report The variable `$plugin` does not seem to be defined for all execution paths leading up to this point. Loading history...
196
197			$read = false;
198			if ($checkIsRead) {
199			$read = $this->isRead($id, $extraFieldData);
200			}
201
202			$eventText = $plugin->get_lang('Justification').': '.$fieldData['name'].' <br />';
203			$eventText .= $plugin->get_lang('Justification expiration').': '.$userJustification['date_validity'];
204
205			$url = $event['link'];
206			if (empty($url)) {
207			$url = api_get_path(WEB_CODE_PATH).'auth/justification.php#'.$fieldData['code'];
208			}
209
210			if ($showNotification && false === $read) {
211			$notifications[] = [
212			'id' => $id,
213			'title' => $event['title'],
214			'content' => $event['content'],
215			'event_text' => $eventText,
216			'link' => $url,
217			'persistent' => $event['persistent'],
218			];
219			}
220			}
221			}
222			break;
223			}
224			}
225
226			return $notifications;
227			}
228
229			/**
230			* Returns whether a notification has already been read by the user or not
231			* @param int $id
232			* @param string $extraData
233			* @return bool
234			*/
235			public function isRead(int $id, string $extraData): bool
236			{
237			$userId = api_get_user_id();
238
239			if (empty($extraData)) {
240			return false;
241			}
242
243			$data = $this->getUserExtraData($userId);
244			if (empty($data)) {
245			return false;
246			}
247
248			$data = json_decode($data);
249
250			if (in_array($id, $data)) {
251			return true;
252			}
253
254			return false;
255			}
256
257			/**
258			* Mark a notification as read by the user
259			* @param int $id
260			* @return bool
261			*/
262			public function markAsRead(int $id): bool
263			{
264			if (empty($id)) {
265			return false;
266			}
267			$userId = api_get_user_id();
268			$data = $this->getUserExtraData($userId);
269			if (!empty($data)) {
270			$data = json_decode($data);
271			} else {
272			$data = [];
273			}
274			$data[] = $id;
275			$data = json_encode($data);
276
277			UserManager::update_extra_field_value($userId, $this->extraFieldName, $data);
278
279			return true;
280			}
281
282			/**
283			* Returns whether to show some notification or not based on dates
284			* @param string $date
285			* @param int $dayDiff
286			* @return bool
287			* @throws Exception
288			*/
289			public function showNotification(string $date, int $dayDiff): bool
290			{
291			$today = api_get_utc_datetime();
292			$dayDiff = (string) $dayDiff;
293			$expiration = api_get_utc_datetime($date, false, true);
294			$interval = new DateInterval('P'.$dayDiff.'D');
295			$diff = $expiration->sub($interval);
296
297			if ($diff->format('Y-m-d H:i:s') < $today) {
298			return true;
299			}
300
301			return false;
302			}
303			}
304

chamilo / chamilo-lms

Push — master ( 84ec90...aaa5ed )

NotificationEvent::getNotificationsByUser() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like