Kannelsms - Code Metrics - chamilo/chamilo-lms - Measure and Improve Code Quality continuously with Scrutinizer

Kannelsms A
last analyzed 2025-06-17 20:49 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	645
Duplicated Lines	0 %

Importance

Changes

Metric	Value
eloc	172
dl	0
loc	645
rs	10
c	0
b	0
f	0
wmc	24

5 Methods

Rating	Name	Size	Complexity
A	buildSms()	23	3
C	getSms()	501	13
A	getMobilePhoneNumberById()	14	1
A	send()	18	5
A	__construct()	12	2

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

/**
 * Class Kannelsms
 * This script handles incoming SMS information, process it and sends an SMS if everything is right.
 *
 * @package chamilo.plugin.kannelsms.lib
 *
 * @author  Imanol Losada <[email protected]>
 *
 * Kannelsms-Chamilo connector class
 */
class Kannelsms implements SmsPluginLibraryInterface
{
    public $api;
    public $hostAddress;
    public $username;
    public $password;
    public $from;
    public $plugin_enabled = false;

    /**
     * Constructor (generates a connection to the API).
     *
     * @param   string  Kannelsms API key required to use the plugin
     */
    public function __construct($apiKey = null)
    {
        $plugin = KannelsmsPlugin::create();
        $kannelSMSPlugin = $plugin->get('tool_enable');
        $this->table = Database::get_main_table('user_field_values');
        if ($kannelSMSPlugin == true) {
            $this->api = new Kannel(' ');
            $this->hostAddress = $plugin->get('hostAddress');
            $this->username = $plugin->get('username');
            $this->password = $plugin->get('password');
            $this->from = $plugin->get('from');
            $this->plugin_enabled = true;
        }
    }

    /**
     * getMobilePhoneNumberById (retrieves a user mobile phone number by user id).
     *
     * @param int $userId User id
     *
     * @return int User's mobile phone number
     */
    public function getMobilePhoneNumberById($userId)
    {
        $mobilePhoneNumberExtraField = new ExtraField('user');
        $mobilePhoneNumberExtraField = $mobilePhoneNumberExtraField->get_handler_field_info_by_field_variable(
            'mobile_phone_number'
        );

        $mobilePhoneNumberExtraFieldValue = new ExtraFieldValue('user');
        $mobilePhoneNumberExtraFieldValue = $mobilePhoneNumberExtraFieldValue->get_values_by_handler_and_field_id(
            $userId,
            $mobilePhoneNumberExtraField['id']
        );

        return $mobilePhoneNumberExtraFieldValue['value'];
    }

    /**
     * send (sends an SMS to the user).
     *
     * @param   array   Data needed to send the SMS. It is mandatory to include the
     *                  'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least.
     *                  More data may be neccesary depending on the message type
     * Example: $additional_parameters = array(
     *              'smsType' => EXAMPLE_SMS_TYPE,
     *              'userId' => $userId,
     *              'moreData' => $moreData
     *          );
     */
    public function send($additionalParameters)
    {
        $trimmedKey = trim(CONFIG_SECURITY_API_KEY);
        if (!empty($trimmedKey)) {
            $message = [
                "to" => array_key_exists("mobilePhoneNumber", $additionalParameters) ?
                    $additionalParameters['mobilePhoneNumber'] : $this->getMobilePhoneNumberById($additionalParameters['userId']),
                "message" => $this->getSms($additionalParameters),
            ];

            if (!empty($message['message'])) {
                if (extension_loaded('curl')) {
                    $url = $this->hostAddress.'?username='.
                        $this->username.'&password='.$this->password.'&from='.
                        $this->from.'&to='.$message['to'].'&msg='.urlencode($message['message']);
                    $ch = curl_init($url);
                    curl_exec($ch);
                    curl_close($ch);
                }

                // Commented for future message logging / tracking purposes
                /*if( $result["success"] ) {
                    echo "Message sent - ID: " . $result["id"];
                } else {
                    echo "Message failed - Error: " . $result["error_message"];
                }*/
            }
        }
    }

