3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Page for displaying list of Payment-Instrument
21 class CRM_Member_Page_DashBoard
extends CRM_Core_Page
{
24 * Heart of the viewing process. The runner gets all the meta data for
25 * the contact and calls the appropriate type of page to view.
29 public function preProcess() {
31 //CRM-13901 don't show dashboard to contacts with limited view writes & it does not relect
32 //what they have access to
33 //@todo implement acls on dashboard querys (preferably via api to enhance that at the same time)
34 if (!CRM_Core_Permission
::check('view all contacts') && !CRM_Core_Permission
::check('edit all contacts')) {
35 $this->showMembershipSummary
= FALSE;
36 $this->assign('membershipSummary', FALSE);
39 $this->assign('membershipSummary', TRUE);
40 CRM_Utils_System
::setTitle(ts('CiviMember'));
41 $membershipSummary = [];
42 $preMonth = date("Y-m-d", mktime(0, 0, 0, date("m") - 1, 01, date("Y")));
43 $preMonthEnd = date("Y-m-t", mktime(0, 0, 0, date("m") - 1, 01, date("Y")));
45 $preMonthYear = mktime(0, 0, 0, substr($preMonth, 4, 2), 1, substr($preMonth, 0, 4));
48 $date = CRM_Utils_Date
::getToday();
51 // You can force the dashboard to display based upon a certain date
52 $ym = $_GET['date'] ??
NULL;
55 if (preg_match('/^\d{6}$/', $ym) == 0 ||
56 !checkdate(substr($ym, 4, 2), 1, substr($ym, 0, 4)) ||
57 substr($ym, 0, 1) == 0
59 CRM_Core_Error
::statusBounce(ts('Invalid date query "%1" in URL (valid syntax is yyyymm).', array(1 => $ym)));
63 $isCurrentMonth = substr($ym, 0, 4) == $today['year'] && substr($ym, 4, 2) == $today['mon'];
64 $ymd = date('Y-m-d', mktime(0, 0, -1, substr($ym, 4, 2) +
1, 1, substr($ym, 0, 4)));
65 $monthStartTs = mktime(0, 0, 0, substr($ym, 4, 2), 1, substr($ym, 0, 4));
66 $current = CRM_Utils_Date
::customFormat($date, '%Y-%m-%d');
67 $ym = substr($ym, 0, 4) . '-' . substr($ym, 4, 2);
70 $ym = sprintf("%04d-%02d", $today['year'], $today['mon']);
71 $ymd = sprintf("%04d-%02d-%02d", $today['year'], $today['mon'], $today['mday']);
72 $monthStartTs = mktime(0, 0, 0, $today['mon'], 1, $today['year']);
73 $current = CRM_Utils_Date
::customFormat($date, '%Y-%m-%d');
77 $monthStart = $ym . '-01';
78 $yearStart = substr($ym, 0, 4) . '-01-01';
80 $membershipTypes = CRM_Member_BAO_MembershipType
::getMembershipTypes(FALSE);
82 //$membership = new CRM_Member_BAO_Membership;
84 foreach ($membershipTypes as $key => $value) {
86 $membershipSummary[$key]['premonth']['new'] = array(
87 'count' => CRM_Member_BAO_Membership
::getMembershipJoins($key, $preMonth, $preMonthEnd),
92 $membershipSummary[$key]['premonth']['renew'] = array(
93 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $preMonth, $preMonthEnd),
98 $membershipSummary[$key]['premonth']['total'] = array(
99 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $preMonth, $preMonthEnd),
104 $membershipSummary[$key]['month']['new'] = array(
105 'count' => CRM_Member_BAO_Membership
::getMembershipJoins($key, $monthStart, $ymd),
110 $membershipSummary[$key]['month']['renew'] = array(
111 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $monthStart, $ymd),
116 $membershipSummary[$key]['month']['total'] = array(
117 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $monthStart, $ymd),
122 $membershipSummary[$key]['year']['new'] = array(
123 'count' => CRM_Member_BAO_Membership
::getMembershipJoins($key, $yearStart, $ymd),
128 $membershipSummary[$key]['year']['renew'] = array(
129 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $yearStart, $ymd),
134 $membershipSummary[$key]['year']['total'] = array(
135 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $yearStart, $ymd),
140 $membershipSummary[$key]['current']['total'] = array(
141 'count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $current),
146 $membershipSummary[$key]['total']['total'] = array('count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $ymd));
148 //LCD also get summary stats for membership owners
149 $membershipSummary[$key]['premonth_owner']['premonth_owner'] = array(
150 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $preMonth, $preMonthEnd, 0, 1),
155 $membershipSummary[$key]['month_owner']['month_owner'] = array(
156 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $monthStart, $ymd, 0, 1),
161 $membershipSummary[$key]['year_owner']['year_owner'] = array(
162 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $yearStart, $ymd, 0, 1),
167 $membershipSummary[$key]['current_owner']['current_owner'] = array(
168 'count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $current, 0, 1),
173 $membershipSummary[$key]['total_owner']['total_owner'] = array('count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $ymd, 0, 1));
177 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusCurrent();
178 $status = implode(',', $status);
180 foreach ($membershipSummary as $typeID => $details) {
181 if (!$isCurrentMonth) {
182 $membershipSummary[$typeID]['total']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search',
183 "reset=1&force=1&start=&end=$ymd&membership_status_id=$status&membership_type_id=$typeID"
185 $membershipSummary[$typeID]['total_owner']['total_owner']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&start=&end=$ymd&membership_status_id=$status&membership_type_id=$typeID&owner=1");
188 $membershipSummary[$typeID]['total']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search',
189 "reset=1&force=1&membership_status_id=$status"
191 $membershipSummary[$typeID]['total_owner']['total_owner']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1");
193 $membershipSummary[$typeID]['current']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&membership_type_id=$typeID");
194 $membershipSummary[$typeID]['current_owner']['current_owner']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&membership_type_id=$typeID&owner=1");
199 $newCountPreMonth = $newCountMonth = $newCountYear = 0;
200 $renewCountPreMonth = $renewCountMonth = $renewCountYear = 0;
202 $totalCountPreMonth = $totalCountMonth = $totalCountYear = $totalCountCurrent = $totalCountTotal = 0;
203 $totalCountPreMonth_owner = $totalCountMonth_owner = $totalCountYear_owner = $totalCountCurrent_owner = $totalCountTotal_owner = 0;
204 foreach ($membershipSummary as $key => $value) {
205 $newCountPreMonth = $newCountPreMonth +
$value['premonth']['new']['count'];
206 $renewCountPreMonth = $renewCountPreMonth +
$value['premonth']['renew']['count'];
207 $totalCountPreMonth = $totalCountPreMonth +
$value['premonth']['total']['count'];
208 $newCountMonth = $newCountMonth +
$value['month']['new']['count'];
209 $renewCountMonth = $renewCountMonth +
$value['month']['renew']['count'];
210 $totalCountMonth = $totalCountMonth +
$value['month']['total']['count'];
211 $newCountYear = $newCountYear +
$value['year']['new']['count'];
212 $renewCountYear = $renewCountYear +
$value['year']['renew']['count'];
213 $totalCountYear = $totalCountYear +
$value['year']['total']['count'];
214 $totalCountCurrent = $totalCountCurrent +
$value['current']['total']['count'];
215 $totalCountTotal = $totalCountTotal +
$value['total']['total']['count'];
217 //LCD add owner values
218 $totalCountPreMonth_owner = $totalCountPreMonth_owner +
$value['premonth_owner']['premonth_owner']['count'];
219 $totalCountMonth_owner = $totalCountMonth_owner +
$value['month_owner']['month_owner']['count'];
220 $totalCountYear_owner = $totalCountYear_owner +
$value['year_owner']['year_owner']['count'];
221 $totalCountCurrent_owner = $totalCountCurrent_owner +
$value['current_owner']['current_owner']['count'];
222 $totalCountTotal_owner = $totalCountTotal_owner +
$value['total_owner']['total_owner']['count'];
225 $totalCount['premonth']['new'] = array(
226 'count' => $newCountPreMonth,
230 $totalCount['premonth']['renew'] = array(
231 'count' => $renewCountPreMonth,
235 $totalCount['premonth']['total'] = array(
236 'count' => $totalCountPreMonth,
240 $totalCount['month']['new'] = array(
241 'count' => $newCountMonth,
245 $totalCount['month']['renew'] = array(
246 'count' => $renewCountMonth,
250 $totalCount['month']['total'] = array(
251 'count' => $totalCountMonth,
255 $totalCount['year']['new'] = array(
256 'count' => $newCountYear,
260 $totalCount['year']['renew'] = array(
261 'count' => $renewCountYear,
265 $totalCount['year']['total'] = array(
266 'count' => $totalCountYear,
270 $totalCount['current']['total'] = array(
271 'count' => $totalCountCurrent,
272 'url' => CRM_Utils_System
::url('civicrm/member/search',
273 "reset=1&force=1&membership_status_id=$status"
277 $totalCount['total']['total'] = array(
278 'count' => $totalCountTotal,
279 'url' => CRM_Utils_System
::url('civicrm/member/search',
280 "reset=1&force=1&membership_status_id=$status"
284 if (!$isCurrentMonth) {
285 $totalCount['total']['total'] = array(
286 'count' => $totalCountTotal,
287 'url' => CRM_Utils_System
::url('civicrm/member/search',
288 "reset=1&force=1&membership_status_id=$status&start=&end=$ymd"
293 // Activity search also unable to handle owner vs. inherited
295 //LCD add owner values
296 $totalCount['premonth_owner']['premonth_owner'] = array(
297 'count' => $totalCountPreMonth_owner,
299 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$preMonth&end=$preMonthEnd&owner=1"),
302 $totalCount['month_owner']['month_owner'] = array(
303 'count' => $totalCountMonth_owner,
305 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$monthStart&end=$ymd&owner=1"),
308 $totalCount['year_owner']['year_owner'] = array(
309 'count' => $totalCountYear_owner,
311 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$yearStart&end=$ymd&owner=1"),
314 $totalCount['current_owner']['current_owner'] = array(
315 'count' => $totalCountCurrent_owner,
317 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
320 $totalCount['total_owner']['total_owner'] = array(
321 'count' => $totalCountTotal_owner,
323 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
326 if (!$isCurrentMonth) {
327 $totalCount['total_owner']['total_owner'] = array(
328 'count' => $totalCountTotal_owner,
330 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=&end=$ymd&owner=1"),
335 $this->assign('membershipSummary', $membershipSummary);
336 $this->assign('totalCount', $totalCount);
337 $this->assign('month', CRM_Utils_Date
::customFormatTs($monthStartTs, '%B'));
338 $this->assign('year', date('Y', $monthStartTs));
339 $this->assign('premonth', CRM_Utils_Date
::customFormat($preMonth, '%B'));
340 $this->assign('currentMonth', date('F'));
341 $this->assign('currentYear', date('Y'));
342 $this->assign('isCurrent', $isCurrentMonth);
343 $this->assign('preMonth', $isPreviousMonth);
347 * the main function that is called when the page loads,
348 * it decides the which action has to be taken for the page.
352 public function run() {
355 $controller = new CRM_Core_Controller_Simple('CRM_Member_Form_Search', ts('Member'), NULL);
356 $controller->setEmbedded(TRUE);
357 $controller->reset();
358 $controller->set('limit', 20);
359 $controller->set('force', 1);
360 $controller->set('context', 'dashboard');
361 $controller->process();
364 return parent
::run();