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