File notifications.php

  1 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');  
  2 
  3 require_once dirname(__FILE__) . '/external/class.phpmailer.php';
  4 
  5 /**
  6  * This library handles all the notification email deliveries 
  7  * on the system.
  8  * 
  9  * Custom system settings for the notification section are loaded 
 10  * during the execution of each class methods.
 11  */
 12 class Notifications {
 13     private $ci;
 14     
 15     /**
 16      * Class Constructor
 17      */
 18     public function __construct() {   
 19         $this->ci =& get_instance();
 20     }
 21     
 22     /**
 23      * Replace the email template variables.
 24      * 
 25      * This method finds and replaces the html variables of an email
 26      * template. It is used to generate dynamic HTML emails that are
 27      * send as notifications to the system users.
 28      * 
 29      * @param array $replace_array Array that contains the variables
 30      * to be replaced.
 31      * @param string $email_html The email template hmtl.
 32      * @return string Returns the new email html that contain the 
 33      * variables of the $replace_array.
 34      */
 35     private function replace_template_variables($replace_array, $email_html) {
 36         foreach($replace_array as $var=>$value) {
 37             $email_html = str_replace($var, $value, $email_html);
 38         }
 39         
 40         return $email_html;
 41     }
 42     
 43     /**
 44      * Send an email with the appointment details. 
 45      * 
 46      * This email template also needs an email title and an email text in order to complete
 47      * the appointment details.
 48      * 
 49      * @expectedException Exception Raises when an unexpected error occures.
 50      * 
 51      * @param array $appointment_data Contains the appointment data.
 52      * @param array $provider_data Contains the provider data.
 53      * @param array $service_data Contains the service data.    
 54      * @param array $company_settings Contains settings of the company. By the time the 
 55      * "company_name", "company_link" and "company_email" values are required in the array.
 56      * @param string $title The email title may vary depending the receiver.
 57      * @param string $message The email message may vary depending the receiver.
 58      * @param string $appointment_link This link is going to enable the receiver to make changes
 59      * to the appointment record.
 60      * @param string $receiver_address The receiver email address.
 61      * @return bool Returns the operation result.
 62      */
 63     public function send_appointment_details($appointment_data, $provider_data, $service_data, 
 64             $customer_data, $company_settings, $title, $message, $appointment_link, 
 65             $receiver_address) {
 66         
 67         // :: PREPARE THE EMAIL TEMPLATE REPLACE ARRAY
 68         $replace_array = array(
 69             '$email_title'              => $title,
 70             '$email_message'            => $message,
 71             
 72             '$appointment_service'      => $service_data['name'],
 73             '$appointment_provider'     => $provider_data['first_name'] . ' ' . $provider_data['last_name'],
 74             '$appointment_start_date'   => date('d/m/Y H:i', strtotime($appointment_data['start_datetime'])),
 75             '$appointment_end_date'     => date('d/m/Y H:i', strtotime($appointment_data['end_datetime'])),
 76             '$appointment_link'         => $appointment_link, 
 77             
 78             '$company_link'             => $company_settings['company_link'],
 79             '$company_name'             => $company_settings['company_name'],
 80             
 81             '$customer_name'            => $customer_data['first_name'] . ' ' . $customer_data['last_name'],
 82             '$customer_email'           => $customer_data['email'],
 83             '$customer_phone'           => $customer_data['phone_number'],
 84             '$customer_address'         => $customer_data['address'],
 85             
 86             // Translations
 87             'Appointment Details' => $this->ci->lang->line('appointment_details_title'),
 88             'Service' => $this->ci->lang->line('service'),
 89             'Provider' => $this->ci->lang->line('provider'),
 90             'Start' => $this->ci->lang->line('start'),
 91             'End' => $this->ci->lang->line('end'),
 92             'Customer Details' => $this->ci->lang->line('customer_details_title'),
 93             'Name' => $this->ci->lang->line('name'),
 94             'Email' => $this->ci->lang->line('email'),
 95             'Phone' => $this->ci->lang->line('phone'),
 96             'Address' => $this->ci->lang->line('address'),
 97             'Appointment Link' => $this->ci->lang->line('appointment_link_title')
 98         );
 99         
100         $email_html = file_get_contents(dirname(dirname(__FILE__)) 
101                 . '/views/emails/appointment_details.php');
102         $email_html = $this->replace_template_variables($replace_array, $email_html);
103         
104         // :: INSTANTIATE EMAIL OBJECT AND SEND EMAIL
105         $mail = new PHPMailer();
106         $mail->From = $company_settings['company_email'];
107         $mail->FromName = $company_settings['company_name'];
108         $mail->AddAddress($receiver_address); // "Name" argument crushes the phpmailer class.
109         $mail->IsHTML(true);
110         $mail->CharSet = 'UTF-8';
111         $mail->Subject = $title;
112         $mail->Body    = $email_html;
113 
114         if (!$mail->Send()) {
115             throw new Exception('Email could not been sent. Mailer Error (Line ' 
116                     . __LINE__ . '): ' . $mail->ErrorInfo);
117         }
118         
119         return TRUE;
120     }
121     
122     /**
123      * Send an email notification to both provider and customer on appointment removal.
124      * 
125      * Whenever an appointment is cancelled or removed, both the provider and customer
126      * need to be informed. This method sends the same email twice.
127      * 
128      * <strong>IMPORTANT!</strong> This method's arguments should be taken 
129      * from database before the appointment record is deleted.
130      * 
131      * @param array $appointment_data The record data of the removed appointment.
132      * @param array $provider_data The record data of the appointment provider.
133      * @param array $service_data The record data of the appointment service.
134      * @param array $customer_data The record data of the appointment customer.
135      * @param array $company_settings Some settings that are required for this function. 
136      * By now this array must contain the following values: "company_link", 
137      * "company_name", "company_email". 
138      * @param string $to_address The email address of the email receiver.
139      * @param string $reason The reason why the appointment is deleted.
140      */
141     public function send_delete_appointment($appointment_data, $provider_data, 
142             $service_data, $customer_data, $company_settings, $to_address, $reason) {
143         // :: PREPARE EMAIL REPLACE ARRAY
144         $replace_array = array(
145             '$email_title'          => $this->ci->lang->line('appointment_cancelled_title'),
146             '$email_message'        => $this->ci->lang->line('appointment_removed_from_schedule'),
147             '$appointment_service'  => $service_data['name'],
148             '$appointment_provider' => $provider_data['first_name'] . ' ' . $provider_data['last_name'],
149             '$appointment_date'     => date('d/m/Y H:i', strtotime($appointment_data['start_datetime'])),
150             '$appointment_duration' => $service_data['duration'] . ' minutes',
151             '$company_link'         => $company_settings['company_link'],
152             '$company_name'         => $company_settings['company_name'],
153             '$customer_name'        => $customer_data['first_name'] . ' ' . $customer_data['last_name'],
154             '$customer_email'       => $customer_data['email'],
155             '$customer_phone'       => $customer_data['phone_number'],
156             '$customer_address'     => $customer_data['address'],
157             '$reason'               => $reason,
158             
159             // Translations
160             'Appointment Details' => $this->ci->lang->line('appointment_details_title'),
161             'Service' => $this->ci->lang->line('service'),
162             'Provider' => $this->ci->lang->line('provider'),
163             'Date' => $this->ci->lang->line('start'),
164             'Duration' => $this->ci->lang->line('duration'),
165             'Customer Details' => $this->ci->lang->line('customer_details_title'),
166             'Name' => $this->ci->lang->line('name'),
167             'Email' => $this->ci->lang->line('email'),
168             'Phone' => $this->ci->lang->line('phone'),
169             'Address' => $this->ci->lang->line('address'),
170             'Reason' => $this->ci->lang->line('reason')
171         );
172         
173         $email_html = file_get_contents(dirname(dirname(__FILE__)) 
174                     . '/views/emails/delete_appointment.php');
175         $email_html = $this->replace_template_variables($replace_array, $email_html);
176         
177         // :: SETUP EMAIL OBJECT AND SEND NOTIFICATION
178         $mail = new PHPMailer();
179         $mail->From         = $company_settings['company_email'];
180         $mail->FromName     = $company_settings['company_name'];
181         $mail->AddAddress($to_address); // "Name" argument crushes the phpmailer class.
182         $mail->IsHTML(true);
183         $mail->CharSet      = 'UTF-8';
184         $mail->Subject      = $this->ci->lang->line('appointment_cancelled_title');
185         $mail->Body         = $email_html;
186 
187         if (!$mail->Send()) {
188             throw new Exception('Email could not been sent. ' 
189                     . 'Mailer Error (Line ' . __LINE__ . '): ' . $mail->ErrorInfo);
190         }
191         
192         return TRUE;
193     }
194     
195     /**
196      * This method sends an email with the new password of a user. 
197      * 
198      * @param string $password Contains the new password.
199      * @param string $email The receiver's email address.
200      */
201     public function send_password($password, $email, $company_settings) {
202         $replace_array = array(
203             '$email_title' => $this->ci->lang->line('new_account_password'),
204             '$email_message' => $this->ci->lang->line('new_password_is'),
205             '$company_name' => $company_settings['company_name'],
206             '$company_email' => $company_settings['company_email'],
207             '$company_link' => $company_settings['company_link'],
208             '$password' => '<strong>' . $password . '</strong>'
209         );
210         
211         $email_html = file_get_contents(dirname(dirname(__FILE__)) 
212                     . '/views/emails/new_password.php');
213         $email_html = $this->replace_template_variables($replace_array, $email_html);
214         
215         // :: SETUP EMAIL OBJECT AND SEND NOTIFICATION
216         $mail = new PHPMailer();
217         $mail->From = $company_settings['company_email'];
218         $mail->FromName = $company_settings['company_name'];
219         $mail->AddAddress($email); // "Name" argument crushes the phpmailer class.
220         $mail->IsHTML(true);
221         $mail->CharSet = 'UTF-8';
222         $mail->Subject = $this->ci->lang->line('new_account_password');
223         $mail->Body = $email_html;
224 
225         if (!$mail->Send()) {
226             throw new Exception('Email could not been sent. ' 
227                     . 'Mailer Error (Line ' . __LINE__ . '): ' . $mail->ErrorInfo);
228         }
229         
230         return TRUE;
231     }
232     
233     /**
234      * Sends a simple email to notify for a new installation. 
235      * 
236      * This method will be only used for tracking the number of installations. No personal
237      * data will be retrieved for any other cause.
238      * 
239      * @returns bool Returns the "send()" method result.
240      */
241     public function send_new_installation($company_name, $company_email, $company_link) {
242         $mail = new PHPMailer();
243         $mail->From = $company_email;
244         $mail->FromName = 'New Installation: ' . $company_name ;
245         $mail->AddAddress('info@easyappointments.org');
246         $mail->IsHTML(true);
247         $mail->CharSet = 'UTF-8';
248         $mail->Subject = 'New Easy!Appointments Installation';
249         $mail->Body = 'Base URL: ' . $this->ci->config->item('base_url') . '<br>'
250                 . 'E!A Version: ' . $this->ci->config->item('ea_version') . '<br>'
251                 . 'Company Name: ' . $company_name . '<br>'
252                 . 'Company Email: ' . $company_email . '<br>'
253                 . 'Company Link: ' . $company_link . '<br>';
254         return $mail->Send();
255     }
256 }
257 
258 /* End of file notifications.php */
259 /* Location: ./application/libraries/notifications.php */
Classes

Interfaces
