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