[4.0] Allow jForm to support data attribute

layouts/joomla/form/field/calendar.php

@@ -48,6 +48,7 @@
  * @var   array    $checkedOptions  Options that will be set as checked.
  * @var   boolean  $hasValue        Has this field a value assigned?
  * @var   array    $options         Options available for this field.
+ * @var   array    $dataAttributes  Miscellaneous data attributes for eg, data-*.
  *
  * Calendar Specific
  * @var   string   $localesPath     The relative path for the locale file
@@ -64,6 +65,7 @@
  */
 
 $inputvalue = '';
+$dataAttribute = '';
 
 // Build the attributes array.
 $attributes = array();
@@ -80,6 +82,14 @@
 	$attributes['required'] = '';
 }
 
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
+
 // Handle the special case for "now".
 if (strtoupper($value) === 'NOW')
 {
@@ -113,6 +123,7 @@
 			value="<?php echo htmlspecialchars(($value !== '0000-00-00 00:00:00') ? $value : '', ENT_COMPAT, 'UTF-8'); ?>"
 			<?php echo !empty($description) ? ' aria-describedby="' . $name . '-desc"' : ''; ?>
 			<?php echo $attributes; ?>
+			<?php echo $dataAttribute; ?>
 			<?php echo !empty($hint) ? 'placeholder="' . htmlspecialchars($hint, ENT_COMPAT, 'UTF-8') . '"' : ''; ?>
 			data-alt-value="<?php echo htmlspecialchars($value, ENT_COMPAT, 'UTF-8'); ?>" autocomplete="off">
 		<span class="input-group-append">

layouts/joomla/form/field/checkbox.php

@@ -42,6 +42,7 @@
  * @var   string         $validate        Validation rules to apply.
  * @var   string         $value           Value attribute of the field.
  * @var   boolean        $checked         Whether the checkbox should be checked.
+ * @var   array          $dataAttributes  Miscellaneous data attribute for eg, data-*.
  */
 
 // Initialize some field attributes.
@@ -55,6 +56,15 @@
 $onclick  = $onclick ? ' onclick="' . $onclick . '"' : '';
 $onchange = $onchange ? ' onchange="' . $onchange . '"' : '';
 
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 ?>
 <div class="form-check form-check-inline">
 	<input
@@ -63,6 +73,6 @@
 		id="<?php echo $id; ?>"
 		class="form-check-input<?php echo $class; ?>"
 		value="<?php echo htmlspecialchars($value, ENT_QUOTES, 'UTF-8'); ?>"
-		<?php echo $checked . $disabled . $onclick . $onchange . $required . $autofocus; ?>
+		<?php echo $checked . $disabled . $onclick . $onchange . $required . $autofocus . $dataAttribute; ?>
 	>
 </div>

layouts/joomla/form/field/color/advanced.php

@@ -44,6 +44,7 @@
  * @var   array    $checked         Is this field checked?
  * @var   array    $position        Is this field checked?
  * @var   array    $control         Is this field checked?
+ * @var   array    $dataAttributes  Miscellaneous data attributes for eg, data-*.
  */
 
 if ($validate !== 'color' && in_array($format, array('rgb', 'rgba'), true))
@@ -71,11 +72,20 @@
 // Force LTR input value in RTL, due to display issues with rgba/hex colors
 $direction = $lang->isRtl() ? ' dir="ltr" style="text-align:right"' : '';
 
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $value)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
+
 /** @var Joomla\CMS\WebAsset\WebAssetManager $wa */
 $wa = Factory::getApplication()->getDocument()->getWebAssetManager();
 $wa->usePreset('minicolors')
 	->useScript('field.color-adv');
-
 ?>
 <input type="text" name="<?php echo $name; ?>" id="<?php echo $id; ?>" value="<?php echo $this->escape($color); ?>"<?php
 	echo $hint,
@@ -91,5 +101,6 @@
 		$format,
 		$keywords,
 		$direction,
-		$validate;
+		$validate,
+		$dataAttribute;
 ?>/>

layouts/joomla/form/field/color/simple.php

@@ -47,11 +47,21 @@
  * @var   array    $position        Is this field checked?
  * @var   array    $control         Is this field checked?
  * @var   array    $colors          The specified colors
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*.
  */
 
 $class    = ' class="custom-select ' . trim($class) . '"';
 $disabled = $disabled ? ' disabled' : '';
 $readonly = $readonly ? ' readonly' : '';
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $value)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 
 Factory::getDocument()->getWebAssetManager()
 	->useStyle('webcomponent.field-simple-color')
