Back to ChromestyleField 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\Field\FormField::setup()

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)
{
    $result = parent::setup($element, $value, $group);
    if ($result === true) {
        // Get the client id.
        $clientId = $this->element['client_id'];
        if (!isset($clientId)) {
            $clientName = $this->element['client'];
            if (isset($clientName)) {
                $client = ApplicationHelper::getClientInfo($clientName, true);
                $clientId = $client->id;
            }
        }
        if (!isset($clientId) && $this->form instanceof Form) {
            $clientId = $this->form->getValue('client_id');
        }
        $this->clientId = (int) $clientId;
    }
    return $result;
}