Back to MeterField class

Method setup

public bool
setup
(\SimpleXMLElement $element, mixed $value, mixed $group = null)
Method to attach a Form object to the field.
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]".
Returns
  • bool True on success.
Since
  • 3.2
-
  • \Joomla\CMS\Form\FormField::setup()
Class: MeterField
Project: Joomla

Method setup - Source code

/**
 * Method to attach a Form object to the field.
 *
 * @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]".
 *
 * @return  boolean  True on success.
 *
 * @see     FormField::setup()
 * @since   3.2
 */
public function setup(\SimpleXMLElement $element, $value, $group = null)
{
    $return = parent::setup($element, $value, $group);
    if ($return) {
        $this->width = isset($this->element['width']) ? (string) $this->element['width'] : '';
        $this->color = isset($this->element['color']) ? (string) $this->element['color'] : '';
        $active = (string) $this->element['active'];
        $this->active = $active === 'true' || $active === 'on' || $active === '1';
        $animated = (string) $this->element['animated'];
        $this->animated = !($animated === 'false' || $animated === 'off' || $animated === '0');
    }
    return $return;
}