CRM/Member/Page/MembershipStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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    * @static
  48    */
  49   static $_links = NULL;
  50
  51   /**
  52    * Get BAO Name
  53    *
  54    * @return string Classname of BAO.
  55    */
  56   function getBAOName() {
  57     return 'CRM_Member_BAO_MembershipStatus';
  58   }
  59
  60   /**
  61    * Get action Links
  62    *
  63    * @return array (reference) of action links
  64    */
  65   function &links() {
  66     if (!(self::$_links)) {
  67       self::$_links = array(
  68         CRM_Core_Action::UPDATE => array(
  69           'name' => ts('Edit'),
  70           'url' => 'civicrm/admin/member/membershipStatus',
  71           'qs' => 'action=update&id=%%id%%&reset=1',
  72           'title' => ts('Edit Membership Status'),
  73         ),
  74         CRM_Core_Action::DISABLE => array(
  75           'name' => ts('Disable'),
  76           'ref' => 'crm-enable-disable',
  77           'title' => ts('Disable Membership Status'),
  78         ),
  79         CRM_Core_Action::ENABLE => array(
  80           'name' => ts('Enable'),
  81           'ref' => 'crm-enable-disable',
  82           'title' => ts('Enable Membership Status'),
  83         ),
  84         CRM_Core_Action::DELETE => array(
  85           'name' => ts('Delete'),
  86           'url' => 'civicrm/admin/member/membershipStatus',
  87           'qs' => 'action=delete&id=%%id%%',
  88           'title' => ts('Delete Membership Status'),
  89         ),
  90       );
  91     }
  92     return self::$_links;
  93   }
  94
  95   /**
  96    * Run the page.
  97    *
  98    * This method is called after the page is created. It checks for the
  99    * type of action and executes that action.
 100    * Finally it calls the parent's run method.
 101    *
 102    * @return void
 103    * @access public
 104    *
 105    */
 106   function run() {
 107     // get the requested action
 108     $action = CRM_Utils_Request::retrieve('action', 'String',
 109       // default to 'browse'
 110       $this, FALSE, 'browse'
 111     );
 112
 113     // assign vars to templates
 114     $this->assign('action', $action);
 115     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 116       $this, FALSE, 0
 117     );
 118
 119     // what action to take ?
 120     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 121       $this->edit($action, $id);
 122     }
 123     // finally browse the custom groups
 124     $this->browse();
 125
 126     // parent run
 127     return parent::run();
 128   }
 129
 130   /**
 131    * Browse all custom data groups.
 132    *
 133    *
 134    * @return void
 135    * @access public
 136    * @static
 137    */
 138   function browse() {
 139     // get all custom groups sorted by weight
 140     $membershipStatus = array();
 141     $dao = new CRM_Member_DAO_MembershipStatus();
 142
 143     $dao->orderBy('weight');
 144     $dao->find();
 145
 146     while ($dao->fetch()) {
 147       $membershipStatus[$dao->id] = array();
 148       CRM_Core_DAO::storeValues($dao, $membershipStatus[$dao->id]);
 149
 150       // form all action links
 151       $action = array_sum(array_keys($this->links()));
 152       // update enable/disable links depending on if it is is_reserved or is_active
 153       if (!$dao->is_reserved) {
 154         if ($dao->is_active) {
 155           $action -= CRM_Core_Action::ENABLE;
 156         }
 157         else {
 158           $action -= CRM_Core_Action::DISABLE;
 159         }
 160         $membershipStatus[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 161           array('id' => $dao->id),
 162           ts('more'),
 163           FALSE,
 164           'membershipStatus.manage.action',
 165           'MembershipStatus',
 166           $dao->id
 167         );
 168       }
 169       if ($startEvent = CRM_Utils_Array::value('start_event', $membershipStatus[$dao->id])) {
 170         $membershipStatus[$dao->id]['start_event'] = ($startEvent == 'join_date') ? 'member since' : str_replace("_", " ", $startEvent);
 171       }
 172       if ($endEvent = CRM_Utils_Array::value('end_event', $membershipStatus[$dao->id])) {
 173         $membershipStatus[$dao->id]['end_event'] = ($endEvent == 'join_date') ? 'member since' : str_replace("_", " ", $endEvent);
 174       }
 175     }
 176     // Add order changing widget to selector
 177     $returnURL = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', "reset=1&action=browse");
 178     CRM_Utils_Weight::addOrder($membershipStatus, 'CRM_Member_DAO_MembershipStatus',
 179       'id', $returnURL
 180     );
 181
 182     $this->assign('rows', $membershipStatus);
 183   }
 184
 185   /**
 186    * Get name of edit form
 187    *
 188    * @return string Classname of edit form.
 189    */
 190   function editForm() {
 191     return 'CRM_Member_Form_MembershipStatus';
 192   }
 193
 194   /**
 195    * Get edit form name
 196    *
 197    * @return string name of this page.
 198    */
 199   function editName() {
 200     return 'Membership Status';
 201   }
 202
 203   /**
 204    * Get user context.
 205    *
 206    * @return string user context.
 207    */
 208   function userContext($mode = NULL) {
 209     return 'civicrm/admin/member/membershipStatus';
 210   }
 211 }
 212