PauseTraining::updateUserPauseTraining() - Code Metrics - Inspection of "Update libs" - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a73e85...13dd2e )

by Julito

created 2020-07-17 06:42 UTC

PauseTraining::updateUserPauseTraining() B

↳ Parent: PauseTraining

Complexity

Conditions	9
Paths	34

Size

Total Lines	63
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	9
eloc	37
c	1
b	0
f	0
nc	34
nop	2
dl	0
loc	63
rs	7.7724

How to fix Long Method

<?php

/* For licensing terms, see /license.txt */

class PauseTraining extends Plugin
{
    public $isCoursePlugin = false;

    protected function __construct()
    {
        parent::__construct(
            '0.1',
            'Julio Montoya',
            [
                'tool_enable' => 'boolean',
                'allow_users_to_edit_pause_formation' => 'boolean',
                'cron_alert_users_if_inactive_days' => 'text', // Example: "5" or "5,10,15"
            ]
        );
    }

    public static function create()
    {
        static $result = null;

        return $result ? $result : $result = new self();
    }

    public function updateUserPauseTraining($userId, $values)
    {
        $userInfo = api_get_user_info($userId);
        if (empty($userInfo)) {
            throw new Exception("User #$userId does not exists");
        }

        $variables = [
            'pause_formation',
            'start_pause_date',
            'end_pause_date',
            'allow_notifications',
        ];

        $valuesToUpdate = [
            'item_id' => $userId,
        ];

        // Check if variables exist.
        foreach ($variables as $variable) {
            if (!isset($values[$variable])) {
                throw new Exception("Variable '$variable' is missing. Cannot updated.");
            }

            $valuesToUpdate['extra_'.$variable] = $values[$variable];
        }

        // Clean variables
        $pause = (int) $valuesToUpdate['extra_pause_formation'];
        if (empty($pause)) {
            $valuesToUpdate['extra_pause_formation'] = 0;
        } else {
            $valuesToUpdate['extra_pause_formation'] = [];
            $valuesToUpdate['extra_pause_formation']['extra_pause_formation'] = $pause;
        }

        $notification = (int) $valuesToUpdate['extra_allow_notifications'];
        if (empty($notification)) {
            $valuesToUpdate['extra_allow_notifications'] = 0;
        } else {
            $valuesToUpdate['extra_allow_notifications'] = [];
            $valuesToUpdate['extra_allow_notifications']['extra_allow_notifications'] = $notification;
        }

        $check = DateTime::createFromFormat('Y-m-d H:i', $valuesToUpdate['extra_start_pause_date']);

        if (false === $check) {
            throw new Exception("start_pause_date is not valid date time format should be: Y-m-d H:i");
        }

        $check = DateTime::createFromFormat('Y-m-d H:i', $valuesToUpdate['extra_end_pause_date']);
        if (false === $check) {
            throw new Exception("end_pause_date is not valid date time format should be: Y-m-d H:i");
        }

        if (api_strtotime($valuesToUpdate['extra_start_pause_date']) > api_strtotime($valuesToUpdate['extra_end_pause_date'])) {
            throw new Exception("end_pause_date must be bigger than start_pause_date");
        }

        $extraField = new ExtraFieldValue('user');
        $extraField->saveFieldValues($valuesToUpdate, true, false, [], [], true);

        return (int) $userId;
    }

