Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
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 | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
95cdcc0f | 35 | * Class to retrieve information about a contribution page. |
6a488035 TO |
36 | */ |
37 | class CRM_Contribute_BAO_Widget extends CRM_Contribute_DAO_Widget { | |
38 | ||
39 | /** | |
40 | * Gets all campaign related data and returns it as a std class. | |
41 | * | |
42 | * @param int $contributionPageID | |
c6a8e7a3 | 43 | * @param int $widgetID |
8bf434e2 | 44 | * @param bool $includePending |
6a488035 | 45 | * |
bed98343 | 46 | * @return object |
6a488035 | 47 | */ |
8bf434e2 | 48 | public static function getContributionPageData($contributionPageID, $widgetID, $includePending = FALSE) { |
6a488035 TO |
49 | $config = CRM_Core_Config::singleton(); |
50 | ||
be2fb01f | 51 | $data = []; |
a5dfa653 | 52 | $data['currencySymbol'] = CRM_Core_BAO_Country::defaultCurrencySymbol(); |
6a488035 TO |
53 | |
54 | if (empty($contributionPageID) || | |
55 | CRM_Utils_Type::validate($contributionPageID, 'Integer') == NULL | |
56 | ) { | |
57 | $data['is_error'] = TRUE; | |
58 | CRM_Core_Error::debug_log_message("$contributionPageID is not set"); | |
59 | return $data; | |
60 | } | |
61 | ||
62 | $widget = new CRM_Contribute_DAO_Widget(); | |
63 | $widget->contribution_page_id = $contributionPageID; | |
64 | if (!$widget->find(TRUE)) { | |
65 | $data['is_error'] = TRUE; | |
66 | CRM_Core_Error::debug_log_message("$contributionPageID is not found"); | |
67 | return $data; | |
68 | } | |
69 | ||
70 | $data['is_error'] = FALSE; | |
71 | if (!$widget->is_active) { | |
72 | $data['is_active'] = FALSE; | |
73 | } | |
74 | ||
75 | $data['is_active'] = TRUE; | |
76 | $data['title'] = $widget->title; | |
77 | $data['logo'] = $widget->url_logo; | |
78 | $data['button_title'] = $widget->button_title; | |
79 | $data['about'] = $widget->about; | |
80 | ||
c6a8e7a3 | 81 | //check if pending status needs to be included |
82 | $status = '1'; | |
83 | if ($includePending) { | |
84 | $status = '1,2'; | |
85 | } | |
86 | ||
6a488035 TO |
87 | $query = " |
88 | SELECT count( id ) as count, | |
89 | sum( total_amount) as amount | |
90 | FROM civicrm_contribution | |
91 | WHERE is_test = 0 | |
c6a8e7a3 | 92 | AND contribution_status_id IN ({$status}) |
6a488035 | 93 | AND contribution_page_id = %1"; |
be2fb01f | 94 | $params = [1 => [$contributionPageID, 'Integer']]; |
6a488035 TO |
95 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
96 | if ($dao->fetch()) { | |
353ffa53 TO |
97 | $data['num_donors'] = (int) $dao->count; |
98 | $data['money_raised'] = (int) $dao->amount; | |
6a488035 TO |
99 | } |
100 | else { | |
101 | $data['num_donors'] = $data['money_raised'] = $data->money_raised = 0; | |
102 | } | |
103 | ||
5b89c9e7 | 104 | $data['money_raised_amount'] = CRM_Utils_Money::format($data['money_raised']); |
105 | ||
6a488035 TO |
106 | $query = " |
107 | SELECT goal_amount, start_date, end_date, is_active | |
108 | FROM civicrm_contribution_page | |
109 | WHERE id = %1"; | |
be2fb01f | 110 | $params = [1 => [$contributionPageID, 'Integer']]; |
6a488035 TO |
111 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
112 | ||
113 | $data['campaign_start'] = ''; | |
114 | $startDate = NULL; | |
115 | if ($dao->fetch()) { | |
353ffa53 | 116 | $data['money_target'] = (int) $dao->goal_amount; |
6a488035 TO |
117 | |
118 | // conditions that needs to be handled | |
119 | // 1. Campaign is not active - no text | |
120 | // 2. Campaign start date greater than today - show start date | |
121 | // 3. Campaign end date is set and greater than today - show end date | |
122 | // 4. If no start and end date or no end date and start date greater than today, then it's ongoing | |
123 | if ($dao->is_active) { | |
124 | $data['campaign_start'] = ts('Campaign is ongoing'); | |
125 | ||
126 | // check for time being between start and end date | |
127 | $now = time(); | |
128 | if ($dao->start_date) { | |
129 | $startDate = CRM_Utils_Date::unixTime($dao->start_date); | |
97301636 | 130 | $data['start_date'] = $dao->start_date; |
1330f57a | 131 | if ($startDate && $startDate >= $now) { |
6a488035 | 132 | $data['is_active'] = FALSE; |
be2fb01f | 133 | $data['campaign_start'] = ts('Campaign starts on %1', [ |
1330f57a SL |
134 | 1 => CRM_Utils_Date::customFormat($dao->start_date, $config->dateformatFull), |
135 | ]); | |
6a488035 TO |
136 | } |
137 | } | |
138 | ||
139 | if ($dao->end_date) { | |
140 | $endDate = CRM_Utils_Date::unixTime($dao->end_date); | |
97301636 | 141 | $data['end_date'] = $dao->end_date; |
6a488035 TO |
142 | if ($endDate && |
143 | $endDate < $now | |
144 | ) { | |
145 | $data['is_active'] = FALSE; | |
bed98343 | 146 | $data['campaign_start'] = ts('Campaign ended on %1', |
be2fb01f | 147 | [ |
bed98343 | 148 | 1 => CRM_Utils_Date::customFormat($dao->end_date, $config->dateformatFull), |
be2fb01f | 149 | ] |
bed98343 | 150 | ); |
6a488035 TO |
151 | } |
152 | elseif ($startDate >= $now) { | |
bed98343 | 153 | $data['campaign_start'] = ts('Campaign starts on %1', |
be2fb01f | 154 | [ |
bed98343 | 155 | 1 => CRM_Utils_Date::customFormat($dao->start_date, $config->dateformatFull), |
be2fb01f | 156 | ] |
bed98343 | 157 | ); |
6a488035 TO |
158 | } |
159 | else { | |
bed98343 | 160 | $data['campaign_start'] = ts('Campaign ends on %1', |
be2fb01f | 161 | [ |
bed98343 | 162 | 1 => CRM_Utils_Date::customFormat($dao->end_date, $config->dateformatFull), |
be2fb01f | 163 | ] |
bed98343 | 164 | ); |
6a488035 TO |
165 | } |
166 | } | |
167 | } | |
168 | else { | |
169 | $data['is_active'] = FALSE; | |
170 | } | |
171 | } | |
172 | else { | |
173 | $data['is_active'] = FALSE; | |
174 | } | |
175 | ||
176 | $data['money_raised_percentage'] = 0; | |
177 | if ($data['money_target'] > 0) { | |
178 | $percent = $data['money_raised'] / $data['money_target']; | |
179 | $data['money_raised_percentage'] = (round($percent, 2)) * 100 . "%"; | |
180 | $data['money_target_display'] = CRM_Utils_Money::format($data['money_target']); | |
be2fb01f | 181 | $data['money_raised'] = ts('Raised %1 of %2', [ |
1330f57a SL |
182 | 1 => CRM_Utils_Money::format($data['money_raised']), |
183 | 2 => $data['money_target_display'], | |
184 | ]); | |
6a488035 TO |
185 | } |
186 | else { | |
be2fb01f | 187 | $data['money_raised'] = ts('Raised %1', [1 => CRM_Utils_Money::format($data['money_raised'])]); |
6a488035 TO |
188 | } |
189 | ||
353ffa53 | 190 | $data['money_low'] = 0; |
6a488035 | 191 | $data['num_donors'] = $data['num_donors'] . " " . ts('Donors'); |
353ffa53 | 192 | $data['home_url'] = "<a href='{$config->userFrameworkBaseURL}' class='crm-home-url' style='color:" . $widget->color_homepage_link . "'>" . ts('Learn more.') . "</a>"; |
6a488035 TO |
193 | |
194 | // if is_active is false, show this link and hide the contribute button | |
195 | $data['homepage_link'] = $widget->url_homepage; | |
196 | ||
be2fb01f | 197 | $data['colors'] = []; |
6a488035 TO |
198 | |
199 | $data['colors']["title"] = $widget->color_title; | |
200 | $data['colors']["button"] = $widget->color_button; | |
201 | $data['colors']["bar"] = $widget->color_bar; | |
202 | $data['colors']["main_text"] = $widget->color_main_text; | |
203 | $data['colors']["main"] = $widget->color_main; | |
204 | $data['colors']["main_bg"] = $widget->color_main_bg; | |
205 | $data['colors']["bg"] = $widget->color_bg; | |
206 | $data['colors']["about_link"] = $widget->color_about_link; | |
207 | ||
208 | return $data; | |
209 | } | |
96025800 | 210 | |
6a488035 | 211 | } |