CRM/Core/BAO/MailSettings.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  * $Id$
  33  *
  34  */
  35 class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings {
  36
  37   /**
  38    * Class constructor.
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Return the DAO object containing to the default row of
  46    * civicrm_mail_settings and cache it for further calls
  47    *
  48    * @param bool $reset
  49    *
  50    * @return CRM_Core_BAO_MailSettings
  51    *   DAO with the default mail settings set
  52    */
  53   public static function defaultDAO($reset = FALSE) {
  54     static $mailSettings = array();
  55     $domainID = CRM_Core_Config::domainID();
  56     if (empty($mailSettings[$domainID]) || $reset) {
  57       $dao = new self();
  58       $dao->is_default = 1;
  59       $dao->domain_id = $domainID;
  60       $dao->find(TRUE);
  61       $mailSettings[$domainID] = $dao;
  62     }
  63     return $mailSettings[$domainID];
  64   }
  65
  66   /**
  67    * Return the domain from the default set of settings.
  68    *
  69    * @return string
  70    *   default domain
  71    */
  72   public static function defaultDomain() {
  73     return self::defaultDAO()->domain;
  74   }
  75
  76   /**
  77    * Return the localpart from the default set of settings.
  78    *
  79    * @return string
  80    *   default localpart
  81    */
  82   public static function defaultLocalpart() {
  83     return self::defaultDAO()->localpart;
  84   }
  85
  86   /**
  87    * Return the return path from the default set of settings.
  88    *
  89    * @return string
  90    *   default return path
  91    */
  92   public static function defaultReturnPath() {
  93     return self::defaultDAO()->return_path;
  94   }
  95
  96   /**
  97    * Return the "include message ID" flag from the default set of settings.
  98    *
  99    * @return bool
 100    *   default include message ID
 101    */
 102   public static function includeMessageId() {
 103     return Civi::settings()->get('include_message_id');
 104   }
 105
 106   /**
 107    * Retrieve DB object based on input parameters.
 108    *
 109    * It also stores all the retrieved values in the default array.
 110    *
 111    * @param array $params
 112    *   (reference ) an assoc array of name/value pairs.
 113    * @param array $defaults
 114    *   (reference ) an assoc array to hold the flattened values.
 115    *
 116    * @return CRM_Core_BAO_MailSettings
 117    */
 118   public static function retrieve(&$params, &$defaults) {
 119     $mailSettings = new CRM_Core_DAO_MailSettings();
 120     $mailSettings->copyValues($params);
 121
 122     $result = NULL;
 123     if ($mailSettings->find(TRUE)) {
 124       CRM_Core_DAO::storeValues($mailSettings, $defaults);
 125       $result = $mailSettings;
 126     }
 127
 128     return $result;
 129   }
 130
 131   /**
 132    * Add new mail Settings.
 133    *
 134    * @param array $params
 135    *   Reference array contains the values submitted by the form.
 136    *
 137    *
 138    * @return object
 139    */
 140   public static function add(&$params) {
 141     $result = NULL;
 142     if (empty($params)) {
 143       return $result;
 144     }
 145
 146     if (empty($params['id'])) {
 147       $params['is_ssl'] = CRM_Utils_Array::value('is_ssl', $params, FALSE);
 148       $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
 149     }
 150
 151     //handle is_default.
 152     if (!empty($params['is_default'])) {
 153       $query = 'UPDATE civicrm_mail_settings SET is_default = 0 WHERE domain_id = %1';
 154       $queryParams = array(1 => array(CRM_Core_Config::domainID(), 'Integer'));
 155       CRM_Core_DAO::executeQuery($query, $queryParams);
 156     }
 157
 158     $mailSettings = new CRM_Core_DAO_MailSettings();
 159     $mailSettings->copyValues($params);
 160     $result = $mailSettings->save();
 161
 162     return $result;
 163   }
 164
 165   /**
 166    * Takes an associative array and creates a mail settings object.
 167    *
 168    * @param array $params
 169    *   (reference ) an assoc array of name/value pairs.
 170    *
 171    * @return CRM_Core_BAO_MailSettings
 172    */
 173   public static function create(&$params) {
 174     $transaction = new CRM_Core_Transaction();
 175
 176     $mailSettings = self::add($params);
 177     if (is_a($mailSettings, 'CRM_Core_Error')) {
 178       $mailSettings->rollback();
 179       return $mailSettings;
 180     }
 181
 182     $transaction->commit();
 183     CRM_Core_BAO_MailSettings::defaultDAO(TRUE);
 184     return $mailSettings;
 185   }
 186
 187   /**
 188    * Delete the mail settings.
 189    *
 190    * @param int $id
 191    *   Mail settings id.
 192    *
 193    * @return mixed|null
 194    */
 195   public static function deleteMailSettings($id) {
 196     $results = NULL;
 197     $transaction = new CRM_Core_Transaction();
 198
 199     $mailSettings = new CRM_Core_DAO_MailSettings();
 200     $mailSettings->id = $id;
 201     $results = $mailSettings->delete();
 202
 203     $transaction->commit();
 204
 205     return $results;
 206   }
 207
 208 }