    public function runCron()
    {
        $enable = $this->get('tool_enable');
        $enableDays = $this->get('cron_alert_users_if_inactive_days');

        if ($enable && !empty($enableDays)) {
            $enableDaysList = explode(',', $enableDays);
            rsort($enableDaysList);

            $loginTable = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
            $userTable = Database::get_main_table(TABLE_MAIN_USER);
            $now = api_get_utc_datetime();
            $usersNotificationPerDay = [];
            $users = [];
            foreach ($enableDaysList as $day) {
                $day = (int) $day;

                $sql = "SELECT
                        stats_login.user_id,
                        MAX(stats_login.login_course_date) max_date
                        FROM $loginTable stats_login
                        INNER JOIN $userTable u
                        ON (u.id = stats_login.user_id)
                        WHERE
                            u.status <> ".ANONYMOUS." AND
                            u.active = 1
                        GROUP BY stats_login.user_id
                        HAVING DATE_SUB('$now', INTERVAL '$day' DAY) > max_date ";

                $rs = Database::query($sql);
                while ($user = Database::fetch_array($rs)) {
                    $userId = $user['user_id'];

                    if (in_array($userId, $users)) {
                        continue;
                    }
                    $users[] = $userId;
                    $usersNotificationPerDay[$day][] = $userId;
                }
            }

            if (!empty($usersNotificationPerDay)) {
                ksort($usersNotificationPerDay);
                $extraFieldValue = new ExtraFieldValue('user');
                foreach ($usersNotificationPerDay as $day => $userList) {
                    $template = new Template();
                    $title = sprintf($this->get_lang('InactivityXDays'), $day);

                    foreach ($userList as $userId) {
                        $userInfo = api_get_user_info($userId);
                        $pause = $extraFieldValue->get_values_by_handler_and_field_variable($userId, 'pause_formation');
                        if (!empty($pause) && isset($pause['value']) && 1 == $pause['value']) {
                            // Skip user because he paused his formation.
                            continue;
                        }

                        $template->assign('days', $day);
                        $template->assign('user', $userInfo);
                        $content = $template->fetch('pausetraining/view/notification_content.tpl');
                        MessageManager::send_message($userId, $title, $content);
                    }
                }
            }
        }
    }

    public function install()
    {
        UserManager::create_extra_field(
            'pause_formation',
            ExtraField::FIELD_TYPE_CHECKBOX,
            $this->get_lang('PauseFormation'),
            ''
        );

        UserManager::create_extra_field(
            'start_pause_date',
            ExtraField::FIELD_TYPE_DATETIME,
            $this->get_lang('StartPauseDateTime'),
            ''
        );

        UserManager::create_extra_field(
            'end_pause_date',
            ExtraField::FIELD_TYPE_DATETIME,
            $this->get_lang('EndPauseDateTime'),
            ''
        );

        UserManager::create_extra_field(
            'allow_notifications',
            ExtraField::FIELD_TYPE_CHECKBOX,
            $this->get_lang('AllowEmailNotification'),
            ''
        );
    }

    public function uninstall()
    {
    }
}