    /**
     * buildSms (builds an SMS from a template and data).
     *
     * @param   object  KannelsmsPlugin object
     * @param   object  Template object
     * @param   string  Template file name
     * @param   string  Text key from lang file
     * @param   array   Data to fill message variables (if any)
     *
     * @return object Template object with message property updated
     */
    public function buildSms($plugin, $tpl, $templateName, $messageKey, $parameters = null)
    {
        $result = Database::select(
            'selected_value',
            'settings_current',
            [
                'where' => ['variable = ?' => ['kannelsms_message'.$messageKey]],
            ]
        );

        if (empty($result)) {
            $tpl->assign('message', '');
        } else {
            $templatePath = 'kannelsms/sms_templates/';
            $content = $tpl->fetch($templatePath.$templateName);
            $message = $plugin->get_lang($messageKey);
            if ($parameters !== null) {
                $message = vsprintf($message, $parameters);
            }
            $tpl->assign('message', $message);
        }

        return $tpl->params['message'];
    }

    /**
     * getSms (returns an SMS message depending of its type).
     *
     * @param   array   Data needed to send the SMS. It is mandatory to include the
     *                  'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least.
     *                  More data may be neccesary depending on the message type
     * Example: $additional_parameters = array(
     *              'smsType' => EXAMPLE_SMS_TYPE,
     *              'userId' => $userId,
     *              'moreData' => $moreData
     *          );
     *
     * @return string A ready to be sent SMS
     */
    public function getSms($additionalParameters)
    {
        $plugin = KannelsmsPlugin::create();
        $tool_name = $plugin->get_lang('plugin_title');
        $tpl = new Template($tool_name);

        switch ($additionalParameters['smsType']) {
            case SmsPlugin::WELCOME_LOGIN_PASSWORD:
                $userInfo = api_get_user_info($additionalParameters['userId']);

                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'welcome_login_password.tpl',
                    'WelcomeXLoginXPasswordX',
                    [
                        api_get_setting('siteName'),
                        $userInfo['username'],
                        $additionalParameters['password'],
                    ]
                );
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case SmsPlugin::NEW_FILE_SHARED_COURSE_BY:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_file_shared_course_by.tpl',
                    'XNewFileSharedCourseXByX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseTitle'],
                        $additionalParameters['userUsername'],
                    ]
                );
                break;
            case SmsPlugin::ACCOUNT_APPROVED_CONNECT:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'account_approved_connect.tpl',
                    'XAccountApprovedConnectX',
                    [
                        api_get_setting('siteName'),
                        $tpl->params['_p']['web'],
                    ]
                );
                break;
            case SmsPlugin::NEW_COURSE_BEEN_CREATED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_course_been_created.tpl',
                    'XNewCourseXBeenCreatedX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseName'],
                        $additionalParameters['creatorUsername'],
                    ]
                );
                break;
            case SmsPlugin::NEW_USER_SUBSCRIBED_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_user_subscribed_course.tpl',
                    'XNewUserXSubscribedCourseX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['userUsername'],
                        $additionalParameters['courseCode'],
                    ]
                );
                break;
            case SmsPlugin::NEW_COURSE_SUGGESTED_TEACHER:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_course_suggested_teacher.tpl',
                    'XNewCourseSuggestedTeacherX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['userUsername'],
                    ]
                );
                break;
            case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REGISTERED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'course_opening_request_code_registered.tpl',
                    'XCourseOpeningRequestCodeXRegistered',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseCode'],
                    ]
                );
                break;
            case SmsPlugin::COURSE_OPENING_REQUEST_CODE_APPROVED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'course_opening_request_course_code_approved.tpl',
                    'XCourseOpeningRequestCourseCodeXApproved',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseCode'],
                    ]
                );
                break;
            case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REJECTED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'request_open_course_code_rejected.tpl',
                    'XRequestOpenCourseCodeXReject',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseCode'],
                    ]
                );
                break;
            case SmsPlugin::COURSE_OPENING_REQUEST_CODE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'course_opening_request_course_code.tpl',
                    'XCourseOpeningRequestCourseCodeX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseCode'],
                    ]
                );
                break;
            case SmsPlugin::BEEN_SUBSCRIBED_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'been_subscribed_course.tpl',
                    'XBeenSubscribedCourseX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseTitle'],
                    ]
                );
                break;
            case SmsPlugin::ASSIGNMENT_BEEN_CREATED_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'assignment_been_created_course.tpl',
                    'XAssignmentBeenCreatedCourseX',
                    [
                        api_get_setting('siteName'),
                        $additionalParameters['courseTitle'],
                    ]
                );
                break;
            // Message types to be implemented. Fill the array parameter with arguments.
            /*case SmsPlugin::ACCOUNT_CREATED_UPDATED_LOGIN_PASSWORD:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'account_created_updated_login_password.tpl',
                    'XAccountCreatedUpdatedLoginXPasswordX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::PASSWORD_UPDATED_LOGIN_PASSWORD:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'password_updated_login_password.tpl',
                    'XPasswordUpdatedLoginXPasswordX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::REQUESTED_PASSWORD_CHANGE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'requested_password_change.tpl',
                    'XPasswordUpdatedLoginXPasswordX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::RECEIVED_NEW_PERSONAL_MESSAGES:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'received_new_personal_messages.tpl',
                    'XReceivedNewPersonalMessages',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::NEW_USER_PENDING_APPROVAL:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_user_pending_approval.tpl',
                    'XNewUserXPendingApproval',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::POSTED_FORUM_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'posted_forum_course.tpl',
                    'XXPostedForumXCourseX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::CHECK_EMAIL_CONNECT_MORE_INFO:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'check_email_connect_more_info.tpl',
                    'XXXCheckEmailConnectMoreInfo',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::STUDENT_ANSWERED_TEST:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'student_answered_test.tpl',
                    'XXStudentXAnsweredTestX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::STUDENT_ANSWERED_TEST_OPEN_QUESTION:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'student_answered_test_open_question.tpl',
                    'XXStudentXAnsweredTestXOpenQuestion',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::STUDENT_ANSWERED_TEST_VOICE_QUESTION:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'student_answered_test_voice_question.tpl',
                    'XXStudentXAnsweredTestXVoiceQuestion',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::ANSWER_OPEN_QUESTION_TEST_REVIEWED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'answer_open_question_test_reviewed.tpl',
                    'XXAnswerOpenQuestionTestXReviewed',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::NEW_THREAD_STARTED_FORUM:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_thread_started_forum.tpl',
                    'XXNewThreadXStartedForumX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::NEW_ANSWER_POSTED_FORUM:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_answer_posted_forum.tpl',
                    'XXNewAnswerPostedXForumX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::NEW_SYSTEM_ANNOUNCEMENT_ADDED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'new_system_announcement_added.tpl',
                    'XXNewSystemAnnouncementAdded',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::TEST_NEW_SYSTEM_ANNOUNCEMENT_ADDED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'test_new_system_announcement_added.tpl',
                    'XTestXNewSystemAnnouncementAdded',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::SYSTEM_ANNOUNCEMENT_UPDATE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'system_announcement_update.tpl',
                    'XXSystemAnnouncementUpdate',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::TEST_SYSTEM_ANNOUNCEMENT_UPDATE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'test_system_announcement_update.tpl',
                    'XXSystemAnnouncementUpdate',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE_STUDENT_SUBMITS_PAPER:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_uploaded_assignment_course_student_submits_paper.tpl',
                    'XUserXUploadedAssignmentXCourseXStudentSubmitsPaper',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK_STUDENT_SUBMITS_PAPER:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_uploaded_assignment_check_student_submits_paper.tpl',
                    'XUserXUploadedAssignmentXCheckXStudentSubmitsPaper',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_uploaded_assignment_course.tpl',
                    'XUserXUploadedAssignmentXCourseX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_uploaded_assignment_check.tpl',
                    'XUserXUploadedAssignmentXCheckX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::SUBSCRIBED_SESSION:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'subscribed_session.tpl',
                    'XSubscribedSessionX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::SUBSCRIBED_SESSION_CSV:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'subscribed_session_csv.tpl',
                    'XSubscribedSessionXCSV',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_SUGGESTED_BE_FRIENDS:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_suggested_be_friends.tpl',
                    'XUserXSuggestedBeFriends',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_ANSWERED_INBOX_MESSAGE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_answered_inbox_message.tpl',
                    'XUserXAnsweredInboxMessage',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::BEEN_INVITED_JOIN_GROUP:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'been_invited_join_group.tpl',
                    'XBeenInvitedJoinGroupX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_EDITED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'messages_sent_edited_group_edited.tpl',
                    'XMessagesSentEditedGroupXEdited',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_ADDED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'messages_sent_edited_group_added.tpl',
                    'XMessagesSentEditedGroupXAdded',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::BEEN_INVITED_COMPLETE_SURVEY_COURSE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'been_invited_complete_survey_course.tpl',
                    'XBeenInvitedCompleteSurveyXCourseX',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::REMINDER_ASSIGNMENT_COURSE_DUE:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'reminder_assignment_course_due.tpl',
                    'XReminderAssignmentXCourseXDue',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            /*case SmsPlugin::USER_DETAILS_MODIFIED:
                return $this->buildSms(
                    $plugin,
                    $tpl,
                    'user_details_modified.tpl',
                    'XUserDetailsModified',
                    array(
                        api_get_setting('siteName')
                    )
                );
                break;*/
            default:
                return '';
        }
    }
}


