CRM/SMS/Page/Provider.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  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    * @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_SMS_BAO_Provider';
  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/sms/provider',
  71           'qs' => 'action=update&id=%%id%%&reset=1',
  72           'title' => ts('Edit Provider'),
  73         ),
  74         CRM_Core_Action::DELETE => array(
  75           'name' => ts('Delete'),
  76           'url' => 'civicrm/admin/sms/provider',
  77           'qs' => 'action=delete&id=%%id%%',
  78           'title' => ts('Delete Provider'),
  79         ),
  80         CRM_Core_Action::ENABLE => array(
  81           'name' => ts('Enable'),
  82           'ref' => 'crm-enable-disable',
  83           'title' => ts('Enable Provider'),
  84         ),
  85         CRM_Core_Action::DISABLE => array(
  86           'name' => ts('Disable'),
  87           'ref' => 'crm-enable-disable',
  88           'title' => ts('Disable Provider'),
  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     // set title and breadcrumb
 108     CRM_Utils_System::setTitle(ts('Settings - SMS Provider'));
 109     $breadCrumb = array(array('title' => ts('SMS Provider'),
 110         'url' => CRM_Utils_System::url('civicrm/admin/sms/provider',
 111           'reset=1'
 112         ),
 113       ));
 114     CRM_Utils_System::appendBreadCrumb($breadCrumb);
 115
 116     $this->_id = CRM_Utils_Request::retrieve('id', 'String',
 117       $this, FALSE, 0
 118     );
 119     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
 120       $this, FALSE, 0
 121     );
 122
 123     return parent::run();
 124   }
 125
 126   /**
 127    * Browse all Providers.
 128    *
 129    * @param null $action
 130    *
 131    * @return void
 132    * @access public
 133    * @static
 134    */
 135   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 Classname of edit form.
 168    */
 169   function editForm() {
 170     return 'CRM_SMS_Form_Provider';
 171   }
 172
 173   /**
 174    * Get edit form name
 175    *
 176    * @return string name of this page.
 177    */
 178   function editName() {
 179     return 'SMS Provider';
 180   }
 181
 182   /**
 183    * Get user context.
 184    *
 185    * @param null $mode
 186    *
 187    * @return string user context.
 188    */
 189   function userContext($mode = NULL) {
 190     return 'civicrm/admin/sms/provider';
 191   }
 192 }
 193