Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
fa938177 | 31 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
b6c94f42 | 35 | * Base class for admin forms. |
6a488035 TO |
36 | */ |
37 | class CRM_Admin_Form extends CRM_Core_Form { | |
38 | ||
39 | /** | |
40 | * The id of the object being edited / created | |
41 | * | |
42 | * @var int | |
43 | */ | |
44 | protected $_id; | |
45 | ||
46 | /** | |
eceb18cc | 47 | * The default values for form fields. |
6a488035 TO |
48 | * |
49 | * @var int | |
50 | */ | |
51 | protected $_values; | |
52 | ||
53 | /** | |
eceb18cc | 54 | * The name of the BAO object for this form. |
6a488035 TO |
55 | * |
56 | * @var string | |
57 | */ | |
58 | protected $_BAOName; | |
59 | ||
a4969aee TM |
60 | /** |
61 | * Explicitly declare the form context. | |
62 | */ | |
63 | public function getDefaultContext() { | |
64 | return 'create'; | |
65 | } | |
66 | ||
355ba699 | 67 | /** |
eceb18cc | 68 | * Basic setup. |
355ba699 | 69 | */ |
00be9182 | 70 | public function preProcess() { |
4ef8abc2 CW |
71 | Civi::resources()->addStyleFile('civicrm', 'css/admin.css'); |
72 | ||
353ffa53 | 73 | $this->_id = $this->get('id'); |
6a488035 | 74 | $this->_BAOName = $this->get('BAOName'); |
353ffa53 | 75 | $this->_values = array(); |
6a488035 TO |
76 | if (isset($this->_id)) { |
77 | $params = array('id' => $this->_id); | |
78 | // this is needed if the form is outside the CRM name space | |
0e6e8724 | 79 | $baoName = $this->_BAOName; |
481a74f4 | 80 | $baoName::retrieve($params, $this->_values); |
6a488035 TO |
81 | } |
82 | } | |
83 | ||
84 | /** | |
c490a46a | 85 | * Set default values for the form. Note that in edit/view mode |
6a488035 TO |
86 | * the default values are retrieved from the database |
87 | * | |
6a488035 | 88 | * |
355ba699 | 89 | * @return array |
6a488035 | 90 | */ |
00be9182 | 91 | public function setDefaultValues() { |
6a488035 TO |
92 | if (isset($this->_id) && empty($this->_values)) { |
93 | $this->_values = array(); | |
94 | $params = array('id' => $this->_id); | |
0e6e8724 | 95 | $baoName = $this->_BAOName; |
481a74f4 | 96 | $baoName::retrieve($params, $this->_values); |
6a488035 TO |
97 | } |
98 | $defaults = $this->_values; | |
99 | ||
100 | if ($this->_action == CRM_Core_Action::DELETE && | |
101 | isset($defaults['name']) | |
102 | ) { | |
103 | $this->assign('delName', $defaults['name']); | |
104 | } | |
105 | ||
106 | // its ok if there is no element called is_active | |
107 | $defaults['is_active'] = ($this->_id) ? CRM_Utils_Array::value('is_active', $defaults) : 1; | |
a7488080 | 108 | if (!empty($defaults['parent_id'])) { |
6a488035 TO |
109 | $this->assign('is_parent', TRUE); |
110 | } | |
111 | return $defaults; | |
112 | } | |
113 | ||
114 | /** | |
eceb18cc | 115 | * Add standard buttons. |
6a488035 TO |
116 | */ |
117 | public function buildQuickForm() { | |
e2046b33 | 118 | if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) { |
52395565 CW |
119 | $this->addButtons(array( |
120 | array( | |
121 | 'type' => 'cancel', | |
122 | 'name' => ts('Done'), | |
123 | 'isDefault' => TRUE, | |
124 | ), | |
125 | ) | |
126 | ); | |
127 | } | |
6a488035 TO |
128 | else { |
129 | $this->addButtons(array( | |
130 | array( | |
131 | 'type' => 'next', | |
a1f552a9 | 132 | 'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'), |
6a488035 TO |
133 | 'isDefault' => TRUE, |
134 | ), | |
135 | array( | |
136 | 'type' => 'cancel', | |
137 | 'name' => ts('Cancel'), | |
138 | ), | |
139 | ) | |
140 | ); | |
141 | } | |
142 | } | |
96025800 | 143 | |
6a488035 | 144 | } |