Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
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 | require_once 'HTML/QuickForm/Renderer/ArraySmarty.php'; | |
37 | ||
38 | /** | |
39 | * customize the output to meet our specific requirements | |
40 | */ | |
41 | class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { | |
42 | ||
43 | /** | |
44 | * We only need one instance of this object. So we use the singleton | |
45 | * pattern and cache the instance in this variable | |
46 | * | |
47 | * @var object | |
48 | * @static | |
49 | */ | |
50 | static private $_singleton = NULL; | |
51 | ||
52 | /** | |
53 | * the converter from array size to css class | |
54 | * | |
55 | * @var array | |
56 | * @static | |
57 | */ | |
58 | static $_sizeMapper = array( | |
59 | 2 => 'two', | |
60 | 4 => 'four', | |
61 | 6 => 'six', | |
62 | 8 => 'eight', | |
63 | 12 => 'twelve', | |
64 | 20 => 'medium', | |
65 | 30 => 'big', | |
66 | 45 => 'huge', | |
67 | ); | |
68 | ||
69 | /** | |
70 | * Constructor | |
71 | * | |
72 | * @access public | |
73 | */ function __construct() { | |
74 | $template = CRM_Core_Smarty::singleton(); | |
75 | parent::__construct($template); | |
76 | } | |
77 | ||
78 | /** | |
79 | * Static instance provider. | |
80 | * | |
81 | * Method providing static instance of as in Singleton pattern. | |
82 | */ | |
83 | static function &singleton() { | |
84 | if (!isset(self::$_singleton)) { | |
85 | self::$_singleton = new CRM_Core_Form_Renderer(); | |
86 | } | |
87 | return self::$_singleton; | |
88 | } | |
89 | ||
90 | /** | |
91 | * Creates an array representing an element containing | |
92 | * the key for storing this. We allow the parent to do most of the | |
93 | * work, but then we add some CiviCRM specific enhancements to | |
94 | * make the html compliant with our css etc | |
95 | * | |
96 | * @access private | |
97 | * | |
98 | * @param object An HTML_QuickForm_element object | |
99 | * @param bool Whether an element is required | |
100 | * @param string Error associated with the element | |
101 | * | |
102 | * @return array | |
103 | */ | |
104 | function _elementToArray(&$element, $required, $error) { | |
105 | self::updateAttributes($element, $required, $error); | |
106 | ||
107 | $el = parent::_elementToArray($element, $required, $error); | |
108 | ||
109 | // add label html | |
110 | if (!empty($el['label'])) { | |
111 | $id = $element->getAttribute('id'); | |
112 | if (!empty($id)) { | |
113 | $el['label'] = '<label for="' . $id . '">' . $el['label'] . '</label>'; | |
114 | } | |
115 | else { | |
116 | $el['label'] = "<label>{$el['label']}</label>"; | |
117 | } | |
118 | } | |
119 | ||
120 | return $el; | |
121 | } | |
122 | ||
123 | /** | |
124 | * Update the attributes of this element and add a few CiviCRM | |
125 | * based attributes so we can style this form element better | |
126 | * | |
127 | * @access private | |
128 | * | |
129 | * @param object An HTML_QuickForm_element object | |
130 | * @param bool Whether an element is required | |
131 | * @param string Error associated with the element | |
132 | * | |
133 | * @return array | |
134 | * @static | |
135 | */ | |
136 | static function updateAttributes(&$element, $required, $error) { | |
137 | // lets create an id for all input elements, so we can generate nice label tags | |
138 | // to make it nice and clean, we'll just use the elementName if it is non null | |
139 | $attributes = array(); | |
140 | if (!$element->getAttribute('id')) { | |
141 | $name = $element->getAttribute('name'); | |
142 | if ($name) { | |
143 | $attributes['id'] = str_replace(array(']', '['), | |
144 | array('', '_'), | |
145 | $name | |
146 | ); | |
147 | } | |
148 | } | |
149 | ||
150 | $class = $element->getAttribute('class'); | |
151 | $type = $element->getType(); | |
152 | if (empty($class)) { | |
153 | $class = 'form-' . $type; | |
154 | ||
155 | if ($type == 'text') { | |
156 | $size = $element->getAttribute('size'); | |
157 | if (!empty($size)) { | |
158 | if (array_key_exists($size, self::$_sizeMapper)) { | |
159 | $class = $class . ' ' . self::$_sizeMapper[$size]; | |
160 | } | |
161 | } | |
162 | } | |
163 | } | |
164 | ||
165 | if ($required) { | |
166 | $class .= ' required'; | |
167 | } | |
168 | ||
169 | if ($error) { | |
170 | $class .= ' error'; | |
171 | } | |
172 | ||
173 | $attributes['class'] = $class; | |
174 | $element->updateAttributes($attributes); | |
175 | } | |
176 | } | |
177 | // end CRM_Core_Form_Renderer | |
178 |