crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Member/Page/MembershipStatus.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  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    * Run the page.
  98    *
  99    * This method is called after the page is created. It checks for the
 100    * type of action and executes that action.
 101    * Finally it calls the parent's run method.
 102    *
 103    * @return void
 104    */
 105   public function run() {
 106     // get the requested action
 107     $action = CRM_Utils_Request::retrieve('action', 'String',
 108       // default to 'browse'
 109       $this, FALSE, 'browse'
 110     );
 111
 112     // assign vars to templates
 113     $this->assign('action', $action);
 114     $id = CRM_Utils_Request::retrieve('id', 'Positive',
 115       $this, FALSE, 0
 116     );
 117
 118     // what action to take ?
 119     if ($action & (CRM_Core_Action::UPDATE | CRM_Core_Action::ADD)) {
 120       $this->edit($action, $id);
 121     }
 122     // finally browse the custom groups
 123     $this->browse();
 124
 125     // parent run
 126     return parent::run();
 127   }
 128
 129   /**
 130    * Browse all custom data groups.
 131    *
 132    *
 133    * @return void
 134    */
 135   public function browse() {
 136     // get all custom groups sorted by weight
 137     $membershipStatus = array();
 138     $dao = new CRM_Member_DAO_MembershipStatus();
 139
 140     $dao->orderBy('weight');
 141     $dao->find();
 142
 143     while ($dao->fetch()) {
 144       $membershipStatus[$dao->id] = array();
 145       CRM_Core_DAO::storeValues($dao, $membershipStatus[$dao->id]);
 146
 147       // form all action links
 148       $action = array_sum(array_keys($this->links()));
 149       // update enable/disable links depending on if it is is_reserved or is_active
 150       if (!$dao->is_reserved) {
 151         if ($dao->is_active) {
 152           $action -= CRM_Core_Action::ENABLE;
 153         }
 154         else {
 155           $action -= CRM_Core_Action::DISABLE;
 156         }
 157         $membershipStatus[$dao->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 158           array('id' => $dao->id),
 159           ts('more'),
 160           FALSE,
 161           'membershipStatus.manage.action',
 162           'MembershipStatus',
 163           $dao->id
 164         );
 165       }
 166       if ($startEvent = CRM_Utils_Array::value('start_event', $membershipStatus[$dao->id])) {
 167         $membershipStatus[$dao->id]['start_event'] = ($startEvent == 'join_date') ? 'member since' : str_replace("_", " ", $startEvent);
 168       }
 169       if ($endEvent = CRM_Utils_Array::value('end_event', $membershipStatus[$dao->id])) {
 170         $membershipStatus[$dao->id]['end_event'] = ($endEvent == 'join_date') ? 'member since' : str_replace("_", " ", $endEvent);
 171       }
 172     }
 173     // Add order changing widget to selector
 174     $returnURL = CRM_Utils_System::url('civicrm/admin/member/membershipStatus', "reset=1&action=browse");
 175     CRM_Utils_Weight::addOrder($membershipStatus, 'CRM_Member_DAO_MembershipStatus',
 176       'id', $returnURL
 177     );
 178
 179     $this->assign('rows', $membershipStatus);
 180   }
 181
 182   /**
 183    * Get name of edit form.
 184    *
 185    * @return string
 186    *   Classname of edit form.
 187    */
 188   public function editForm() {
 189     return 'CRM_Member_Form_MembershipStatus';
 190   }
 191
 192   /**
 193    * Get edit form name.
 194    *
 195    * @return string
 196    *   name of this page.
 197    */
 198   public function editName() {
 199     return 'Membership Status';
 200   }
 201
 202   /**
 203    * Get user context.
 204    *
 205    * @param null $mode
 206    *
 207    * @return string
 208    *   user context.
 209    */
 210   public function userContext($mode = NULL) {
 211     return 'civicrm/admin/member/membershipStatus';
 212   }
 213
 214 }