⇦ Back to RawFilter classMethod filter
public mixed
filter
(\SimpleXMLElement $element, mixed $value, mixed $group = null, \Joomla\Registry\Registry $input = null, \Joomla\CMS\Form\Form $form = null)
Method to filter a field value.
Parameters
- \SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
- mixed $value The form field value to validate.
- string $group The field name group control value. This acts as an array container for the field.
For example if the field has name="foo" and the group value is set to "bar" then the
full field name would end up being "bar[foo]".
- \Joomla\Registry\Registry $input An optional Registry object with the entire data set to validate against the entire form.
- \Joomla\CMS\Form\Form $form The form object for which the field is being tested.
Returns
- mixed The filtered value.
Since
Method filter - Source code
/**
* Method to filter a field value.
*
* @param \SimpleXMLElement $element The SimpleXMLElement object representing the `<field>` tag for the form field object.
* @param mixed $value The form field value to validate.
* @param string $group The field name group control value. This acts as an array container for the field.
* For example if the field has name="foo" and the group value is set to "bar" then the
* full field name would end up being "bar[foo]".
* @param Registry $input An optional Registry object with the entire data set to validate against the entire form.
* @param Form $form The form object for which the field is being tested.
*
* @return mixed The filtered value.
*
* @since 4.0.0
*/
public function filter(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
{
return $value;
}