CRM/Mailing/BAO/MailingAB.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * Class CRM_Mailing_BAO_MailingAB
  38  */
  39 class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB {
  40
  41   /**
  42    * class constructor
  43    */
  44   public function __construct() {
  45     parent::__construct();
  46   }
  47
  48   /**
  49    * Construct a new mailingab object
  50    *
  51    * @params array $params        Form values
  52    *
  53    * @param $params
  54    * @param array $ids
  55    *
  56    * @return object $mailingab      The new mailingab object
  57    * @static
  58    */
  59   public static function create(&$params, $ids = array()) {
  60     $transaction = new CRM_Core_Transaction();
  61
  62     $mailingab = self::add($params, $ids);
  63
  64     if (is_a($mailingab, 'CRM_Core_Error')) {
  65       $transaction->rollback();
  66       return $mailingab;
  67     }
  68     $transaction->commit();
  69     return $mailingab;
  70   }
  71
  72   /**
  73    * function to add the mailings
  74    *
  75    * @param array $params reference array contains the values submitted by the form
  76    * @param array $ids reference array contains the id
  77    *
  78    * @static
  79    *
  80    * @return object
  81    */
  82   public static function add(&$params, $ids = array()) {
  83     $id = CRM_Utils_Array::value('mailingab_id', $ids, CRM_Utils_Array::value('id', $params));
  84
  85     if ($id) {
  86       CRM_Utils_Hook::pre('edit', 'MailingAB', $id, $params);
  87     }
  88     else {
  89       CRM_Utils_Hook::pre('create', 'MailingAB', NULL, $params);
  90     }
  91
  92     $mailingab = new CRM_Mailing_DAO_MailingAB();
  93     $mailingab->id = $id;
  94     if (!$id) {
  95       $mailingab->domain_id = CRM_Utils_Array::value('domain_id', $params, CRM_Core_Config::domainID());
  96     }
  97
  98     $mailingab->copyValues($params);
  99
 100     $result = $mailingab->save();
 101
 102     if ($id) {
 103       CRM_Utils_Hook::post('edit', 'MailingAB', $mailingab->id, $mailingab);
 104     }
 105     else {
 106       CRM_Utils_Hook::post('create', 'MailingAB', $mailingab->id, $mailingab);
 107     }
 108
 109     return $result;
 110   }
 111
 112
 113   /**
 114    * Delete MailingAB and all its associated records
 115    *
 116    * @param  int $id id of the mail to delete
 117    *
 118    * @return void
 119    * @static
 120    */
 121   public static function del($id) {
 122     if (empty($id)) {
 123       CRM_Core_Error::fatal();
 124     }
 125     CRM_Core_Transaction::create()->run(function() use ($id) {
 126       CRM_Utils_Hook::pre('delete', 'MailingAB', $id, CRM_Core_DAO::$_nullArray);
 127
 128       $dao = new CRM_Mailing_DAO_MailingAB();
 129       $dao->id = $id;
 130       if ($dao->find(TRUE)) {
 131         $mailing_ids = array($dao->mailing_id_a, $dao->mailing_id_b, $dao->mailing_id_c);
 132         $dao->delete();
 133         foreach ($mailing_ids as $mailing_id) {
 134           if ($mailing_id) {
 135             CRM_Mailing_BAO_Mailing::del($mailing_id);
 136           }
 137         }
 138       }
 139
 140       CRM_Core_Session::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
 141
 142       CRM_Utils_Hook::post('delete', 'MailingAB', $id, $dao);
 143     });
 144   }
 145
 146   /**
 147    * Transfer recipients from the canonical mailing A to the other mailings.
 148    *
 149    * @param CRM_Mailing_DAO_MailingAB $dao
 150    */
 151   public static function distributeRecipients(CRM_Mailing_DAO_MailingAB $dao) {
 152     CRM_Mailing_BAO_Mailing::getRecipients($dao->mailing_id_a, $dao->mailing_id_a, NULL, NULL, TRUE);
 153
 154     //calculate total number of random recipients for mail C from group_percentage selected
 155     $totalCount = CRM_Mailing_BAO_Recipients::mailingSize($dao->mailing_id_a);
 156     $totalSelected = max(1, round(($totalCount * $dao->group_percentage) / 100));
 157
 158     CRM_Mailing_BAO_Recipients::reassign($dao->mailing_id_a, array(
 159       $dao->mailing_id_b => (2 * $totalSelected <= $totalCount) ? $totalSelected : $totalCount - $totalSelected,
 160       $dao->mailing_id_c => max(0, $totalCount - $totalSelected - $totalSelected),
 161     ));
 162
 163   }
 164 }