@@ -60,7 +70,7 @@
 ?>
 <joomla-field-simple-color text-select="<?php echo Text::_('JFIELD_COLOR_SELECT'); ?>" text-color="<?php echo Text::_('JFIELD_COLOR_VALUE'); ?>" text-close="<?php echo Text::_('JLIB_HTML_BEHAVIOR_CLOSE'); ?>" text-transparent="<?php echo Text::_('JFIELD_COLOR_TRANSPARENT'); ?>">
 	<select name="<?php echo $name; ?>" id="<?php echo $id; ?>"<?php
-	echo $disabled; ?><?php echo $readonly; ?><?php echo $required; ?><?php echo $class; ?><?php echo $position; ?><?php
+	echo $disabled; ?><?php echo $readonly; ?><?php echo $dataAttribute; ?><?php echo $required; ?><?php echo $class; ?><?php echo $position; ?><?php
 	echo $onchange; ?><?php echo $autofocus; ?> style="visibility:hidden;width:22px;height:1px">
 		<?php foreach ($colors as $i => $c) : ?>
 			<option<?php echo ($c === $color ? ' selected="selected"' : ''); ?> value="<?php echo $c; ?>"></option>

layouts/joomla/form/field/combo.php

@@ -40,11 +40,13 @@
  * @var   string   $validate        Validation rules to apply.
  * @var   string   $value           Value attribute of the field.
  * @var   array    $options         Options available for this field.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*.
  */
 
 HTMLHelper::_('behavior.combobox');
 
 $attr = '';
+$dataAttribute = '';
 
 // Initialize some field attributes.
 $attr .= !empty($class) ? ' class="awesomplete form-control ' . $class . '"' : ' class="awesomplete form-control"';
@@ -56,6 +58,15 @@
 
 // Initialize JavaScript field attributes.
 $attr .= !empty($onchange) ? ' onchange="' . $onchange . '"' : '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $value)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
+
 $val  = [];
 
 foreach ($options as $option)
@@ -70,4 +81,5 @@
 	value="<?php echo htmlspecialchars($value, ENT_COMPAT, 'UTF-8'); ?>"
 	<?php echo $attr; ?>
 	data-list="<?php echo implode(', ', $val); ?>"
+	<?php echo $dataAttribute; ?>
 />

layouts/joomla/form/field/email.php

@@ -45,8 +45,19 @@
  * @var   array    $inputType       Options available for this field.
  * @var   array    $spellcheck      Options available for this field.
  * @var   string   $accept          File types that are accepted.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*.
  */
 
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
+
 $attributes = array(
 	$spellcheck ? '' : 'spellcheck="false"',
 	!empty($size) ? 'size="' . $size . '"' : '',
@@ -60,7 +71,9 @@
 	strlen($hint) ? 'placeholder="' . htmlspecialchars($hint, ENT_COMPAT, 'UTF-8') . '"' : '',
 	$required ? 'required' : '',
 	$autofocus ? 'autofocus' : '',
+	$dataAttribute,
 );
+
 ?>
 <input
 	type="email"

layouts/joomla/form/field/file.php

@@ -47,9 +47,21 @@
  * @var   array    $inputType       Options available for this field.
  * @var   array    $spellcheck      Options available for this field.
  * @var   string   $accept          File types that are accepted.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*
  */
 
 $maxSize = HTMLHelper::_('number.bytes', Utility::getMaxUploadSize());
+
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
+
 ?>
 <input type="file"
 	name="<?php echo $name; ?>"
@@ -60,6 +72,7 @@
 	<?php echo !empty($multiple) ? ' multiple' : ''; ?>
 	<?php echo $disabled ? ' disabled' : ''; ?>
 	<?php echo $autofocus ? ' autofocus' : ''; ?>
+	<?php echo $dataAttribute; ?>
 	<?php echo !empty($onchange) ? ' onchange="' . $onchange . '"' : ''; ?>
 	<?php echo $required ? ' required' : ''; ?>><br>
 	<?php echo Text::sprintf('JGLOBAL_MAXIMUM_UPLOAD_SIZE_LIMIT', $maxSize); ?>

layouts/joomla/form/field/hidden.php

@@ -41,16 +41,27 @@
  * @var   boolean  $hasValue        Has this field a value assigned?
  * @var   array    $options         Options available for this field.
  * @var   array    $inputType       Options available for this field.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*
  */
 
 // Initialize some field attributes.
 $class    = !empty($class) ? ' class="' . $class . '"' : '';
 $disabled = $disabled ? ' disabled' : '';
 $onchange = $onchange ? ' onchange="' . $onchange . '"' : '';