1			<?php
2			/* For licensing terms, see /vendor/license.txt */
3
4			/**
5			* Class Kannelsms
6			* This script handles incoming SMS information, process it and sends an SMS if everything is right.
7			*
8			* @package chamilo.plugin.kannelsms.lib
9			*
10			* @author Imanol Losada <[email protected]>
11			*
12			* Kannelsms-Chamilo connector class
13			*/
14			class Kannelsms implements SmsPluginLibraryInterface
15			{
16			public $api;
17			public $hostAddress;
18			public $username;
19			public $password;
20			public $from;
21			public $plugin_enabled = false;
22
23			/**
24			* Constructor (generates a connection to the API).
25			*
26			* @param string Kannelsms API key required to use the plugin
27			*/
28			public function __construct($apiKey = null)
29			{
30			$plugin = KannelsmsPlugin::create();
31			$kannelSMSPlugin = $plugin->get('tool_enable');
32			$this->table = Database::get_main_table('user_field_values');
33			if ($kannelSMSPlugin == true) {
34			$this->api = new Kannel(' ');
35			$this->hostAddress = $plugin->get('hostAddress');
36			$this->username = $plugin->get('username');
37			$this->password = $plugin->get('password');
38			$this->from = $plugin->get('from');
39			$this->plugin_enabled = true;
40			}
41			}
42
43			/**
44			* getMobilePhoneNumberById (retrieves a user mobile phone number by user id).
45			*
46			* @param int $userId User id
47			*
48			* @return int User's mobile phone number
49			*/
50			public function getMobilePhoneNumberById($userId)
51			{
52			$mobilePhoneNumberExtraField = new ExtraField('user');
53			$mobilePhoneNumberExtraField = $mobilePhoneNumberExtraField->get_handler_field_info_by_field_variable(
54			'mobile_phone_number'
55			);
56
57			$mobilePhoneNumberExtraFieldValue = new ExtraFieldValue('user');
58			$mobilePhoneNumberExtraFieldValue = $mobilePhoneNumberExtraFieldValue->get_values_by_handler_and_field_id(
59			$userId,
60			$mobilePhoneNumberExtraField['id']
61			);
62
63			return $mobilePhoneNumberExtraFieldValue['value'];
64			}
65
66			/**
67			* send (sends an SMS to the user).
68			*
69			* @param array Data needed to send the SMS. It is mandatory to include the
70			* 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least.
71			* More data may be neccesary depending on the message type
72			* Example: $additional_parameters = array(
73			* 'smsType' => EXAMPLE_SMS_TYPE,
74			* 'userId' => $userId,
75			* 'moreData' => $moreData
76			* );
77			*/
78			public function send($additionalParameters)
79			{
80			$trimmedKey = trim(CONFIG_SECURITY_API_KEY);
81			if (!empty($trimmedKey)) {
82			$message = [
83			"to" => array_key_exists("mobilePhoneNumber", $additionalParameters) ?
84			$additionalParameters['mobilePhoneNumber'] : $this->getMobilePhoneNumberById($additionalParameters['userId']),
85			"message" => $this->getSms($additionalParameters),
86			];
87
88			if (!empty($message['message'])) {
89			if (extension_loaded('curl')) {
90			$url = $this->hostAddress.'?username='.
91			$this->username.'&password='.$this->password.'&from='.
92			$this->from.'&to='.$message['to'].'&msg='.urlencode($message['message']);
93			$ch = curl_init($url);
94			curl_exec($ch);
95			curl_close($ch);
96			}
97
98			// Commented for future message logging / tracking purposes
99			/*if( $result["success"] ) {
100			echo "Message sent - ID: " . $result["id"];
101			} else {
102			echo "Message failed - Error: " . $result["error_message"];
103			}*/
104			}
105			}
106			}
107
108			/**
109			* buildSms (builds an SMS from a template and data).
110			*
111			* @param object KannelsmsPlugin object
112			* @param object Template object
113			* @param string Template file name
114			* @param string Text key from lang file
115			* @param array Data to fill message variables (if any)
116			*
117			* @return object Template object with message property updated
118			*/
119			public function buildSms($plugin, $tpl, $templateName, $messageKey, $parameters = null)
120			{
121			$result = Database::select(
122			'selected_value',
123			'settings_current',
124			[
125			'where' => ['variable = ?' => ['kannelsms_message'.$messageKey]],
126			]
127			);
128
129			if (empty($result)) {
130			$tpl->assign('message', '');
131			} else {
132			$templatePath = 'kannelsms/sms_templates/';
133			$content = $tpl->fetch($templatePath.$templateName);
134			$message = $plugin->get_lang($messageKey);
135			if ($parameters !== null) {
136			$message = vsprintf($message, $parameters);
137			}
138			$tpl->assign('message', $message);
139			}
140
141			return $tpl->params['message'];
142			}
143
144			/**
145			* getSms (returns an SMS message depending of its type).
146			*
147			* @param array Data needed to send the SMS. It is mandatory to include the
148			* 'smsType' and 'userId' (or 'mobilePhoneNumber') fields at least.
149			* More data may be neccesary depending on the message type
150			* Example: $additional_parameters = array(
151			* 'smsType' => EXAMPLE_SMS_TYPE,
152			* 'userId' => $userId,
153			* 'moreData' => $moreData
154			* );
155			*
156			* @return string A ready to be sent SMS
157			*/
158			public function getSms($additionalParameters)
159			{
160			$plugin = KannelsmsPlugin::create();
161			$tool_name = $plugin->get_lang('plugin_title');
162			$tpl = new Template($tool_name);
163
164			switch ($additionalParameters['smsType']) {
165			case SmsPlugin::WELCOME_LOGIN_PASSWORD:
166			$userInfo = api_get_user_info($additionalParameters['userId']);
167
168			return $this->buildSms(
169			$plugin,
170			$tpl,
171			'welcome_login_password.tpl',
172			'WelcomeXLoginXPasswordX',
173			[
174			api_get_setting('siteName'),
175			$userInfo['username'],
176			$additionalParameters['password'],
177			]
178			);
179			break;
			0 ignored issues – show Unused Code introduced 2018-01-05 13:33 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
180			case SmsPlugin::NEW_FILE_SHARED_COURSE_BY:
181			return $this->buildSms(
182			$plugin,
183			$tpl,
184			'new_file_shared_course_by.tpl',
185			'XNewFileSharedCourseXByX',
186			[
187			api_get_setting('siteName'),
188			$additionalParameters['courseTitle'],
189			$additionalParameters['userUsername'],
190			]
191			);
192			break;
193			case SmsPlugin::ACCOUNT_APPROVED_CONNECT:
194			return $this->buildSms(
195			$plugin,
196			$tpl,
197			'account_approved_connect.tpl',
198			'XAccountApprovedConnectX',
199			[
200			api_get_setting('siteName'),
201			$tpl->params['_p']['web'],
202			]
203			);
204			break;
205			case SmsPlugin::NEW_COURSE_BEEN_CREATED:
206			return $this->buildSms(
207			$plugin,
208			$tpl,
209			'new_course_been_created.tpl',
210			'XNewCourseXBeenCreatedX',
211			[
212			api_get_setting('siteName'),
213			$additionalParameters['courseName'],
214			$additionalParameters['creatorUsername'],
215			]
216			);
217			break;
218			case SmsPlugin::NEW_USER_SUBSCRIBED_COURSE:
219			return $this->buildSms(
220			$plugin,
221			$tpl,
222			'new_user_subscribed_course.tpl',
223			'XNewUserXSubscribedCourseX',
224			[
225			api_get_setting('siteName'),
226			$additionalParameters['userUsername'],
227			$additionalParameters['courseCode'],
228			]
229			);
230			break;
231			case SmsPlugin::NEW_COURSE_SUGGESTED_TEACHER:
232			return $this->buildSms(
233			$plugin,
234			$tpl,
235			'new_course_suggested_teacher.tpl',
236			'XNewCourseSuggestedTeacherX',
237			[
238			api_get_setting('siteName'),
239			$additionalParameters['userUsername'],
240			]
241			);
242			break;
243			case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REGISTERED:
244			return $this->buildSms(
245			$plugin,
246			$tpl,
247			'course_opening_request_code_registered.tpl',
248			'XCourseOpeningRequestCodeXRegistered',
249			[
250			api_get_setting('siteName'),
251			$additionalParameters['courseCode'],
252			]
253			);
254			break;
255			case SmsPlugin::COURSE_OPENING_REQUEST_CODE_APPROVED:
256			return $this->buildSms(
257			$plugin,
258			$tpl,
259			'course_opening_request_course_code_approved.tpl',
260			'XCourseOpeningRequestCourseCodeXApproved',
261			[
262			api_get_setting('siteName'),
263			$additionalParameters['courseCode'],
264			]
265			);
266			break;
267			case SmsPlugin::COURSE_OPENING_REQUEST_CODE_REJECTED:
268			return $this->buildSms(
269			$plugin,
270			$tpl,
271			'request_open_course_code_rejected.tpl',
272			'XRequestOpenCourseCodeXReject',
273			[
274			api_get_setting('siteName'),
275			$additionalParameters['courseCode'],
276			]
277			);
278			break;
279			case SmsPlugin::COURSE_OPENING_REQUEST_CODE:
280			return $this->buildSms(
281			$plugin,
282			$tpl,
283			'course_opening_request_course_code.tpl',
284			'XCourseOpeningRequestCourseCodeX',
285			[
286			api_get_setting('siteName'),
287			$additionalParameters['courseCode'],
288			]
289			);
290			break;
291			case SmsPlugin::BEEN_SUBSCRIBED_COURSE:
292			return $this->buildSms(
293			$plugin,
294			$tpl,
295			'been_subscribed_course.tpl',
296			'XBeenSubscribedCourseX',
297			[
298			api_get_setting('siteName'),
299			$additionalParameters['courseTitle'],
300			]
301			);
302			break;
303			case SmsPlugin::ASSIGNMENT_BEEN_CREATED_COURSE:
304			return $this->buildSms(
305			$plugin,
306			$tpl,
307			'assignment_been_created_course.tpl',
308			'XAssignmentBeenCreatedCourseX',
309			[
310			api_get_setting('siteName'),
311			$additionalParameters['courseTitle'],
312			]
313			);
314			break;
315			// Message types to be implemented. Fill the array parameter with arguments.
316			/*case SmsPlugin::ACCOUNT_CREATED_UPDATED_LOGIN_PASSWORD:
317			return $this->buildSms(
318			$plugin,
319			$tpl,
320			'account_created_updated_login_password.tpl',
321			'XAccountCreatedUpdatedLoginXPasswordX',
322			array(
323			api_get_setting('siteName')
324			)
325			);
326			break;*/
327			/*case SmsPlugin::PASSWORD_UPDATED_LOGIN_PASSWORD:
328			return $this->buildSms(
329			$plugin,
330			$tpl,
331			'password_updated_login_password.tpl',
332			'XPasswordUpdatedLoginXPasswordX',
333			array(
334			api_get_setting('siteName')
335			)
336			);
337			break;*/
338			/*case SmsPlugin::REQUESTED_PASSWORD_CHANGE:
339			return $this->buildSms(
340			$plugin,
341			$tpl,
342			'requested_password_change.tpl',
343			'XPasswordUpdatedLoginXPasswordX',
344			array(
345			api_get_setting('siteName')
346			)
347			);
348			break;*/
349			/*case SmsPlugin::RECEIVED_NEW_PERSONAL_MESSAGES:
350			return $this->buildSms(
351			$plugin,
352			$tpl,
353			'received_new_personal_messages.tpl',
354			'XReceivedNewPersonalMessages',
355			array(
356			api_get_setting('siteName')
357			)
358			);
359			break;*/
360			/*case SmsPlugin::NEW_USER_PENDING_APPROVAL:
361			return $this->buildSms(
362			$plugin,
363			$tpl,
364			'new_user_pending_approval.tpl',
365			'XNewUserXPendingApproval',
366			array(
367			api_get_setting('siteName')
368			)
369			);
370			break;*/
371			/*case SmsPlugin::POSTED_FORUM_COURSE:
372			return $this->buildSms(
373			$plugin,
374			$tpl,
375			'posted_forum_course.tpl',
376			'XXPostedForumXCourseX',
377			array(
378			api_get_setting('siteName')
379			)
380			);
381			break;*/
382			/*case SmsPlugin::CHECK_EMAIL_CONNECT_MORE_INFO:
383			return $this->buildSms(
384			$plugin,
385			$tpl,
386			'check_email_connect_more_info.tpl',
387			'XXXCheckEmailConnectMoreInfo',
388			array(
389			api_get_setting('siteName')
390			)
391			);
392			break;*/
393			/*case SmsPlugin::STUDENT_ANSWERED_TEST:
394			return $this->buildSms(
395			$plugin,
396			$tpl,
397			'student_answered_test.tpl',
398			'XXStudentXAnsweredTestX',
399			array(
400			api_get_setting('siteName')
401			)
402			);
403			break;*/
404			/*case SmsPlugin::STUDENT_ANSWERED_TEST_OPEN_QUESTION:
405			return $this->buildSms(
406			$plugin,
407			$tpl,
408			'student_answered_test_open_question.tpl',
409			'XXStudentXAnsweredTestXOpenQuestion',
410			array(
411			api_get_setting('siteName')
412			)
413			);
414			break;*/
415			/*case SmsPlugin::STUDENT_ANSWERED_TEST_VOICE_QUESTION:
416			return $this->buildSms(
417			$plugin,
418			$tpl,
419			'student_answered_test_voice_question.tpl',
420			'XXStudentXAnsweredTestXVoiceQuestion',
421			array(
422			api_get_setting('siteName')
423			)
424			);
425			break;*/
426			/*case SmsPlugin::ANSWER_OPEN_QUESTION_TEST_REVIEWED:
427			return $this->buildSms(
428			$plugin,
429			$tpl,
430			'answer_open_question_test_reviewed.tpl',
431			'XXAnswerOpenQuestionTestXReviewed',
432			array(
433			api_get_setting('siteName')
434			)
435			);
436			break;*/
437			/*case SmsPlugin::NEW_THREAD_STARTED_FORUM:
438			return $this->buildSms(
439			$plugin,
440			$tpl,
441			'new_thread_started_forum.tpl',
442			'XXNewThreadXStartedForumX',
443			array(
444			api_get_setting('siteName')
445			)
446			);
447			break;*/
448			/*case SmsPlugin::NEW_ANSWER_POSTED_FORUM:
449			return $this->buildSms(
450			$plugin,
451			$tpl,
452			'new_answer_posted_forum.tpl',
453			'XXNewAnswerPostedXForumX',
454			array(
455			api_get_setting('siteName')
456			)
457			);
458			break;*/
459			/*case SmsPlugin::NEW_SYSTEM_ANNOUNCEMENT_ADDED:
460			return $this->buildSms(
461			$plugin,
462			$tpl,
463			'new_system_announcement_added.tpl',
464			'XXNewSystemAnnouncementAdded',
465			array(
466			api_get_setting('siteName')
467			)
468			);
469			break;*/
470			/*case SmsPlugin::TEST_NEW_SYSTEM_ANNOUNCEMENT_ADDED:
471			return $this->buildSms(
472			$plugin,
473			$tpl,
474			'test_new_system_announcement_added.tpl',
475			'XTestXNewSystemAnnouncementAdded',
476			array(
477			api_get_setting('siteName')
478			)
479			);
480			break;*/
481			/*case SmsPlugin::SYSTEM_ANNOUNCEMENT_UPDATE:
482			return $this->buildSms(
483			$plugin,
484			$tpl,
485			'system_announcement_update.tpl',
486			'XXSystemAnnouncementUpdate',
487			array(
488			api_get_setting('siteName')
489			)
490			);
491			break;*/
492			/*case SmsPlugin::TEST_SYSTEM_ANNOUNCEMENT_UPDATE:
493			return $this->buildSms(
494			$plugin,
495			$tpl,
496			'test_system_announcement_update.tpl',
497			'XXSystemAnnouncementUpdate',
498			array(
499			api_get_setting('siteName')
500			)
501			);
502			break;*/
503			/*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE_STUDENT_SUBMITS_PAPER:
504			return $this->buildSms(
505			$plugin,
506			$tpl,
507			'user_uploaded_assignment_course_student_submits_paper.tpl',
508			'XUserXUploadedAssignmentXCourseXStudentSubmitsPaper',
509			array(
510			api_get_setting('siteName')
511			)
512			);
513			break;*/
514			/*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK_STUDENT_SUBMITS_PAPER:
515			return $this->buildSms(
516			$plugin,
517			$tpl,
518			'user_uploaded_assignment_check_student_submits_paper.tpl',
519			'XUserXUploadedAssignmentXCheckXStudentSubmitsPaper',
520			array(
521			api_get_setting('siteName')
522			)
523			);
524			break;*/
525			/*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_COURSE:
526			return $this->buildSms(
527			$plugin,
528			$tpl,
529			'user_uploaded_assignment_course.tpl',
530			'XUserXUploadedAssignmentXCourseX',
531			array(
532			api_get_setting('siteName')
533			)
534			);
535			break;*/
536			/*case SmsPlugin::USER_UPLOADED_ASSIGNMENT_CHECK:
537			return $this->buildSms(
538			$plugin,
539			$tpl,
540			'user_uploaded_assignment_check.tpl',
541			'XUserXUploadedAssignmentXCheckX',
542			array(
543			api_get_setting('siteName')
544			)
545			);
546			break;*/
547			/*case SmsPlugin::SUBSCRIBED_SESSION:
548			return $this->buildSms(
549			$plugin,
550			$tpl,
551			'subscribed_session.tpl',
552			'XSubscribedSessionX',
553			array(
554			api_get_setting('siteName')
555			)
556			);
557			break;*/
558			/*case SmsPlugin::SUBSCRIBED_SESSION_CSV:
559			return $this->buildSms(
560			$plugin,
561			$tpl,
562			'subscribed_session_csv.tpl',
563			'XSubscribedSessionXCSV',
564			array(
565			api_get_setting('siteName')
566			)
567			);
568			break;*/
569			/*case SmsPlugin::USER_SUGGESTED_BE_FRIENDS:
570			return $this->buildSms(
571			$plugin,
572			$tpl,
573			'user_suggested_be_friends.tpl',
574			'XUserXSuggestedBeFriends',
575			array(
576			api_get_setting('siteName')
577			)
578			);
579			break;*/
580			/*case SmsPlugin::USER_ANSWERED_INBOX_MESSAGE:
581			return $this->buildSms(
582			$plugin,
583			$tpl,
584			'user_answered_inbox_message.tpl',
585			'XUserXAnsweredInboxMessage',
586			array(
587			api_get_setting('siteName')
588			)
589			);
590			break;*/
591			/*case SmsPlugin::BEEN_INVITED_JOIN_GROUP:
592			return $this->buildSms(
593			$plugin,
594			$tpl,
595			'been_invited_join_group.tpl',
596			'XBeenInvitedJoinGroupX',
597			array(
598			api_get_setting('siteName')
599			)
600			);
601			break;*/
602			/*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_EDITED:
603			return $this->buildSms(
604			$plugin,
605			$tpl,
606			'messages_sent_edited_group_edited.tpl',
607			'XMessagesSentEditedGroupXEdited',
608			array(
609			api_get_setting('siteName')
610			)
611			);
612			break;*/
613			/*case SmsPlugin::MESSAGES_SENT_EDITED_GROUP_ADDED:
614			return $this->buildSms(
615			$plugin,
616			$tpl,
617			'messages_sent_edited_group_added.tpl',
618			'XMessagesSentEditedGroupXAdded',
619			array(
620			api_get_setting('siteName')
621			)
622			);
623			break;*/
624			/*case SmsPlugin::BEEN_INVITED_COMPLETE_SURVEY_COURSE:
625			return $this->buildSms(
626			$plugin,
627			$tpl,
628			'been_invited_complete_survey_course.tpl',
629			'XBeenInvitedCompleteSurveyXCourseX',
630			array(
631			api_get_setting('siteName')
632			)
633			);
634			break;*/
635			/*case SmsPlugin::REMINDER_ASSIGNMENT_COURSE_DUE:
636			return $this->buildSms(
637			$plugin,
638			$tpl,
639			'reminder_assignment_course_due.tpl',
640			'XReminderAssignmentXCourseXDue',
641			array(
642			api_get_setting('siteName')
643			)
644			);
645			break;*/
646			/*case SmsPlugin::USER_DETAILS_MODIFIED:
647			return $this->buildSms(
648			$plugin,
649			$tpl,
650			'user_details_modified.tpl',
651			'XUserDetailsModified',
652			array(
653			api_get_setting('siteName')
654			)
655			);
656			break;*/
657			default:
658			return '';
659			}
660			}
661			}
662

chamilo / chamilo-lms

Kannelsms A last analyzed 2025-06-17 20:49 UTC

Complexity

Size/Duplication

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

Kannelsms A
last analyzed 2025-06-17 20:49 UTC