3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Core_BAO_MailSettings
extends CRM_Core_DAO_MailSettings
{
40 public function __construct() {
41 parent
::__construct();
45 * Return the DAO object containing to the default row of
46 * civicrm_mail_settings and cache it for further calls
50 * @return CRM_Core_BAO_MailSettings DAO with the default mail settings set
52 public static function defaultDAO($reset = FALSE) {
53 static $mailSettings = array();
54 $domainID = CRM_Core_Config
::domainID();
55 if (empty($mailSettings[$domainID]) ||
$reset) {
58 $dao->domain_id
= $domainID;
60 $mailSettings[$domainID] = $dao;
62 return $mailSettings[$domainID];
66 * Return the domain from the default set of settings
68 * @return string default domain
70 public static function defaultDomain() {
71 return self
::defaultDAO()->domain
;
75 * Return the localpart from the default set of settings
77 * @return string default localpart
79 public static function defaultLocalpart() {
80 return self
::defaultDAO()->localpart
;
84 * Return the return path from the default set of settings
86 * @return string default return path
88 public static function defaultReturnPath() {
89 return self
::defaultDAO()->return_path
;
93 * Return the "include message ID" flag from the default set of settings.
95 * @return boolean default include message ID
97 public static function includeMessageId() {
98 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
106 * Takes a bunch of params that are needed to match certain criteria and
107 * retrieves the relevant objects. Typically the valid params are only
108 * mail settings id. It also stores all the retrieved
109 * values in the default array
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.
116 * @return CRM_Core_BAO_MailSettings object
119 public static function retrieve(&$params, &$defaults) {
120 $mailSettings = new CRM_Core_DAO_MailSettings();
121 $mailSettings->copyValues($params);
124 if ($mailSettings->find(TRUE)) {
125 CRM_Core_DAO
::storeValues($mailSettings, $defaults);
126 $result = $mailSettings;
133 * Add new mail Settings.
135 * @param array $params
136 * Reference array contains the values submitted by the form.
142 public static function add(&$params) {
144 if (empty($params)) {
148 if (empty($params['id'])) {
149 $params['is_ssl'] = CRM_Utils_Array
::value('is_ssl', $params, FALSE);
150 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
154 if (!empty($params['is_default'])) {
155 $query = 'UPDATE civicrm_mail_settings SET is_default = 0 WHERE domain_id = %1';
156 $queryParams = array(1 => array(CRM_Core_Config
::domainID(), 'Integer'));
157 CRM_Core_DAO
::executeQuery($query, $queryParams);
160 $mailSettings = new CRM_Core_DAO_MailSettings();
161 $mailSettings->copyValues($params);
162 $result = $mailSettings->save();
168 * Takes an associative array and creates a mail settings object
170 * @param array $params
171 * (reference ) an assoc array of name/value pairs.
173 * @return CRM_Core_BAO_MailSettings object
176 public static function create(&$params) {
177 $transaction = new CRM_Core_Transaction();
179 $mailSettings = self
::add($params);
180 if (is_a($mailSettings, 'CRM_Core_Error')) {
181 $mailSettings->rollback();
182 return $mailSettings;
185 $transaction->commit();
186 CRM_Core_BAO_MailSettings
::defaultDAO(TRUE);
187 return $mailSettings;
191 * Delete the mail settings.
200 public static function deleteMailSettings($id) {
202 $transaction = new CRM_Core_Transaction();
204 $mailSettings = new CRM_Core_DAO_MailSettings();
205 $mailSettings->id
= $id;
206 $results = $mailSettings->delete();
208 $transaction->commit();