CRM/Admin/Form/Setting/Mail.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 /**
  35  * This class generates form components for CiviMail.
  36  */
  37 class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting {
  38
  39   protected $_settings = array(
  40     'replyTo' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  41     'mailerBatchLimit' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  42     'mailerJobSize' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  43     'mailerJobsMax' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  44     'mailThrottleTime' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  45     'verpSeparator' => CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  46   );
  47
  48   /**
  49    * Build the form object.
  50    */
  51   public function buildQuickForm() {
  52     CRM_Utils_System::setTitle(ts('Settings - CiviMail'));
  53     $check = TRUE;
  54
  55     // redirect to Administer Section After hitting either Save or Cancel button.
  56     $session = CRM_Core_Session::singleton();
  57     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin', 'reset=1'));
  58
  59     $this->addFormRule(array('CRM_Admin_Form_Setting_Mail', 'formRule'));
  60
  61     parent::buildQuickForm($check);
  62   }
  63
  64   /**
  65    * @param $fields
  66    *
  67    * @return array|bool
  68    */
  69   public static function formRule($fields) {
  70     $errors = array();
  71
  72     if (CRM_Utils_Array::value('mailerJobSize', $fields) > 0) {
  73       if (CRM_Utils_Array::value('mailerJobSize', $fields) < 1000) {
  74         $errors['mailerJobSize'] = ts('The job size must be at least 1000 or set to 0 (unlimited).');
  75       }
  76       elseif (CRM_Utils_Array::value('mailerJobSize', $fields) <
  77         CRM_Utils_Array::value('mailerBatchLimit', $fields)
  78       ) {
  79         $errors['mailerJobSize'] = ts('A job size smaller than the batch limit will negate the effect of the batch limit.');
  80       }
  81     }
  82
  83     return empty($errors) ? TRUE : $errors;
  84   }
  85
  86 }