1			<?php
2
3			/* For licensing terms, see /license.txt */
4
5			class PauseTraining extends Plugin
6			{
7			public $isCoursePlugin = false;
8
9			protected function __construct()
10			{
11			parent::__construct(
12			'0.1',
13			'Julio Montoya',
14			[
15			'tool_enable' => 'boolean',
16			'allow_users_to_edit_pause_formation' => 'boolean',
17			'cron_alert_users_if_inactive_days' => 'text', // Example: "5" or "5,10,15"
18			]
19			);
20			}
21
22			public static function create()
23			{
24			static $result = null;
25
26			return $result ? $result : $result = new self();
27			}
28
29			public function updateUserPauseTraining($userId, $values)
30			{
31			$userInfo = api_get_user_info($userId);
32			if (empty($userInfo)) {
33			throw new Exception("User #$userId does not exists");
34			}
35
36			$variables = [
37			'pause_formation',
38			'start_pause_date',
39			'end_pause_date',
40			'allow_notifications',
41			];
42
43			$valuesToUpdate = [
44			'item_id' => $userId,
45			];
46
47			// Check if variables exist.
48			foreach ($variables as $variable) {
49			if (!isset($values[$variable])) {
50			throw new Exception("Variable '$variable' is missing. Cannot updated.");
51			}
52
53			$valuesToUpdate['extra_'.$variable] = $values[$variable];
54			}
55
56			// Clean variables
57			$pause = (int) $valuesToUpdate['extra_pause_formation'];
58			if (empty($pause)) {
59			$valuesToUpdate['extra_pause_formation'] = 0;
60			} else {
61			$valuesToUpdate['extra_pause_formation'] = [];
62			$valuesToUpdate['extra_pause_formation']['extra_pause_formation'] = $pause;
63			}
64
65			$notification = (int) $valuesToUpdate['extra_allow_notifications'];
66			if (empty($notification)) {
67			$valuesToUpdate['extra_allow_notifications'] = 0;
68			} else {
69			$valuesToUpdate['extra_allow_notifications'] = [];
70			$valuesToUpdate['extra_allow_notifications']['extra_allow_notifications'] = $notification;
71			}
72
73			$check = DateTime::createFromFormat('Y-m-d H:i', $valuesToUpdate['extra_start_pause_date']);
74
75			if (false === $check) {
76			throw new Exception("start_pause_date is not valid date time format should be: Y-m-d H:i");
77			}
78
79			$check = DateTime::createFromFormat('Y-m-d H:i', $valuesToUpdate['extra_end_pause_date']);
80			if (false === $check) {
81			throw new Exception("end_pause_date is not valid date time format should be: Y-m-d H:i");
82			}
83
84			if (api_strtotime($valuesToUpdate['extra_start_pause_date']) > api_strtotime($valuesToUpdate['extra_end_pause_date'])) {
85			throw new Exception("end_pause_date must be bigger than start_pause_date");
86			}
87
88			$extraField = new ExtraFieldValue('user');
89			$extraField->saveFieldValues($valuesToUpdate, true, false, [], [], true);
90
91			return (int) $userId;
92			}
93
94			public function runCron()
95			{
96			$enable = $this->get('tool_enable');
97			$enableDays = $this->get('cron_alert_users_if_inactive_days');
98
99			if ($enable && !empty($enableDays)) {
100			$enableDaysList = explode(',', $enableDays);
101			rsort($enableDaysList);
102
103			$loginTable = Database::get_main_table(TABLE_STATISTIC_TRACK_E_COURSE_ACCESS);
104			$userTable = Database::get_main_table(TABLE_MAIN_USER);
105			$now = api_get_utc_datetime();
106			$usersNotificationPerDay = [];
107			$users = [];
108			foreach ($enableDaysList as $day) {
109			$day = (int) $day;
110
111			$sql = "SELECT
112			stats_login.user_id,
113			MAX(stats_login.login_course_date) max_date
114			FROM $loginTable stats_login
115			INNER JOIN $userTable u
116			ON (u.id = stats_login.user_id)
117			WHERE
118			u.status <> ".ANONYMOUS." AND
119			u.active = 1
120			GROUP BY stats_login.user_id
121			HAVING DATE_SUB('$now', INTERVAL '$day' DAY) > max_date ";
122
123			$rs = Database::query($sql);
124			while ($user = Database::fetch_array($rs)) {
125			$userId = $user['user_id'];
126
127			if (in_array($userId, $users)) {
128			continue;
129			}
130			$users[] = $userId;
131			$usersNotificationPerDay[$day][] = $userId;
132			}
133			}
134
135			if (!empty($usersNotificationPerDay)) {
136			ksort($usersNotificationPerDay);
137			$extraFieldValue = new ExtraFieldValue('user');
138			foreach ($usersNotificationPerDay as $day => $userList) {
139			$template = new Template();
140			$title = sprintf($this->get_lang('InactivityXDays'), $day);
141
142			foreach ($userList as $userId) {
143			$userInfo = api_get_user_info($userId);
144			$pause = $extraFieldValue->get_values_by_handler_and_field_variable($userId, 'pause_formation');
145			if (!empty($pause) && isset($pause['value']) && 1 == $pause['value']) {
146			// Skip user because he paused his formation.
147			continue;
148			}
149
150			$template->assign('days', $day);
151			$template->assign('user', $userInfo);
152			$content = $template->fetch('pausetraining/view/notification_content.tpl');
153			MessageManager::send_message($userId, $title, $content);
154			}
155			}
156			}
157			}
158			}
159
160			public function install()
161			{
162			UserManager::create_extra_field(
163			'pause_formation',
164			ExtraField::FIELD_TYPE_CHECKBOX,
165			$this->get_lang('PauseFormation'),
166			''
167			);
168
169			UserManager::create_extra_field(
170			'start_pause_date',
171			ExtraField::FIELD_TYPE_DATETIME,
172			$this->get_lang('StartPauseDateTime'),
173			''
174			);
175
176			UserManager::create_extra_field(
177			'end_pause_date',
178			ExtraField::FIELD_TYPE_DATETIME,
179			$this->get_lang('EndPauseDateTime'),
180			''
181			);
182
183			UserManager::create_extra_field(
184			'allow_notifications',
185			ExtraField::FIELD_TYPE_CHECKBOX,
186			$this->get_lang('AllowEmailNotification'),
187			''
188			);
189			}
190
191			public function uninstall()
192			{
193			}
194			}
195

chamilo / chamilo-lms

Push — master ( a73e85...13dd2e )

PauseTraining::updateUserPauseTraining() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like