fieldsplugin.php
6.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<?php
/**
* @package Joomla.Administrator
* @subpackage com_fields
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
defined('_JEXEC') or die;
/**
* Abstract Fields Plugin
*
* @since 3.7.0
*/
abstract class FieldsPlugin extends JPlugin
{
protected $autoloadLanguage = true;
/**
* Returns the custom fields types.
*
* @return string[][]
*
* @since 3.7.0
*/
public function onCustomFieldsGetTypes()
{
// Cache filesystem access / checks
static $types_cache = array();
if (isset($types_cache[$this->_type . $this->_name]))
{
return $types_cache[$this->_type . $this->_name];
}
$types = array();
// The root of the plugin
$root = JPATH_PLUGINS . '/' . $this->_type . '/' . $this->_name;
foreach (JFolder::files($root . '/tmpl', '.php') as $layout)
{
// Strip the extension
$layout = str_replace('.php', '', $layout);
// The data array
$data = array();
// The language key
$key = strtoupper($layout);
if ($key != strtoupper($this->_name))
{
$key = strtoupper($this->_name) . '_' . $layout;
}
// Needed attributes
$data['type'] = $layout;
if (JFactory::getLanguage()->hasKey('PLG_FIELDS_' . $key . '_LABEL'))
{
$data['label'] = JText::sprintf('PLG_FIELDS_' . $key . '_LABEL', strtolower($key));
// Fix wrongly set parentheses in RTL languages
if (JFactory::getLanguage()->isRTL())
{
$data['label'] = $data['label'] . '‎';
}
}
else
{
$data['label'] = $key;
}
$path = $root . '/fields';
// Add the path when it exists
if (file_exists($path))
{
$data['path'] = $path;
}
$path = $root . '/rules';
// Add the path when it exists
if (file_exists($path))
{
$data['rules'] = $path;
}
$types[] = $data;
}
// Add to cache and return the data
$types_cache[$this->_type . $this->_name] = $types;
return $types;
}
/**
* Prepares the field value.
*
* @param string $context The context.
* @param stdclass $item The item.
* @param stdclass $field The field.
*
* @return string
*
* @since 3.7.0
*/
public function onCustomFieldsPrepareField($context, $item, $field)
{
// Check if the field should be processed by us
if (!$this->isTypeSupported($field->type))
{
return;
}
// Merge the params from the plugin and field which has precedence
$fieldParams = clone $this->params;
$fieldParams->merge($field->fieldparams);
// Get the path for the layout file
$path = JPluginHelper::getLayoutPath('fields', $field->type, $field->type);
// Render the layout
ob_start();
include $path;
$output = ob_get_clean();
// Return the output
return $output;
}
/**
* Transforms the field into a DOM XML element and appends it as a child on the given parent.
*
* @param stdClass $field The field.
* @param DOMElement $parent The field node parent.
* @param JForm $form The form.
*
* @return DOMElement
*
* @since 3.7.0
*/
public function onCustomFieldsPrepareDom($field, DOMElement $parent, JForm $form)
{
// Check if the field should be processed by us
if (!$this->isTypeSupported($field->type))
{
return null;
}
// Detect if the field is configured to be displayed on the form
if (!FieldsHelper::displayFieldOnForm($field))
{
return null;
}
// Create the node
$node = $parent->appendChild(new DOMElement('field'));
// Set the attributes
$node->setAttribute('name', $field->name);
$node->setAttribute('type', $field->type);
$node->setAttribute('label', $field->label);
$node->setAttribute('labelclass', $field->params->get('label_class'));
$node->setAttribute('description', $field->description);
$node->setAttribute('class', $field->params->get('class'));
$node->setAttribute('hint', $field->params->get('hint'));
$node->setAttribute('required', $field->required ? 'true' : 'false');
if ($field->default_value !== '')
{
$defaultNode = $node->appendChild(new DOMElement('default'));
$defaultNode->appendChild(new DOMCdataSection($field->default_value));
}
// Combine the two params
$params = clone $this->params;
$params->merge($field->fieldparams);
// Set the specific field parameters
foreach ($params->toArray() as $key => $param)
{
if (is_array($param))
{
// Multidimensional arrays (eg. list options) can't be transformed properly
$param = count($param) == count($param, COUNT_RECURSIVE) ? implode(',', $param) : '';
}
if ($param === '' || (!is_string($param) && !is_numeric($param)))
{
continue;
}
$node->setAttribute($key, $param);
}
// Check if it is allowed to edit the field
if (!FieldsHelper::canEditFieldValue($field))
{
$node->setAttribute('disabled', 'true');
}
// Return the node
return $node;
}
/**
* The form event. Load additional parameters when available into the field form.
* Only when the type of the form is of interest.
*
* @param JForm $form The form
* @param stdClass $data The data
*
* @return void
*
* @since 3.7.0
*/
public function onContentPrepareForm(JForm $form, $data)
{
// Check if the field form is calling us
if (strpos($form->getName(), 'com_fields.field') !== 0)
{
return;
}
// Ensure it is an object
$formData = (object) $data;
// Gather the type
$type = $form->getValue('type');
if (!empty($formData->type))
{
$type = $formData->type;
}
// Not us
if (!$this->isTypeSupported($type))
{
return;
}
$path = JPATH_PLUGINS . '/' . $this->_type . '/' . $this->_name . '/params/' . $type . '.xml';
// Check if params file exists
if (!file_exists($path))
{
return;
}
// Load the specific plugin parameters
$form->load(file_get_contents($path), true, '/form/*');
}
/**
* Returns true if the given type is supported by the plugin.
*
* @param string $type The type
*
* @return boolean
*
* @since 3.7.0
*/
protected function isTypeSupported($type)
{
foreach ($this->onCustomFieldsGetTypes() as $typeSpecification)
{
if ($type == $typeSpecification['type'])
{
return true;
}
}
return false;
}
}