FilePathRule
Extends FormRuleForm Rule class for the Joomla Platform.
| since |
3.9.21 |
|---|---|
| package |
Joomla CMS |
Methods
test
Method to test the value.
test(\SimpleXMLElement element, mixed value, string group = null, \Joomla\Registry\Registry input = null, \Joomla\CMS\Form\Form form = null) : bool
| since |
1.6 |
|---|---|
| throws |
|
Arguments
- element
\SimpleXMLElementThe SimpleXMLElement object representing the<field>tag for the form field object.- value
mixedThe form field value to validate.- group
stringThe field name group control value. This acts as 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]".- input
\Joomla\Registry\RegistryAn optional Registry object with the entire data set to validate against the entire form.- form
\Joomla\CMS\Form\FormThe form object for which the field is being tested.
Response
boolTrue if the value is valid, false otherwise.
Properties
regex
The regular expression to use in testing a form field value.
| since |
1.6 |
|---|
Type(s)
string
modifiers
The regular expression modifiers to use when testing a form field value.
| since |
1.6 |
|---|
Type(s)
string