Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
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 Mail account settings | |
38 | */ | |
39 | class CRM_Admin_Page_MailSettings 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_Core_BAO_MailSettings'; | |
56 | } | |
57 | ||
58 | /** | |
59 | * Get action Links | |
60 | * | |
61 | * @return array (reference) of action links | |
62 | */ | |
63 | function &links() { | |
64 | if (!(self::$_links)) { | |
65 | // helper variable for nicer formatting | |
66 | self::$_links = array( | |
67 | CRM_Core_Action::UPDATE => array( | |
68 | 'name' => ts('Edit'), | |
69 | 'url' => 'civicrm/admin/mailSettings', | |
70 | 'qs' => 'action=update&id=%%id%%&reset=1', | |
71 | 'title' => ts('Edit Mail Settings'), | |
72 | ), | |
73 | CRM_Core_Action::DELETE => array( | |
74 | 'name' => ts('Delete'), | |
75 | 'url' => 'civicrm/admin/mailSettings', | |
76 | 'qs' => 'action=delete&id=%%id%%', | |
77 | 'title' => ts('Delete Mail Settings'), | |
78 | ), | |
79 | ); | |
80 | } | |
81 | ||
82 | return self::$_links; | |
83 | } | |
84 | ||
85 | /** | |
86 | * Browse all mail settings. | |
87 | * | |
88 | * @return void | |
89 | * @access public | |
90 | * @static | |
91 | */ | |
92 | function browse() { | |
93 | //get all mail settings. | |
94 | $allMailSettings = array(); | |
95 | $mailSetting = new CRM_Core_DAO_MailSettings(); | |
96 | ||
97 | $allProtocols = CRM_Core_PseudoConstant::mailProtocol(); | |
98 | ||
99 | //multi-domain support for mail settings. CRM-5244 | |
100 | $mailSetting->domain_id = CRM_Core_Config::domainID(); | |
101 | ||
102 | //find all mail settings. | |
103 | $mailSetting->find(); | |
104 | while ($mailSetting->fetch()) { | |
105 | //replace protocol value with name | |
106 | $mailSetting->protocol = CRM_Utils_Array::value($mailSetting->protocol, $allProtocols); | |
107 | CRM_Core_DAO::storeValues($mailSetting, $allMailSettings[$mailSetting->id]); | |
108 | ||
109 | //form all action links | |
110 | $action = array_sum(array_keys($this->links())); | |
111 | ||
112 | // disallow the DELETE action for the default set of settings | |
113 | if ($mailSetting->is_default) { | |
114 | $action &= ~CRM_Core_Action::DELETE; | |
115 | } | |
116 | ||
117 | //add action links. | |
118 | $allMailSettings[$mailSetting->id]['action'] = CRM_Core_Action::formLink(self::links(), $action, | |
119 | array('id' => $mailSetting->id) | |
120 | ); | |
121 | } | |
122 | ||
123 | $this->assign('rows', $allMailSettings); | |
124 | } | |
125 | ||
126 | /** | |
127 | * Get name of edit form | |
128 | * | |
129 | * @return string Classname of edit form. | |
130 | */ | |
131 | function editForm() { | |
132 | return 'CRM_Admin_Form_MailSettings'; | |
133 | } | |
134 | ||
135 | /** | |
136 | * Get edit form name | |
137 | * | |
138 | * @return string name of this page. | |
139 | */ | |
140 | function editName() { | |
141 | return 'Mail Settings'; | |
142 | } | |
143 | ||
144 | /** | |
145 | * Get user context. | |
146 | * | |
147 | * @return string user context. | |
148 | */ | |
149 | function userContext($mode = NULL) { | |
150 | return 'civicrm/admin/mailSettings'; | |
151 | } | |
152 | } | |
153 |