X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fmailer%2Fclass_BaseMailer.php;h=db07b20d85a0de511900cc5b0f0dc89bcb68a5fd;hp=ffd0bc158d6db6b7b0a592b2c2e6e4eeb5c6638a;hb=eceddfea4c386fff2760fa6f3592a242809cbf7a;hpb=ac948286448f4e0d4ef71d2dc8daaac53e8c902b diff --git a/inc/classes/main/mailer/class_BaseMailer.php b/inc/classes/main/mailer/class_BaseMailer.php index ffd0bc15..db07b20d 100644 --- a/inc/classes/main/mailer/class_BaseMailer.php +++ b/inc/classes/main/mailer/class_BaseMailer.php @@ -2,11 +2,11 @@ /** * A general mailer class for all other mailers * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,11 +22,6 @@ * along with this program. If not, see . */ class BaseMailer extends BaseFrameworkSystem { - /** - * Iterateable list of recipients - */ - private $recipientList = array(); - /** * Template name */ @@ -57,9 +52,7 @@ class BaseMailer extends BaseFrameworkSystem { $templatePrefix = $this->getConfigInstance()->getConfigEntry('email_tpl_' . $templateName); // Load this email template - // @TODO This needs testing/fixes because the deprecated method - // loadEmailTemplate() has been removed from interface CompileableTemplate. - $this->getTemplateInstance()->loadCodeTemplate($templatePrefix . '_' . $templateName); + $this->getTemplateInstance()->loadEmailTemplate($templatePrefix . '_' . $templateName); } /** @@ -73,19 +66,13 @@ class BaseMailer extends BaseFrameworkSystem { $templateName = $this->getTemplateName(); // Is the list initialized? - if (!isset($this->recipientList[$templateName]['recipients'])) { - // Then initialize it here - $this->recipientList[$templateName]['recipients'] = array(); - } // END - if - - // Add it as a recipient - array_pushh($this->recipientList[$templateName]['recipients'], $userInstance); + $this->pushValueToGenericArrayKey('recipients', $templateName, 'recipients', $userInstance); } /** * Adds a template variable (just the name) to the recipient list in given section of current template * - * @param $section Section can be "config" or "value" currently + * @param $section Section can be 'config' or "value" currently * @param $variableName Template variable name to add * @return void */ @@ -97,13 +84,7 @@ class BaseMailer extends BaseFrameworkSystem { $sectionName = $section . '_vars'; // Is the list initialized? - if (!isset($this->recipientList[$templateName][$sectionName])) { - // Then initialize it here - $this->recipientList[$templateName][$sectionName] = array(); - } // END - if - - // Add the variable to the list - $this->recipientList[$templateName][$sectionName][$variableName] = 'OK'; + $this->setGenericArrayElement('recipients', $templateName, $sectionName, $variableName, 'OK'); } /** @@ -113,17 +94,17 @@ class BaseMailer extends BaseFrameworkSystem { * @return void */ public final function addConfigTemplateVariable ($variableName) { - $this->addTemplateVariable("config", $variableName); + $this->addTemplateVariable('config', $variableName); } /** - * Adds a "value" template variable to the recipient list of current template + * Adds a 'value' template variable to the recipient list of current template * * @param $variableName Template variable name to add * @return void */ public final function addValueTemplateVariable ($variableName) { - $this->addTemplateVariable("value", $variableName); + $this->addTemplateVariable('value', $variableName); } /** @@ -134,7 +115,7 @@ class BaseMailer extends BaseFrameworkSystem { * @return void */ public final function addValueInstance ($variableName, FrameworkInterface $valueInstance) { - $this->recipientList[$this->getTemplateName()]['values'][$variableName] = $valueInstance; + $this->setGenericArrayElement('recipients', $this->getTemplateName(), 'values', $variableName, $valueInstance); } /** @@ -163,7 +144,7 @@ class BaseMailer extends BaseFrameworkSystem { * @return void */ public final function setSubjectLine ($subjectLine) { - $this->recipientList[$this->getTemplateName()]['subject'] = (string) $subjectLine; + $this->setGenericArrayElement('recipients', $this->getTemplateName(), 'generic', 'subject', $subjectLine); } /** @@ -179,9 +160,9 @@ class BaseMailer extends BaseFrameworkSystem { $templateName = $this->getTemplateName(); // Does the subject line exist? - if ((!empty($templateName)) && (isset($this->recipientList[$templateName]['subject']))) { + if ((!empty($templateName)) && ($this->isGenericArrayElementSet('recipients', $templateName, 'generic', 'subject'))) { // Then use it - $subjectLine = $this->recipientList[$templateName]['subject']; + $subjectLine = $this->getGenericArrayElement('recipients', $templateName, 'generic', 'subject'); } // END - if // Return it @@ -204,7 +185,7 @@ class BaseMailer extends BaseFrameworkSystem { * @return $recipientList Array with reciepients */ public final function getRecipientList () { - return $this->recipientList; + return $this->getGenericArray('recipients'); } }