crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/CRM/SMS/Page/Provider.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 Providers
  38  */
  39 class CRM_SMS_Page_Provider 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_SMS_BAO_Provider';
  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/sms/provider',
  72           'qs' => 'action=update&id=%%id%%&reset=1',
  73           'title' => ts('Edit Provider'),
  74         ),
  75         CRM_Core_Action::DELETE => array(
  76           'name' => ts('Delete'),
  77           'url' => 'civicrm/admin/sms/provider',
  78           'qs' => 'action=delete&id=%%id%%',
  79           'title' => ts('Delete Provider'),
  80         ),
  81         CRM_Core_Action::ENABLE => array(
  82           'name' => ts('Enable'),
  83           'ref' => 'crm-enable-disable',
  84           'title' => ts('Enable Provider'),
  85         ),
  86         CRM_Core_Action::DISABLE => array(
  87           'name' => ts('Disable'),
  88           'ref' => 'crm-enable-disable',
  89           'title' => ts('Disable Provider'),
  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     // set title and breadcrumb
 107     CRM_Utils_System::setTitle(ts('Settings - SMS Provider'));
 108     $breadCrumb = array(
 109       array(
 110         'title' => ts('SMS Provider'),
 111         'url' => CRM_Utils_System::url('civicrm/admin/sms/provider',
 112           'reset=1'
 113         ),
 114       ),
 115     );
 116     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 117
 118     $this->_id = CRM_Utils_Request::retrieve('id', 'String',
 119       $this, FALSE, 0
 120     );
 121     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
 122       $this, FALSE, 0
 123     );
 124
 125     return parent::run();
 126   }
 127
 128   /**
 129    * Browse all Providers.
 130    *
 131    * @param array $action
 132    *
 133    * @return void
 134    */
 135   public function browse($action = NULL) {
 136     $providers = CRM_SMS_BAO_Provider::getProviders();
 137     $rows = array();
 138     foreach ($providers as $provider) {
 139       $action = array_sum(array_keys($this->links()));
 140       // update enable/disable links.
 141       if ($provider['is_active']) {
 142         $action -= CRM_Core_Action::ENABLE;
 143       }
 144       else {
 145         $action -= CRM_Core_Action::DISABLE;
 146       }
 147
 148       $apiTypes = CRM_Core_OptionGroup::values('sms_api_type', FALSE, FALSE, FALSE, NULL, 'label');
 149       $provider['api_type'] = $apiTypes[$provider['api_type']];
 150
 151       $provider['action'] = CRM_Core_Action::formLink(self::links(), $action,
 152         array('id' => $provider['id']),
 153         ts('more'),
 154         FALSE,
 155         'sms.provider.row',
 156         'SMSProvider',
 157         $provider['id']
 158       );
 159       $rows[] = $provider;
 160     }
 161     $this->assign('rows', $rows);
 162   }
 163
 164   /**
 165    * Get name of edit form.
 166    *
 167    * @return string
 168    *   Classname of edit form.
 169    */
 170   public function editForm() {
 171     return 'CRM_SMS_Form_Provider';
 172   }
 173
 174   /**
 175    * Get edit form name.
 176    *
 177    * @return string
 178    *   name of this page.
 179    */
 180   public function editName() {
 181     return 'SMS Provider';
 182   }
 183
 184   /**
 185    * Get user context.
 186    *
 187    * @param null $mode
 188    *
 189    * @return string
 190    *   user context.
 191    */
 192   public function userContext($mode = NULL) {
 193     return 'civicrm/admin/sms/provider';
 194   }
 195
 196 }