CRM/Admin/Form/Setting/Mail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for CiviMail
  38  */
  39 class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting {
  40
  41   /**
  42    * Function to build the form
  43    *
  44    * @return void
  45    * @access public
  46    */
  47   public function buildQuickForm() {
  48     CRM_Utils_System::setTitle(ts('Settings - CiviMail'));
  49     $this->addElement('text', 'verpSeparator', ts('VERP Separator'));
  50     $this->addElement('text', 'mailerBatchLimit', ts('Mailer Batch Limit'));
  51     $this->addElement('text', 'mailThrottleTime', ts('Mailer Throttle Time'));
  52     $this->addElement('text', 'mailerJobSize', ts('Mailer Job Size'));
  53     $this->addElement('advcheckbox', 'replyTo', ts('Enable Custom Reply-To'));
  54     $this->addElement('text', 'mailerJobsMax', ts('Mailer CRON job limit'));
  55     $check = TRUE;
  56
  57     // redirect to Administer Section After hitting either Save or Cancel button.
  58     $session = CRM_Core_Session::singleton();
  59     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
  60
  61     $this->addFormRule(array('CRM_Admin_Form_Setting_Mail', 'formRule'));
  62     $this->addRule('mailerBatchLimit', ts('Must be an integer'), 'integer');
  63     $this->addRule('mailThrottleTime', ts('Must be an integer'), 'integer');
  64     $this->addRule('mailerJobSize', ts('Must be an integer'), 'integer');
  65     $this->addRule('mailerJobsMax', ts('Must be an integer'), 'integer');
  66
  67     parent::buildQuickForm($check);
  68   }
  69
  70   /**
  71    * @param $fields
  72    *
  73    * @return array|bool
  74    */
  75   static function formRule($fields) {
  76     $errors = array();
  77
  78     if (CRM_Utils_Array::value('mailerJobSize', $fields) > 0) {
  79       if (CRM_Utils_Array::value('mailerJobSize', $fields) < 1000) {
  80         $errors['mailerJobSize'] = ts('The job size must be at least 1000 or set to 0 (unlimited).');
  81       }
  82       elseif (CRM_Utils_Array::value('mailerJobSize', $fields) <
  83         CRM_Utils_Array::value('mailerBatchLimit', $fields)) {
  84         $errors['mailerJobSize'] = ts('A job size smaller than the batch limit will negate the effect of the batch limit.');
  85       }
  86     }
  87
  88     return empty($errors) ? TRUE : $errors;
  89   }
  90 }
  91