X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fmailer%2Fclass_BaseMailer.php;h=c1a24694ac0446b3de65b9939aefef13fb4ef946;hb=2a73d3b2af7d916dfa771422ded7101912629e31;hp=5d2b045ad2d74e352712bab71566fcab0fe0a0bc;hpb=43deb129f6e8a12c37f0df17ad0870d3491bdd34;p=core.git diff --git a/inc/classes/main/mailer/class_BaseMailer.php b/inc/classes/main/mailer/class_BaseMailer.php index 5d2b045a..c1a24694 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 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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 */ @@ -73,19 +68,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 - $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 +86,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 +96,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 +117,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 +146,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); } /** @@ -173,15 +156,15 @@ class BaseMailer extends BaseFrameworkSystem { */ public final function getSubjectLine () { // Default subject is null - $subjectLine = null; + $subjectLine = NULL; // Get template name $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 @@ -195,7 +178,7 @@ class BaseMailer extends BaseFrameworkSystem { */ public function useSubjectFromTemplate () { // Set the subject line - $this->setSubjectLine("{?subject?}"); + $this->setSubjectLine('{?subject?}'); } /** @@ -204,7 +187,7 @@ class BaseMailer extends BaseFrameworkSystem { * @return $recipientList Array with reciepients */ public final function getRecipientList () { - return $this->recipientList; + return $this->getGenericArray('recipients'); } }