+
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $value)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 ?>
 <input
 	type="hidden"
 	name="<?php echo $name; ?>"
 	id="<?php echo $id; ?>"
 	value="<?php echo htmlspecialchars($value, ENT_COMPAT, 'UTF-8'); ?>"
-	<?php echo $class, $disabled, $onchange; ?>>
+	<?php echo $class, $disabled, $onchange, $dataAttribute; ?>>

layouts/joomla/form/field/list-fancy-select.php

@@ -45,16 +45,27 @@
  * @var   boolean  $hasValue        Has this field a value assigned?
  * @var   array    $options         Options available for this field.
  * @var   array    $inputType       Options available for this field.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*
  */
 
 $html = array();
 $attr = '';
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 
 // Initialize the field attributes.
 $attr .= !empty($size) ? ' size="' . $size . '"' : '';
 $attr .= $multiple ? ' multiple' : '';
 $attr .= $autofocus ? ' autofocus' : '';
 $attr .= $onchange ? ' onchange="' . $onchange . '"' : '';
+$attr .= $dataAttribute;
 
 // To avoid user's confusion, readonly="readonly" should imply disabled="disabled".
 if ($readonly || $disabled)

layouts/joomla/form/field/list.php

@@ -43,10 +43,20 @@
  * @var   boolean  $hasValue        Has this field a value assigned?
  * @var   array    $options         Options available for this field.
  * @var   array    $inputType       Options available for this field.
+ * @var   array    $dataAttributes  Miscellaneous data attribute for eg, data-*
  */
 
 $html = array();
 $attr = '';
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 
 // Initialize the field attributes.
 $attr .= !empty($class) ? ' class="custom-select ' . $class . '"' : ' class="custom-select"';
@@ -56,6 +66,7 @@
 $attr .= $autofocus ? ' autofocus' : '';
 $attr .= $onchange ? ' onchange="' . $onchange . '"' : '';
 $attr .= !empty($description) ? ' aria-describedby="' . $name . '-desc"' : '';
+$attr .= $dataAttribute;
 
 // To avoid user's confusion, readonly="readonly" should imply disabled="disabled".
 if ($readonly || $disabled)

layouts/joomla/form/field/media.php

@@ -19,31 +19,42 @@
  * Layout variables
  * ---------------------
  *
- * @var  string   $asset          The asset text
- * @var  string   $authorField    The label text
- * @var  integer  $authorId       The author id
- * @var  string   $class          The class text
- * @var  boolean  $disabled       True if field is disabled
- * @var  string   $folder         The folder text
- * @var  string   $id             The label text
- * @var  string   $link           The link text
- * @var  string   $name           The name text
- * @var  string   $preview        The preview image relative path
- * @var  integer  $previewHeight  The image preview height
- * @var  integer  $previewWidth   The image preview width
- * @var  string   $onchange       The onchange text
- * @var  boolean  $readonly       True if field is readonly
- * @var  integer  $size           The size text
- * @var  string   $value          The value text
- * @var  string   $src            The path and filename of the image
+ * @var  string   $asset           The asset text
+ * @var  string   $authorField     The label text
+ * @var  integer  $authorId        The author id
+ * @var  string   $class           The class text
+ * @var  boolean  $disabled        True if field is disabled
+ * @var  string   $folder          The folder text
+ * @var  string   $id              The label text
+ * @var  string   $link            The link text
+ * @var  string   $name            The name text
+ * @var  string   $preview         The preview image relative path
+ * @var  integer  $previewHeight   The image preview height
+ * @var  integer  $previewWidth    The image preview width
+ * @var  string   $onchange        The onchange text
+ * @var  boolean  $readonly        True if field is readonly
+ * @var  integer  $size            The size text
+ * @var  string   $value           The value text
+ * @var  string   $src             The path and filename of the image
+ * @var  array    $dataAttributes  Miscellaneous data attribute for eg, data-*
  */
 extract($displayData);
 
 $attr = '';
+$dataAttribute = '';
+
+if (!empty($dataAttributes))
+{
+	foreach ($dataAttributes as $key => $attrValue)
+	{
+		$dataAttribute .= ' ' . $key . '="' . htmlspecialchars($attrValue, ENT_COMPAT, 'UTF-8') . '"';
+	}
+}
 
 // Initialize some field attributes.
 $attr .= !empty($class) ? ' class="form-control field-media-input ' . $class . '"' : ' class="form-control field-media-input"';
 $attr .= !empty($size) ? ' size="' . $size . '"' : '';
+$attr .= $dataAttribute;
 
 // Initialize JavaScript field attributes.
 $attr .= !empty($onchange) ? ' onchange="' . $onchange . '"' : '';