CRM/Mailing/BAO/MailingComponent.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 class CRM_Mailing_BAO_MailingComponent extends CRM_Mailing_DAO_MailingComponent {
  34
  35   /**
  36    * Fetch object based on array of properties.
  37    *
  38    * @param array $params
  39    *   (reference ) an assoc array of name/value pairs.
  40    * @param array $defaults
  41    *   (reference ) an assoc array to hold the flattened values.
  42    *
  43    * @return CRM_Core_BAO_LocationType.
  44    */
  45   public static function retrieve(&$params, &$defaults) {
  46     $component = new CRM_Mailing_DAO_MailingComponent();
  47     $component->copyValues($params);
  48     if ($component->find(TRUE)) {
  49       CRM_Core_DAO::storeValues($component, $defaults);
  50       return $component;
  51     }
  52     return NULL;
  53   }
  54
  55   /**
  56    * Update the is_active flag in the db.
  57    *
  58    * @param int $id
  59    *   Id of the database record.
  60    * @param bool $is_active
  61    *   Value we want to set the is_active field.
  62    *
  63    * @return bool
  64    *   true if we found and updated the object, else false
  65    */
  66   public static function setIsActive($id, $is_active) {
  67     return CRM_Core_DAO::setFieldValue('CRM_Mailing_DAO_MailingComponent', $id, 'is_active', $is_active);
  68   }
  69
  70   /**
  71    * Create and Update mailing component.
  72    *
  73    * @param array $params
  74    *   (reference ) an assoc array of name/value pairs.
  75    * @param array $ids
  76    *   (deprecated) the array that holds all the db ids.
  77    *
  78    * @return CRM_Mailing_BAO_MailingComponent
  79    */
  80   public static function add(&$params, $ids = []) {
  81     $id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('id', $ids));
  82     $component = new CRM_Mailing_BAO_MailingComponent();
  83     if ($id) {
  84       $component->id = $id;
  85       $component->find(TRUE);
  86     }
  87
  88     $component->copyValues($params);
  89     if (empty($id) && empty($params['body_text'])) {
  90       $component->body_text = CRM_Utils_String::htmlToText(CRM_Utils_Array::value('body_html', $params));
  91     }
  92
  93     if ($component->is_default) {
  94       if (!empty($id)) {
  95         $sql = 'UPDATE civicrm_mailing_component SET is_default = 0 WHERE component_type = %1 AND id <> %2';
  96         $sqlParams = [
  97           1 => [$component->component_type, 'String'],
  98           2 => [$id, 'Positive'],
  99         ];
 100       }
 101       else {
 102         $sql = 'UPDATE civicrm_mailing_component SET is_default = 0 WHERE component_type = %1';
 103         $sqlParams = [
 104           1 => [$component->component_type, 'String'],
 105         ];
 106       }
 107       CRM_Core_DAO::executeQuery($sql, $sqlParams);
 108     }
 109
 110     $component->save();
 111     return $component;
 112   }
 113
 114 }