CRM/Member/Page/MembershipStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Page for displaying list of membership types
  38  */
  39 class CRM_Member_Page_MembershipStatus extends CRM_Core_Page_Basic {
  40
  41   public $useLivePageJS = TRUE;
  42
  43   /**
  44    * The action links that we need to display for the browse screen.
  45    *
  46    * @var array
  47    */
  48   static $_links = NULL;
  49
  50   /**
  51    * Get BAO Name.
  52    *
  53    * @return string
  54    *   Classname of BAO.
  55    */
  56   public function getBAOName() {
  57     return 'CRM_Member_BAO_MembershipStatus';
  58   }
  59
  60   /**
  61    * Get action Links.
  62    *
  63    * @return array
  64    *   (reference) of action links
  65    */
  66   public function &links() {
  67     if (!(self::$_links)) {
  68       self::$_links = array(
  69         CRM_Core_Action::UPDATE => array(
  70           'name' => ts('Edit'),
  71           'url' => 'civicrm/admin/member/membershipStatus',
  72           'qs' => 'action=update&id=%%id%%&reset=1',
  73           'title' => ts('Edit Membership Status'),
  74         ),
  75         CRM_Core_Action::DISABLE => array(
  76           'name' => ts('Disable'),
  77           'ref' => 'crm-enable-disable',
  78           'title' => ts('Disable Membership Status'),
  79         ),
  80         CRM_Core_Action::ENABLE => array(
  81           'name' => ts('Enable'),
  82           'ref' => 'crm-enable-disable',
  83           'title' => ts('Enable Membership Status'),
  84         ),
  85         CRM_Core_Action::DELETE => array(
  86           'name' => ts('Delete'),
  87           'url' => 'civicrm/admin/member/membershipStatus',
  88           'qs' => 'action=delete&id=%%id%%',
  89           'title' => ts('Delete Membership Status'),
  90         ),
  91       );
  92     }
  93     return self::$_links;
  94   }
  95
  96   /**
  97    * Browse all custom data groups.
  98    *
  99    *
 100    * @return void
 101    */
 102   public function browse() {
 103     // get all custom groups sorted by weight
 104     $membershipStatus = array();
 105     $dao = new CRM_Member_DAO_MembershipStatus();
 106
 107     $dao->orderBy('weight');
 108     $dao->find();
 109
 110     while ($dao->fetch()) {
 111       $membershipStatus[$dao->id] = array();
 112       CRM_Core_DAO::storeValues($dao, $membershipStatus[$dao->id]);
 113
 114       // form all action links
 115       $action = array_sum(array_keys($this->links()));
 116       // update enable/disable links depending on if it is is_reserved or is_active
 117       if (!$dao->is_reserved) {
 118         if ($dao->is_active) {
 119           $action -= CRM_Core_Action::ENABLE;
 120         }
 121         else {
 122           $action -= CRM_Core_Action::DISABLE;
 123         }
 124         $membershipStatus[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 125           array('id' => $dao->id),
 126           ts('more'),
 127           FALSE,
 128           'membershipStatus.manage.action',
 129           'MembershipStatus',
 130           $dao->id
 131         );
 132       }
 133       if ($startEvent = CRM_Utils_Array::value('start_event', $membershipStatus[$dao->id])) {
 134         $membershipStatus[$dao->id]['start_event'] = ($startEvent == 'join_date') ? 'member since' : str_replace("_", " ", $startEvent);
 135       }
 136       if ($endEvent = CRM_Utils_Array::value('end_event', $membershipStatus[$dao->id])) {
 137         $membershipStatus[$dao->id]['end_event'] = ($endEvent == 'join_date') ? 'member since' : str_replace("_", " ", $endEvent);
 138       }
 139     }
 140     // Add order changing widget to selector
 141     $returnURL = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', "reset=1&action=browse");
 142     CRM_Utils_Weight::addOrder($membershipStatus, 'CRM_Member_DAO_MembershipStatus',
 143       'id', $returnURL
 144     );
 145
 146     $this->assign('rows', $membershipStatus);
 147   }
 148
 149   /**
 150    * Get name of edit form.
 151    *
 152    * @return string
 153    *   Classname of edit form.
 154    */
 155   public function editForm() {
 156     return 'CRM_Member_Form_MembershipStatus';
 157   }
 158
 159   /**
 160    * Get edit form name.
 161    *
 162    * @return string
 163    *   name of this page.
 164    */
 165   public function editName() {
 166     return 'Membership Status';
 167   }
 168
 169   /**
 170    * Get user context.
 171    *
 172    * @param null $mode
 173    *
 174    * @return string
 175    *   user context.
 176    */
 177   public function userContext($mode = NULL) {
 178     return 'civicrm/admin/member/membershipStatus';
 179   }
 180
 181 }