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),
91 $membershipSummary[$key]['premonth']['renew'] = array(
92 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $preMonth, $preMonthEnd),
96 $membershipSummary[$key]['premonth']['total'] = array(
97 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $preMonth, $preMonthEnd),
101 $membershipSummary[$key]['month']['new'] = array(
102 'count' => CRM_Member_BAO_Membership
::getMembershipJoins($key, $monthStart, $ymd),
106 $membershipSummary[$key]['month']['renew'] = array(
107 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $monthStart, $ymd),
111 $membershipSummary[$key]['month']['total'] = array(
112 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $monthStart, $ymd),
116 $membershipSummary[$key]['year']['new'] = array(
117 'count' => CRM_Member_BAO_Membership
::getMembershipJoins($key, $yearStart, $ymd),
121 $membershipSummary[$key]['year']['renew'] = array(
122 'count' => CRM_Member_BAO_Membership
::getMembershipRenewals($key, $yearStart, $ymd),
126 $membershipSummary[$key]['year']['total'] = array(
127 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $yearStart, $ymd),
131 $membershipSummary[$key]['current']['total'] = array(
132 'count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $current),
136 $membershipSummary[$key]['total']['total'] = array('count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $ymd));
138 //LCD also get summary stats for membership owners
139 $membershipSummary[$key]['premonth_owner']['premonth_owner'] = array(
140 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $preMonth, $preMonthEnd, 0, 1),
144 $membershipSummary[$key]['month_owner']['month_owner'] = array(
145 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $monthStart, $ymd, 0, 1),
149 $membershipSummary[$key]['year_owner']['year_owner'] = array(
150 'count' => CRM_Member_BAO_Membership
::getMembershipStarts($key, $yearStart, $ymd, 0, 1),
154 $membershipSummary[$key]['current_owner']['current_owner'] = array(
155 'count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $current, 0, 1),
159 $membershipSummary[$key]['total_owner']['total_owner'] = array('count' => CRM_Member_BAO_Membership
::getMembershipCount($key, $ymd, 0, 1));
163 $status = CRM_Member_BAO_MembershipStatus
::getMembershipStatusCurrent();
164 $status = implode(',', $status);
166 foreach ($membershipSummary as $typeID => $details) {
167 if (!$isCurrentMonth) {
168 $membershipSummary[$typeID]['total']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search',
169 "reset=1&force=1&start=&end=$ymd&membership_status_id=$status&membership_type_id=$typeID"
171 $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");
174 $membershipSummary[$typeID]['total']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search',
175 "reset=1&force=1&membership_status_id=$status"
177 $membershipSummary[$typeID]['total_owner']['total_owner']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1");
179 $membershipSummary[$typeID]['current']['total']['url'] = CRM_Utils_System
::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&membership_type_id=$typeID");
180 $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");
185 $newCountPreMonth = $newCountMonth = $newCountYear = 0;
186 $renewCountPreMonth = $renewCountMonth = $renewCountYear = 0;
188 $totalCountPreMonth = $totalCountMonth = $totalCountYear = $totalCountCurrent = $totalCountTotal = 0;
189 $totalCountPreMonth_owner = $totalCountMonth_owner = $totalCountYear_owner = $totalCountCurrent_owner = $totalCountTotal_owner = 0;
190 foreach ($membershipSummary as $key => $value) {
191 $newCountPreMonth = $newCountPreMonth +
$value['premonth']['new']['count'];
192 $renewCountPreMonth = $renewCountPreMonth +
$value['premonth']['renew']['count'];
193 $totalCountPreMonth = $totalCountPreMonth +
$value['premonth']['total']['count'];
194 $newCountMonth = $newCountMonth +
$value['month']['new']['count'];
195 $renewCountMonth = $renewCountMonth +
$value['month']['renew']['count'];
196 $totalCountMonth = $totalCountMonth +
$value['month']['total']['count'];
197 $newCountYear = $newCountYear +
$value['year']['new']['count'];
198 $renewCountYear = $renewCountYear +
$value['year']['renew']['count'];
199 $totalCountYear = $totalCountYear +
$value['year']['total']['count'];
200 $totalCountCurrent = $totalCountCurrent +
$value['current']['total']['count'];
201 $totalCountTotal = $totalCountTotal +
$value['total']['total']['count'];
203 //LCD add owner values
204 $totalCountPreMonth_owner = $totalCountPreMonth_owner +
$value['premonth_owner']['premonth_owner']['count'];
205 $totalCountMonth_owner = $totalCountMonth_owner +
$value['month_owner']['month_owner']['count'];
206 $totalCountYear_owner = $totalCountYear_owner +
$value['year_owner']['year_owner']['count'];
207 $totalCountCurrent_owner = $totalCountCurrent_owner +
$value['current_owner']['current_owner']['count'];
208 $totalCountTotal_owner = $totalCountTotal_owner +
$value['total_owner']['total_owner']['count'];
211 $totalCount['premonth']['new'] = array(
212 'count' => $newCountPreMonth,
215 $totalCount['premonth']['renew'] = array(
216 'count' => $renewCountPreMonth,
219 $totalCount['premonth']['total'] = array(
220 'count' => $totalCountPreMonth,
223 $totalCount['month']['new'] = array(
224 'count' => $newCountMonth,
227 $totalCount['month']['renew'] = array(
228 'count' => $renewCountMonth,
231 $totalCount['month']['total'] = array(
232 'count' => $totalCountMonth,
235 $totalCount['year']['new'] = array(
236 'count' => $newCountYear,
239 $totalCount['year']['renew'] = array(
240 'count' => $renewCountYear,
243 $totalCount['year']['total'] = array(
244 'count' => $totalCountYear,
247 $totalCount['current']['total'] = array(
248 'count' => $totalCountCurrent,
249 'url' => CRM_Utils_System
::url('civicrm/member/search',
250 "reset=1&force=1&membership_status_id=$status"
254 $totalCount['total']['total'] = array(
255 'count' => $totalCountTotal,
256 'url' => CRM_Utils_System
::url('civicrm/member/search',
257 "reset=1&force=1&membership_status_id=$status"
261 if (!$isCurrentMonth) {
262 $totalCount['total']['total'] = array(
263 'count' => $totalCountTotal,
264 'url' => CRM_Utils_System
::url('civicrm/member/search',
265 "reset=1&force=1&membership_status_id=$status&start=&end=$ymd"
270 // Activity search also unable to handle owner vs. inherited
272 //LCD add owner values
273 $totalCount['premonth_owner']['premonth_owner'] = array(
274 'count' => $totalCountPreMonth_owner,
275 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$preMonth&end=$preMonthEnd&owner=1"),
278 $totalCount['month_owner']['month_owner'] = array(
279 'count' => $totalCountMonth_owner,
280 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$monthStart&end=$ymd&owner=1"),
283 $totalCount['year_owner']['year_owner'] = array(
284 'count' => $totalCountYear_owner,
285 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$yearStart&end=$ymd&owner=1"),
288 $totalCount['current_owner']['current_owner'] = array(
289 'count' => $totalCountCurrent_owner,
290 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
293 $totalCount['total_owner']['total_owner'] = array(
294 'count' => $totalCountTotal_owner,
295 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
298 if (!$isCurrentMonth) {
299 $totalCount['total_owner']['total_owner'] = array(
300 'count' => $totalCountTotal_owner,
301 // 'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=&end=$ymd&owner=1"),
306 $this->assign('membershipSummary', $membershipSummary);
307 $this->assign('totalCount', $totalCount);
308 $this->assign('month', CRM_Utils_Date
::customFormatTs($monthStartTs, '%B'));
309 $this->assign('year', date('Y', $monthStartTs));
310 $this->assign('premonth', CRM_Utils_Date
::customFormat($preMonth, '%B'));
311 $this->assign('currentMonth', date('F'));
312 $this->assign('currentYear', date('Y'));
313 $this->assign('isCurrent', $isCurrentMonth);
314 $this->assign('preMonth', $isPreviousMonth);
318 * the main function that is called when the page loads,
319 * it decides the which action has to be taken for the page.
323 public function run() {
326 $controller = new CRM_Core_Controller_Simple('CRM_Member_Form_Search', ts('Member'), NULL);
327 $controller->setEmbedded(TRUE);
328 $controller->reset();
329 $controller->set('limit', 20);
330 $controller->set('force', 1);
331 $controller->set('context', 'dashboard');
332 $controller->process();
335 return parent
::run();