CRM/Core/BAO/MailSettings.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings {
  18
  19   /**
  20    * Class constructor.
  21    */
  22   public function __construct() {
  23     parent::__construct();
  24   }
  25
  26   /**
  27    * Get a list of setup-actions.
  28    *
  29    * @return array
  30    *   List of available actions. See description in the hook-docs.
  31    * @see CRM_Utils_Hook::mailSetupActions()
  32    */
  33   public static function getSetupActions() {
  34     $setupActions = [];
  35     $setupActions['standard'] = [
  36       'title' => ts('Standard Mail Account'),
  37       'callback' => ['CRM_Core_BAO_MailSettings', 'setupStandardAccount'],
  38     ];
  39
  40     CRM_Utils_Hook::mailSetupActions($setupActions);
  41     return $setupActions;
  42   }
  43
  44   public static function setupStandardAccount($setupAction) {
  45     return [
  46       'url' => CRM_Utils_System::url('civicrm/admin/mailSettings', 'action=add&reset=1', TRUE, NULL, FALSE),
  47     ];
  48   }
  49
  50   /**
  51    * Return the DAO object containing to the default row of
  52    * civicrm_mail_settings and cache it for further calls
  53    *
  54    * @param bool $reset
  55    *
  56    * @return CRM_Core_BAO_MailSettings
  57    *   DAO with the default mail settings set
  58    */
  59   public static function defaultDAO($reset = FALSE) {
  60     static $mailSettings = [];
  61     $domainID = CRM_Core_Config::domainID();
  62     if (empty($mailSettings[$domainID]) || $reset) {
  63       $dao = new self();
  64       $dao->is_default = 1;
  65       $dao->domain_id = $domainID;
  66       $dao->find(TRUE);
  67       $mailSettings[$domainID] = $dao;
  68     }
  69     return $mailSettings[$domainID];
  70   }
  71
  72   /**
  73    * Return the domain from the default set of settings.
  74    *
  75    * @return string
  76    *   default domain
  77    */
  78   public static function defaultDomain() {
  79     return self::defaultDAO()->domain;
  80   }
  81
  82   /**
  83    * Return the localpart from the default set of settings.
  84    *
  85    * @return string
  86    *   default localpart
  87    */
  88   public static function defaultLocalpart() {
  89     return self::defaultDAO()->localpart;
  90   }
  91
  92   /**
  93    * Return the return path from the default set of settings.
  94    *
  95    * @return string
  96    *   default return path
  97    */
  98   public static function defaultReturnPath() {
  99     return self::defaultDAO()->return_path;
 100   }
 101
 102   /**
 103    * Return the "include message ID" flag from the default set of settings.
 104    *
 105    * @return bool
 106    *   default include message ID
 107    */
 108   public static function includeMessageId() {
 109     return Civi::settings()->get('include_message_id');
 110   }
 111
 112   /**
 113    * Retrieve DB object based on input parameters.
 114    *
 115    * It also stores all the retrieved values in the default array.
 116    *
 117    * @param array $params
 118    *   (reference ) an assoc array of name/value pairs.
 119    * @param array $defaults
 120    *   (reference ) an assoc array to hold the flattened values.
 121    *
 122    * @return CRM_Core_BAO_MailSettings
 123    */
 124   public static function retrieve(&$params, &$defaults) {
 125     $mailSettings = new CRM_Core_DAO_MailSettings();
 126     $mailSettings->copyValues($params);
 127
 128     $result = NULL;
 129     if ($mailSettings->find(TRUE)) {
 130       CRM_Core_DAO::storeValues($mailSettings, $defaults);
 131       $result = $mailSettings;
 132     }
 133
 134     return $result;
 135   }
 136
 137   /**
 138    * Add new mail Settings.
 139    *
 140    * @param array $params
 141    *   Reference array contains the values submitted by the form.
 142    *
 143    *
 144    * @return object
 145    */
 146   public static function add(&$params) {
 147     $result = NULL;
 148     if (empty($params)) {
 149       return $result;
 150     }
 151
 152     if (empty($params['id'])) {
 153       $params['is_ssl'] = CRM_Utils_Array::value('is_ssl', $params, FALSE);
 154       $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
 155     }
 156
 157     //handle is_default.
 158     if (!empty($params['is_default'])) {
 159       $query = 'UPDATE civicrm_mail_settings SET is_default = 0 WHERE domain_id = %1';
 160       $queryParams = [1 => [CRM_Core_Config::domainID(), 'Integer']];
 161       CRM_Core_DAO::executeQuery($query, $queryParams);
 162     }
 163
 164     $mailSettings = new CRM_Core_DAO_MailSettings();
 165     $mailSettings->copyValues($params);
 166     $result = $mailSettings->save();
 167
 168     return $result;
 169   }
 170
 171   /**
 172    * Takes an associative array and creates a mail settings object.
 173    *
 174    * @param array $params
 175    *   (reference ) an assoc array of name/value pairs.
 176    *
 177    * @return CRM_Core_BAO_MailSettings
 178    */
 179   public static function create(&$params) {
 180     $transaction = new CRM_Core_Transaction();
 181
 182     $mailSettings = self::add($params);
 183     if (is_a($mailSettings, 'CRM_Core_Error')) {
 184       $mailSettings->rollback();
 185       return $mailSettings;
 186     }
 187
 188     $transaction->commit();
 189     CRM_Core_BAO_MailSettings::defaultDAO(TRUE);
 190     return $mailSettings;
 191   }
 192
 193   /**
 194    * Delete the mail settings.
 195    *
 196    * @param int $id
 197    *   Mail settings id.
 198    *
 199    * @return mixed|null
 200    */
 201   public static function deleteMailSettings($id) {
 202     $results = NULL;
 203     $transaction = new CRM_Core_Transaction();
 204
 205     $mailSettings = new CRM_Core_DAO_MailSettings();
 206     $mailSettings->id = $id;
 207     $results = $mailSettings->delete();
 208
 209     $transaction->commit();
 210
 211     return $results;
 212   }
 213
 214 }