Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component { | |
36 | ||
37 | /** | |
38 | * class constructor | |
39 | */ | |
40 | function __construct() { | |
41 | parent::__construct(); | |
42 | } | |
43 | ||
44 | /** | |
45 | * Takes a bunch of params that are needed to match certain criteria and | |
46 | * retrieves the relevant objects. Typically the valid params are only | |
47 | * contact_id. We'll tweak this function to be more full featured over a period | |
48 | * of time. This is the inverse function of create. It also stores all the retrieved | |
49 | * values in the default array | |
50 | * | |
51 | * @param array $params (reference ) an assoc array of name/value pairs | |
52 | * @param array $defaults (reference ) an assoc array to hold the flattened values | |
53 | * | |
54 | * @return object CRM_Core_BAO_LocaationType object | |
55 | * @access public | |
56 | * @static | |
57 | */ | |
58 | static function retrieve(&$params, &$defaults) { | |
59 | $component = new CRM_Mailing_DAO_Component(); | |
60 | $component->copyValues($params); | |
61 | if ($component->find(TRUE)) { | |
62 | CRM_Core_DAO::storeValues($component, $defaults); | |
63 | return $component; | |
64 | } | |
65 | return NULL; | |
66 | } | |
67 | ||
68 | /** | |
69 | * update the is_active flag in the db | |
70 | * | |
71 | * @param int $id id of the database record | |
72 | * @param boolean $is_active value we want to set the is_active field | |
73 | * | |
74 | * @return Object DAO object on sucess, null otherwise | |
75 | * @static | |
76 | */ | |
77 | static function setIsActive($id, $is_active) { | |
78 | return CRM_Core_DAO::setFieldValue('CRM_Mailing_DAO_Component', $id, 'is_active', $is_active); | |
79 | } | |
80 | ||
81 | /** | |
82 | * Create and Update mailing component | |
83 | * | |
84 | * @param array $params (reference ) an assoc array of name/value pairs | |
85 | * @param array $ids (reference ) the array that holds all the db ids | |
86 | * | |
87 | * @return object CRM_Mailing_BAO_Component object | |
88 | * | |
89 | * @access public | |
90 | * @static | |
91 | */ | |
92 | static function add(&$params, &$ids) { | |
93 | // action is taken depending upon the mode | |
94 | $component = new CRM_Mailing_DAO_Component(); | |
95 | $component->name = $params['name']; | |
96 | $component->component_type = $params['component_type']; | |
97 | $component->subject = $params['subject']; | |
98 | if ($params['body_text']) { | |
99 | $component->body_text = $params['body_text']; | |
100 | } | |
101 | else { | |
102 | $component->body_text = CRM_Utils_String::htmlToText($params['body_html']); | |
103 | } | |
104 | $component->body_html = $params['body_html']; | |
105 | $component->is_active = CRM_Utils_Array::value('is_active', $params, FALSE); | |
106 | $component->is_default = CRM_Utils_Array::value('is_default', $params, FALSE); | |
107 | ||
108 | if ($component->is_default) { | |
109 | $query = "UPDATE civicrm_mailing_component SET is_default = 0 WHERE component_type ='{$component->component_type}'"; | |
110 | CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray); | |
111 | } | |
112 | ||
113 | $component->id = CRM_Utils_Array::value('id', $ids); | |
114 | ||
115 | $component->save(); | |
116 | ||
117 | CRM_Core_Session::setStatus(ts('The mailing component \'%1\' has been saved.', | |
118 | array(1 => $component->name) | |
119 | ), ts('Saved'), 'success'); | |
120 | } | |
121 | } |