class/Email/ReadyToRegisterEmail.php
<?php
/**
* This file is part of Internship Inventory.
*
* Internship Inventory is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* Internship Inventory is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License version 3
* along with Internship Inventory. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2011-2018 Appalachian State University
*/
namespace Intern\Email;
use \Intern\Internship;
use \Intern\Faculty;
use \Intern\InternSettings;
use \Intern\Subject;
use \Intern\Term;
/**
* Class to handle creating an email to the registrar notifying them to register
* the student for the appropriate internship course.
* @author jbooker
* @package Intern
*/
class ReadyToRegisterEmail extends Email {
private $internship;
private $term;
/**
* Constructor
*
* @param InternSettings $emailSettings
* @param Internship $internship
*/
public function __construct(InternSettings $emailSettings, Internship $internship, Term $term) {
parent::__construct($emailSettings);
$this->internship = $internship;
$this->term = $term;
}
protected function getTemplateFileName(){
return 'email/ReadyToRegisterEmail.tpl';
}
protected function buildMessage()
{
$subjects = Subject::getSubjects();
$faculty = $this->internship->getFaculty();
$this->tpl['NAME'] = $this->internship->getFullName();
$this->tpl['BANNER'] = $this->internship->banner;
$this->tpl['USER'] = $this->internship->email;
$this->tpl['PHONE'] = $this->internship->phone;
$term = $this->term->getDescription();
$this->tpl['TERM'] = $term;
if(isset($this->internship->course_subj)){
$this->tpl['SUBJECT'] = $subjects[$this->internship->course_subj];
}else{
$this->tpl['SUBJECT'] = '(No course subject provided)';
}
if(isset($this->internship->course_no) && $this->internship->course_no !== ''){
$this->tpl['COURSE_NUM'] = $this->internship->course_no;
} else {
$this->tpl['COURSE_NUM'] = '(not provided)';
}
if(isset($this->internship->course_sect) && $this->internship->course_sect !== ''){
$this->tpl['SECTION'] = $this->internship->course_sect;
}else{
$this->tpl['SECTION'] = '(not provided)';
}
if(isset($this->internship->course_title) && $this->internship->course_title !== ''){
$this->tpl['COURSE_TITLE'] = $this->internship->course_title;
} else {
$this->tpl['COURSE_TITLE'] = 'not provided';
}
if(isset($this->internship->credits)){
$this->tpl['CREDITS'] = $this->internship->credits;
}else{
$this->tpl['CREDITS'] = '(not provided)';
}
$startDate = $this->internship->getStartDate(true);
if(isset($startDate)){
$this->tpl['START_DATE'] = $startDate;
}else{
$this->tpl['START_DATE'] = '(not provided)';
}
$endDate = $this->internship->getEndDate(true);
if(isset($endDate)){
$this->tpl['END_DATE'] = $endDate;
}else{
$this->tpl['END_DATE'] = '(not provided)';
}
if($faculty instanceof Faculty){
$faculty = $this->internship->getFaculty();
$this->tpl['FACULTY'] = $faculty->getFullName() . ' (' . $faculty->getId() . ')';
}else{
$this->tpl['FACULTY'] = '(not provided)';
}
$department = $this->internship->getDepartment();
$this->tpl['DEPT'] = $department->getName();
$campus = $this->internship->getCampus();
if ($campus == 'distance_ed') {
$this->tpl['CAMPUS'] = 'Distance Ed';
} else if ($campus == 'main_campus') {
$this->tpl['CAMPUS'] = 'Main campus';
} else {
$this->tpl['CAMPUS'] = $campus;
}
/**** Corequisite Checking ****/
$coreq = $this->internship->getCorequisiteNum();
if (!is_null($coreq) && $coreq != '') {
$this->tpl['COREQ_SUBJECT'] = $subjects[$this->internship->course_subj];
$this->tpl['COREQ_COURSE_NUM'] = $coreq;
$this->tpl['COREQ_COURSE_SECT'] = $this->internship->getCorequisiteSection();
}
/**** International Checking ***/
if ($this->internship->international) {
$this->tpl['COUNTRY'] = $this->internship->loc_country;
$this->tpl['INTERNATIONAL'] = 'Yes';
$intlSubject = '[int\'l] ';
} else {
$this->tpl['STATE'] = $this->internship->loc_state;
$this->tpl['INTERNATIONAL'] = 'No';
$intlSubject = '';
}
/**** Multi-part checking ***/
if ($this->internship->isMultipart() && $this->internship->isSecondaryPart()) {
$this->tpl['SECONDARY_PART'] = '';
}
/***
* Figure out who the notification email goes to, Setting is a comma separated array
*/
if ($this->internship->isDistanceEd() && $this->internship->isGraduate()) {
// Send distance ed internship to Distance Ed Office
$this->to = explode(',', $this->emailSettings->getDistanceEdEmail());
$this->tpl['GRADUATE'] = ''; // Dummy template var to use undergrad text
} else if ($this->internship->isGraduate()) {
// Send all graduate internships to the graduate school (whether international or not)
$this->to = explode(',', $this->emailSettings->getGraduateRegEmail());
$this->tpl['GRADUATE'] = ''; // Dummy template var to use grad school text
} else if ($this->internship->isInternational()){
// Send international undergraduate internships to a special person
$this->to = explode(',', $this->emailSettings->getInternationalRegEmail());
$this->tpl['UNDERGRAD'] = ''; // Dummy template var to use undergrad text
} else {
// Otherwise, send it to the general Registrar address
$this->to = explode(',', $this->emailSettings->getRegistrarEmail());
$this->tpl['UNDERGRAD'] = ''; // Dummy template var to use undergrad text
}
// Double check that we set a To address
if(!isset($this->to) || $this->to == null) {
throw new \InvalidArgumentException('Missing configurating for email addresses (registrar)');
}
// CC the faculty members
if ($faculty instanceof Faculty) {
$this->cc = array($faculty->getUsername() . $this->emailSettings->getEmailDomain());
}
// Subject line
if(isset($this->internship->course_subj)){
$courseSubj = $subjects[$this->internship->course_subj];
} else {
$courseSubj = '';
}
$this->subject = $term . ' ' . $intlSubject . '[' . $this->internship->getBannerId() . '] ' . $this->internship->getFullName() . ' ' . $courseSubj . ' ' . $this->internship->course_no;
}
}