crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Admin/Page/MailSettings.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 Mail account settings
  38  */
  39 class CRM_Admin_Page_MailSettings 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_Core_BAO_MailSettings';
  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       // helper variable for nicer formatting
  69       self::$_links = array(
  70         CRM_Core_Action::UPDATE => array(
  71           'name' => ts('Edit'),
  72           'url' => 'civicrm/admin/mailSettings',
  73           'qs' => 'action=update&id=%%id%%&reset=1',
  74           'title' => ts('Edit Mail Settings'),
  75         ),
  76         CRM_Core_Action::DELETE => array(
  77           'name' => ts('Delete'),
  78           'url' => 'civicrm/admin/mailSettings',
  79           'qs' => 'action=delete&id=%%id%%',
  80           'title' => ts('Delete Mail Settings'),
  81         ),
  82       );
  83     }
  84
  85     return self::$_links;
  86   }
  87
  88   /**
  89    * Browse all mail settings.
  90    *
  91    * @return void
  92    */
  93   public function browse() {
  94     //get all mail settings.
  95     $allMailSettings = array();
  96     $mailSetting = new CRM_Core_DAO_MailSettings();
  97
  98     $allProtocols = CRM_Core_PseudoConstant::get('CRM_Core_DAO_MailSettings', 'protocol');
  99
 100     //multi-domain support for mail settings. CRM-5244
 101     $mailSetting->domain_id = CRM_Core_Config::domainID();
 102
 103     //find all mail settings.
 104     $mailSetting->find();
 105     while ($mailSetting->fetch()) {
 106       //replace protocol value with name
 107       $mailSetting->protocol = CRM_Utils_Array::value($mailSetting->protocol, $allProtocols);
 108       CRM_Core_DAO::storeValues($mailSetting, $allMailSettings[$mailSetting->id]);
 109
 110       //form all action links
 111       $action = array_sum(array_keys($this->links()));
 112
 113       // disallow the DELETE action for the default set of settings
 114       if ($mailSetting->is_default) {
 115         $action &= ~CRM_Core_Action::DELETE;
 116       }
 117
 118       //add action links.
 119       $allMailSettings[$mailSetting->id]['action'] = CRM_Core_Action::formLink(self::links(), $action,
 120         array('id' => $mailSetting->id),
 121         ts('more'),
 122         FALSE,
 123         'mailSetting.manage.action',
 124         'MailSetting',
 125         $mailSetting->id
 126       );
 127     }
 128
 129     $this->assign('rows', $allMailSettings);
 130   }
 131
 132   /**
 133    * Get name of edit form.
 134    *
 135    * @return string
 136    *   Classname of edit form.
 137    */
 138   public function editForm() {
 139     return 'CRM_Admin_Form_MailSettings';
 140   }
 141
 142   /**
 143    * Get edit form name.
 144    *
 145    * @return string
 146    *   name of this page.
 147    */
 148   public function editName() {
 149     return 'Mail Settings';
 150   }
 151
 152   /**
 153    * Get user context.
 154    *
 155    * @param null $mode
 156    *
 157    * @return string
 158    *   user context.
 159    */
 160   public function userContext($mode = NULL) {
 161     return 'civicrm/admin/mailSettings';
 162   }
 163
 164 }