Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
8c9251b3 | 31 | * @copyright CiviCRM LLC (c) 2004-2018 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { | |
36 | ||
37 | /** | |
fe482240 | 38 | * Class constructor. |
6a488035 | 39 | */ |
00be9182 | 40 | public function __construct() { |
6a488035 TO |
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 | * | |
07b3c7ff EM |
48 | * @param bool $reset |
49 | * | |
16b10e64 CW |
50 | * @return CRM_Core_BAO_MailSettings |
51 | * DAO with the default mail settings set | |
6a488035 | 52 | */ |
00be9182 | 53 | public static function defaultDAO($reset = FALSE) { |
07b3c7ff EM |
54 | static $mailSettings = array(); |
55 | $domainID = CRM_Core_Config::domainID(); | |
56 | if (empty($mailSettings[$domainID]) || $reset) { | |
c301f76e | 57 | $dao = new self(); |
6a488035 | 58 | $dao->is_default = 1; |
353ffa53 | 59 | $dao->domain_id = $domainID; |
6a488035 | 60 | $dao->find(TRUE); |
07b3c7ff | 61 | $mailSettings[$domainID] = $dao; |
6a488035 | 62 | } |
07b3c7ff | 63 | return $mailSettings[$domainID]; |
6a488035 TO |
64 | } |
65 | ||
66 | /** | |
fe482240 | 67 | * Return the domain from the default set of settings. |
6a488035 | 68 | * |
a6c01b45 CW |
69 | * @return string |
70 | * default domain | |
6a488035 | 71 | */ |
00be9182 | 72 | public static function defaultDomain() { |
6a488035 TO |
73 | return self::defaultDAO()->domain; |
74 | } | |
75 | ||
76 | /** | |
fe482240 | 77 | * Return the localpart from the default set of settings. |
6a488035 | 78 | * |
a6c01b45 CW |
79 | * @return string |
80 | * default localpart | |
6a488035 | 81 | */ |
00be9182 | 82 | public static function defaultLocalpart() { |
6a488035 TO |
83 | return self::defaultDAO()->localpart; |
84 | } | |
85 | ||
86 | /** | |
fe482240 | 87 | * Return the return path from the default set of settings. |
6a488035 | 88 | * |
a6c01b45 CW |
89 | * @return string |
90 | * default return path | |
6a488035 | 91 | */ |
00be9182 | 92 | public static function defaultReturnPath() { |
6a488035 TO |
93 | return self::defaultDAO()->return_path; |
94 | } | |
95 | ||
96 | /** | |
97 | * Return the "include message ID" flag from the default set of settings. | |
98 | * | |
c301f76e | 99 | * @return bool |
a6c01b45 | 100 | * default include message ID |
6a488035 | 101 | */ |
00be9182 | 102 | public static function includeMessageId() { |
89595c92 | 103 | return Civi::settings()->get('include_message_id'); |
6a488035 TO |
104 | } |
105 | ||
106 | /** | |
fe482240 EM |
107 | * Retrieve DB object based on input parameters. |
108 | * | |
109 | * It also stores all the retrieved values in the default array. | |
6a488035 | 110 | * |
6a0b768e TO |
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. | |
6a488035 | 115 | * |
16b10e64 | 116 | * @return CRM_Core_BAO_MailSettings |
6a488035 | 117 | */ |
00be9182 | 118 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
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 | /** | |
100fef9d | 132 | * Add new mail Settings. |
6a488035 | 133 | * |
6a0b768e TO |
134 | * @param array $params |
135 | * Reference array contains the values submitted by the form. | |
6a488035 | 136 | * |
6a488035 TO |
137 | * |
138 | * @return object | |
139 | */ | |
00be9182 | 140 | public static function add(&$params) { |
6a488035 TO |
141 | $result = NULL; |
142 | if (empty($params)) { | |
143 | return $result; | |
144 | } | |
145 | ||
22e263ad | 146 | if (empty($params['id'])) { |
e123fef4 EM |
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 | } | |
6a488035 TO |
150 | |
151 | //handle is_default. | |
e123fef4 | 152 | if (!empty($params['is_default'])) { |
6a488035 TO |
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 | /** | |
fe482240 | 166 | * Takes an associative array and creates a mail settings object. |
6a488035 | 167 | * |
6a0b768e TO |
168 | * @param array $params |
169 | * (reference ) an assoc array of name/value pairs. | |
6a488035 | 170 | * |
16b10e64 | 171 | * @return CRM_Core_BAO_MailSettings |
6a488035 | 172 | */ |
00be9182 | 173 | public static function create(&$params) { |
6a488035 TO |
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(); | |
e123fef4 | 183 | CRM_Core_BAO_MailSettings::defaultDAO(TRUE); |
6a488035 TO |
184 | return $mailSettings; |
185 | } | |
186 | ||
187 | /** | |
100fef9d | 188 | * Delete the mail settings. |
6a488035 | 189 | * |
6a0b768e TO |
190 | * @param int $id |
191 | * Mail settings id. | |
6a488035 | 192 | * |
77b97be7 | 193 | * @return mixed|null |
6a488035 | 194 | */ |
00be9182 | 195 | public static function deleteMailSettings($id) { |
6a488035 TO |
196 | $results = NULL; |
197 | $transaction = new CRM_Core_Transaction(); | |
198 | ||
353ffa53 | 199 | $mailSettings = new CRM_Core_DAO_MailSettings(); |
6a488035 | 200 | $mailSettings->id = $id; |
353ffa53 | 201 | $results = $mailSettings->delete(); |
6a488035 TO |
202 | |
203 | $transaction->commit(); | |
204 | ||
205 | return $results; | |
206 | } | |
96025800 | 207 | |
6a488035 | 208 | } |