CRM/Member/Page/DashBoard.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Page for displaying list of Payment-Instrument
  20  */
  21 class CRM_Member_Page_DashBoard extends CRM_Core_Page {
  22
  23   /**
  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.
  26    *
  27    * @return void
  28    */
  29   public function preProcess() {
  30
  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);
  37       return;
  38     }
  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")));
  44
  45     $preMonthYear = mktime(0, 0, 0, substr($preMonth, 4, 2), 1, substr($preMonth, 0, 4));
  46
  47     $today = getdate();
  48     $date = CRM_Utils_Date::getToday();
  49     $isCurrentMonth = 0;
  50
  51     // You can force the dashboard to display based upon a certain date
  52     $ym = $_GET['date'] ?? NULL;
  53
  54     if ($ym) {
  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
  58       ) {
  59         CRM_Core_Error::statusBounce(ts('Invalid date query "%1" in URL (valid syntax is yyyymm).', array(1 => $ym)));
  60       }
  61
  62       $isPreviousMonth = 0;
  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);
  68     }
  69     else {
  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');
  74       $isCurrentMonth = 1;
  75       $isPreviousMonth = 1;
  76     }
  77     $monthStart = $ym . '-01';
  78     $yearStart = substr($ym, 0, 4) . '-01-01';
  79
  80     $membershipTypes = CRM_Member_BAO_MembershipType::getMembershipTypes(FALSE);
  81     // added
  82     //$membership = new CRM_Member_BAO_Membership;
  83
  84     foreach ($membershipTypes as $key => $value) {
  85
  86       $membershipSummary[$key]['premonth']['new'] = array(
  87         'count' => CRM_Member_BAO_Membership::getMembershipJoins($key, $preMonth, $preMonthEnd),
  88         'name' => $value,
  89         'url' => FALSE,
  90       );
  91
  92       $membershipSummary[$key]['premonth']['renew'] = array(
  93         'count' => CRM_Member_BAO_Membership::getMembershipRenewals($key, $preMonth, $preMonthEnd),
  94         'name' => $value,
  95         'url' => FALSE,
  96       );
  97
  98       $membershipSummary[$key]['premonth']['total'] = array(
  99         'count' => CRM_Member_BAO_Membership::getMembershipStarts($key, $preMonth, $preMonthEnd),
 100         'name' => $value,
 101         'url' => FALSE,
 102       );
 103
 104       $membershipSummary[$key]['month']['new'] = array(
 105         'count' => CRM_Member_BAO_Membership::getMembershipJoins($key, $monthStart, $ymd),
 106         'name' => $value,
 107         'url' => FALSE,
 108       );
 109
 110       $membershipSummary[$key]['month']['renew'] = array(
 111         'count' => CRM_Member_BAO_Membership::getMembershipRenewals($key, $monthStart, $ymd),
 112         'name' => $value,
 113         'url' => FALSE,
 114       );
 115
 116       $membershipSummary[$key]['month']['total'] = array(
 117         'count' => CRM_Member_BAO_Membership::getMembershipStarts($key, $monthStart, $ymd),
 118         'name' => $value,
 119         'url' => FALSE,
 120       );
 121
 122       $membershipSummary[$key]['year']['new'] = array(
 123         'count' => CRM_Member_BAO_Membership::getMembershipJoins($key, $yearStart, $ymd),
 124         'name' => $value,
 125         'url' => FALSE,
 126       );
 127
 128       $membershipSummary[$key]['year']['renew'] = array(
 129         'count' => CRM_Member_BAO_Membership::getMembershipRenewals($key, $yearStart, $ymd),
 130         'name' => $value,
 131         'url' => FALSE,
 132       );
 133
 134       $membershipSummary[$key]['year']['total'] = array(
 135         'count' => CRM_Member_BAO_Membership::getMembershipStarts($key, $yearStart, $ymd),
 136         'name' => $value,
 137         'url' => FALSE,
 138       );
 139
 140       $membershipSummary[$key]['current']['total'] = array(
 141         'count' => CRM_Member_BAO_Membership::getMembershipCount($key, $current),
 142         'name' => $value,
 143         'url' => FALSE,
 144       );
 145
 146       $membershipSummary[$key]['total']['total'] = array('count' => CRM_Member_BAO_Membership::getMembershipCount($key, $ymd));
 147
 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),
 151         'name' => $value,
 152         'url' => FALSE,
 153       );
 154
 155       $membershipSummary[$key]['month_owner']['month_owner'] = array(
 156         'count' => CRM_Member_BAO_Membership::getMembershipStarts($key, $monthStart, $ymd, 0, 1),
 157         'name' => $value,
 158         'url' => FALSE,
 159       );
 160
 161       $membershipSummary[$key]['year_owner']['year_owner'] = array(
 162         'count' => CRM_Member_BAO_Membership::getMembershipStarts($key, $yearStart, $ymd, 0, 1),
 163         'name' => $value,
 164         'url' => FALSE,
 165       );
 166
 167       $membershipSummary[$key]['current_owner']['current_owner'] = array(
 168         'count' => CRM_Member_BAO_Membership::getMembershipCount($key, $current, 0, 1),
 169         'name' => $value,
 170         'url' => FALSE,
 171       );
 172
 173       $membershipSummary[$key]['total_owner']['total_owner'] = array('count' => CRM_Member_BAO_Membership::getMembershipCount($key, $ymd, 0, 1));
 174       //LCD end
 175     }
 176
 177     $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusCurrent();
 178     $status = implode(',', $status);
 179
 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"
 184         );
 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");
 186       }
 187       else {
 188         $membershipSummary[$typeID]['total']['total']['url'] = CRM_Utils_System::url('civicrm/member/search',
 189           "reset=1&force=1&membership_status_id=$status"
 190         );
 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");
 192       }
 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");
 195     }
 196
 197     $totalCount = [];
 198
 199     $newCountPreMonth = $newCountMonth = $newCountYear = 0;
 200     $renewCountPreMonth = $renewCountMonth = $renewCountYear = 0;
 201
 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'];
 216
 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'];
 223     }
 224
 225     $totalCount['premonth']['new'] = array(
 226       'count' => $newCountPreMonth,
 227       'url' => FALSE,
 228     );
 229
 230     $totalCount['premonth']['renew'] = array(
 231       'count' => $renewCountPreMonth,
 232       'url' => FALSE,
 233     );
 234
 235     $totalCount['premonth']['total'] = array(
 236       'count' => $totalCountPreMonth,
 237       'url' => FALSE,
 238     );
 239
 240     $totalCount['month']['new'] = array(
 241       'count' => $newCountMonth,
 242       'url' => FALSE,
 243     );
 244
 245     $totalCount['month']['renew'] = array(
 246       'count' => $renewCountMonth,
 247       'url' => FALSE,
 248     );
 249
 250     $totalCount['month']['total'] = array(
 251       'count' => $totalCountMonth,
 252       'url' => FALSE,
 253     );
 254
 255     $totalCount['year']['new'] = array(
 256       'count' => $newCountYear,
 257       'url' => FALSE,
 258     );
 259
 260     $totalCount['year']['renew'] = array(
 261       'count' => $renewCountYear,
 262       'url' => FALSE,
 263     );
 264
 265     $totalCount['year']['total'] = array(
 266       'count' => $totalCountYear,
 267       'url' => FALSE,
 268     );
 269
 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"
 274       ),
 275     );
 276
 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"
 281       ),
 282     );
 283
 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"
 289         ),
 290       );
 291     }
 292
 293     // Activity search also unable to handle owner vs. inherited
 294
 295     //LCD add owner values
 296     $totalCount['premonth_owner']['premonth_owner'] = array(
 297       'count' => $totalCountPreMonth_owner,
 298       'url' => FALSE,
 299       //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$preMonth&end=$preMonthEnd&owner=1"),
 300     );
 301
 302     $totalCount['month_owner']['month_owner'] = array(
 303       'count' => $totalCountMonth_owner,
 304       'url' => FALSE,
 305       //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$monthStart&end=$ymd&owner=1"),
 306     );
 307
 308     $totalCount['year_owner']['year_owner'] = array(
 309       'count' => $totalCountYear_owner,
 310       'url' => FALSE,
 311       //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=$yearStart&end=$ymd&owner=1"),
 312     );
 313
 314     $totalCount['current_owner']['current_owner'] = array(
 315       'count' => $totalCountCurrent_owner,
 316       'url' => FALSE,
 317       //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
 318     );
 319
 320     $totalCount['total_owner']['total_owner'] = array(
 321       'count' => $totalCountTotal_owner,
 322       'url' => FALSE,
 323       //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&owner=1"),
 324     );
 325
 326     if (!$isCurrentMonth) {
 327       $totalCount['total_owner']['total_owner'] = array(
 328         'count' => $totalCountTotal_owner,
 329         'url' => FALSE,
 330         //  'url' => CRM_Utils_System::url('civicrm/member/search', "reset=1&force=1&membership_status_id=$status&start=&end=$ymd&owner=1"),
 331       );
 332     }
 333     //LCD end
 334
 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);
 344   }
 345
 346   /**
 347    * the main function that is called when the page loads,
 348    * it decides the which action has to be taken for the page.
 349    *
 350    * @return null
 351    */
 352   public function run() {
 353     $this->preProcess();
 354
 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();
 362     $controller->run();
 363
 364     return parent::run();
 365   }
 366
 367 }