Back to ColorField 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: ColorField
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->colors = (string) $this->element['colors'];
        $this->control = isset($this->element['control']) ? (string) $this->element['control'] : 'hue';
        $this->default = (string) $this->element['default'];
        $this->display = isset($this->element['display']) ? (string) $this->element['display'] : 'hue';
        $this->format = isset($this->element['format']) ? (string) $this->element['format'] : 'hex';
        $this->keywords = (string) $this->element['keywords'];
        $this->position = isset($this->element['position']) ? (string) $this->element['position'] : 'default';
        $this->preview = isset($this->element['preview']) ? (string) $this->element['preview'] : false;
        $this->saveFormat = isset($this->element['saveFormat']) ? (string) $this->element['saveFormat'] : 'hex';
        $this->split = isset($this->element['split']) ? (int) $this->element['split'] : 3;
    }
    return $return;
}