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