CRM/Mailing/BAO/MailingAB.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  */
  33
  34 /**
  35  * Class CRM_Mailing_BAO_MailingAB
  36  */
  37 class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB {
  38
  39   /**
  40    * class constructor.
  41    */
  42   public function __construct() {
  43     parent::__construct();
  44   }
  45
  46   /**
  47    * Construct a new mailingab object.
  48    *
  49    * @params array $params
  50    *   Form values.
  51    *
  52    * @param array $params
  53    * @param array $ids
  54    *
  55    * @return object
  56    *   $mailingab      The new mailingab object
  57    */
  58   public static function create(&$params, $ids = []) {
  59     $transaction = new CRM_Core_Transaction();
  60
  61     $mailingab = self::add($params, $ids);
  62
  63     if (is_a($mailingab, 'CRM_Core_Error')) {
  64       $transaction->rollback();
  65       return $mailingab;
  66     }
  67     $transaction->commit();
  68     return $mailingab;
  69   }
  70
  71   /**
  72    * function to add the mailings.
  73    *
  74    * @param array $params
  75    *   Reference array contains the values submitted by the form.
  76    * @param array $ids
  77    *   Reference array contains the id.
  78    *
  79    *
  80    * @return object
  81    */
  82   public static function add(&$params, $ids = []) {
  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    * Delete MailingAB and all its associated records.
 114    *
 115    * @param int $id
 116    *   Id of the mail to delete.
 117    */
 118   public static function del($id) {
 119     if (empty($id)) {
 120       CRM_Core_Error::fatal();
 121     }
 122     CRM_Core_Transaction::create()->run(function () use ($id) {
 123       CRM_Utils_Hook::pre('delete', 'MailingAB', $id, CRM_Core_DAO::$_nullArray);
 124
 125       $dao = new CRM_Mailing_DAO_MailingAB();
 126       $dao->id = $id;
 127       if ($dao->find(TRUE)) {
 128         $mailing_ids = [$dao->mailing_id_a, $dao->mailing_id_b, $dao->mailing_id_c];
 129         $dao->delete();
 130         foreach ($mailing_ids as $mailing_id) {
 131           if ($mailing_id) {
 132             CRM_Mailing_BAO_Mailing::del($mailing_id);
 133           }
 134         }
 135       }
 136
 137       CRM_Core_Session::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
 138
 139       CRM_Utils_Hook::post('delete', 'MailingAB', $id, $dao);
 140     });
 141   }
 142
 143   /**
 144    * Transfer recipients from the canonical mailing A to the other mailings.
 145    *
 146    * @param CRM_Mailing_DAO_MailingAB $dao
 147    */
 148   public static function distributeRecipients(CRM_Mailing_DAO_MailingAB $dao) {
 149     CRM_Mailing_BAO_Mailing::getRecipients($dao->mailing_id_a);
 150
 151     //calculate total number of random recipients for mail C from group_percentage selected
 152     $totalCount = CRM_Mailing_BAO_Recipients::mailingSize($dao->mailing_id_a);
 153     $totalSelected = max(1, round(($totalCount * $dao->group_percentage) / 100));
 154
 155     CRM_Mailing_BAO_Recipients::reassign($dao->mailing_id_a, [
 156       $dao->mailing_id_b => (2 * $totalSelected <= $totalCount) ? $totalSelected : $totalCount - $totalSelected,
 157       $dao->mailing_id_c => max(0, $totalCount - $totalSelected - $totalSelected),
 158     ]);
 159
 160   }
 161
 162   /**
 163    * get abtest based on Mailing ID
 164    *
 165    * @param int $mailingID
 166    *   Mailing ID.
 167    *
 168    * @return object
 169    */
 170   public static function getABTest($mailingID) {
 171     $query = "SELECT * FROM `civicrm_mailing_abtest` ab
 172       where (ab.mailing_id_a = %1
 173       OR ab.mailing_id_b = %1
 174       OR ab.mailing_id_c = %1)
 175       GROUP BY ab.id";
 176     $params = [1 => [$mailingID, 'Integer']];
 177     $abTest = CRM_Core_DAO::executeQuery($query, $params);
 178     $abTest->fetch();
 179     return $abTest;
 180   }
 181
 182 }