Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class RulesRule - list of methods

Form Rule class for the Joomla Platform.

Extends

FormRule
Package: Joomla\CMS\Form\Rule
Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Form/Rule/RulesRule.php
Project: Joomla

Method Summary

public bool
(\SimpleXMLElement $element, mixed $value, mixed $group = null, \Joomla\Registry\Registry $input = null, \Joomla\CMS\Form\Form $form = null)

Method to test the 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
  • bool True if the value is valid, false otherwise.
Since
  • 1.7.0
Show source code of this method: test Source Code

protected array
(mixed $value)

Method to get the list of permission action names from the form field value.
Parameters
  • mixed $value The form field value to validate.
Returns
  • array A list of permission action names from the form field value.
Since
  • 1.7.0
Show source code of this method: getValueActions Source Code

protected array
(\SimpleXMLElement $element)

Method to get the list of possible permission action names for the form field.
Parameters
  • \SimpleXMLElement $element The \SimpleXMLElement object representing the `<field>` tag for the form field object.
Returns
  • array A list of permission action names from the form field element definition.
Since
  • 1.7.0
Show source code of this method: getFieldActions Source Code

Tags Summary

Since
1.7.0