Référence de la classe JFormFieldCheckboxes

Graphe d'héritage de JFormFieldCheckboxes:

Graphe de collaboration de JFormFieldCheckboxes:

Liste de tous les membres

Fonctions membres publiques
	__get ($name)
	__set ($name, $value)
	setup (SimpleXMLElement $element, $value, $group=null)
Fonctions membres publiques inherited from JFormField
	__construct ($form=null)
	setForm (JForm $form)
	setValue ($value)
	getAttribute ($name, $default=null)
	getControlGroup ()

Attributs publics
	$checkedOptions
Attributs publics inherited from JFormField
	$repeat = false

Fonctions membres protégées
	getInput ()
	getOptions ()
Fonctions membres protégées inherited from JFormField
	getId ($fieldId, $fieldName)
	getTitle ()
	getLabel ()
	getName ($fieldName)
	getFieldName ($fieldName)

Attributs protégés
	$type = 'Checkboxes'
	$forceMultiple = true
Attributs protégés inherited from JFormField
	$description
	$hint
	$autocomplete = 'on'
	$spellcheck = true
	$autofocus = false
	$element
	$form
	$formControl
	$hidden = false
	$translateLabel = true
	$translateDescription = true
	$translateHint = true
	$id
	$input
	$label
	$multiple = false
	$pattern
	$name
	$fieldname
	$group
	$required = false
	$disabled = false
	$readonly = false
	$validate
	$value
	$default
	$size
	$class
	$labelClass
	$onchange
	$onclick

Additional Inherited Members
Attributs protégés statiques inherited from JFormField
static	$count = 0
static	$generated_fieldname = '__field'

---

Description détaillée

Définition à la ligne 22 du fichier checkboxes.php.

---

Documentation des fonctions membres

JFormFieldCheckboxes::__get

(

$name

)

Method to get certain otherwise inaccessible properties from the form field object.

Paramètres:

string

$name

The property name for which to the the value.

Renvoie:

mixed The property value or null.

Depuis:

3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 57 du fichier checkboxes.php.

        {
                switch ($name)
                {
                        case 'forceMultiple':
                        case 'checkedOptions':
                                return $this->$name;
                }

                return parent::__get($name);
        }

JFormFieldCheckboxes::__set	(		$name,
			$value
	)

Method to set certain otherwise inaccessible properties of the form field object.

Paramètres:

string	$name	The property name for which to the the value.
mixed	$value	The value of the property.

Renvoie:

void

Depuis:

3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 79 du fichier checkboxes.php.

        {
                switch ($name)
                {
                        case 'checkedOptions':
                                $this->checkedOptions = (string) $value;
                                break;

                        default:
                                parent::__set($name, $value);
                }
        }

JFormFieldCheckboxes::getInput ( )

protected

Method to get the field input markup for check boxes.

Renvoie:

string The field input markup.

Depuis:

11.1

Réimplémentée à partir de JFormField.

Définition à la ligne 125 du fichier checkboxes.php.

Références JText\_().

        {
                $html = array();

                // Initialize some field attributes.
                $class          = !empty($this->class) ? ' class=checkboxes "' . $this->class . '"' : ' class="checkboxes"';
                $checkedOptions = explode(',', (string) $this->checkedOptions);
                $required       = $this->required ? ' required aria-required="true"' : '';
                $autofocus      = $this->autofocus ? ' autofocus' : '';

                // Including fallback code for HTML5 non supported browsers.
                JHtml::_('jquery.framework');
                JHtml::_('script', 'system/html5fallback.js', false, true);

                // Start the checkbox field output.
                $html[] = '<fieldset id="' . $this->id . '"' . $class . $required . $autofocus . '>';

                // Get the field options.
                $options = $this->getOptions();

                // Build the checkbox field output.
                $html[] = '<ul>';

                foreach ($options as $i => $option)
                {
                        // Initialize some option attributes.
                        if (!isset($this->value) || empty($this->value))
                        {
                                $checked = (in_array((string) $option->value, (array) $checkedOptions) ? ' checked' : '');
                        }
                        else
                        {
                                $value = !is_array($this->value) ? explode(',', $this->value) : $this->value;
                                $checked = (in_array((string) $option->value, $value) ? ' checked' : '');
                        }

                        $checked = empty($checked) && $option->checked ? ' checked' : $checked;

                        $class = !empty($option->class) ? ' class="' . $option->class . '"' : '';
                        $disabled = !empty($option->disable) || $this->disabled ? ' disabled' : '';

                        // Initialize some JavaScript option attributes.
                        $onclick = !empty($option->onclick) ? ' onclick="' . $option->onclick . '"' : '';
                        $onchange = !empty($option->onchange) ? ' onchange="' . $option->onchange . '"' : '';

                        $html[] = '<li>';
                        $html[] = '<input type="checkbox" id="' . $this->id . $i . '" name="' . $this->name . '" value="'
                                . htmlspecialchars($option->value, ENT_COMPAT, 'UTF-8') . '"' . $checked . $class . $onclick . $onchange . $disabled . '/>';

                        $html[] = '<label for="' . $this->id . $i . '"' . $class . '>' . JText::_($option->text) . '</label>';
                        $html[] = '</li>';
                }

                $html[] = '</ul>';

                // End the checkbox field output.
                $html[] = '</fieldset>';

                return implode($html);
        }

Voici le graphe d'appel pour cette fonction :

JFormFieldCheckboxes::getOptions ( )

protected

Method to get the field options.

Renvoie:

array The field option objects.

Depuis:

11.1

Définition à la ligne 193 du fichier checkboxes.php.

        {
                $options = array();

                foreach ($this->element->children() as $option)
                {
                        // Only add <option /> elements.
                        if ($option->getName() != 'option')
                        {
                                continue;
                        }

                        $disabled = (string) $option['disabled'];
                        $disabled = ($disabled == 'true' || $disabled == 'disabled' || $disabled == '1');

                        $checked = (string) $option['checked'];
                        $checked = ($checked == 'true' || $checked == 'checked' || $checked == '1');

                        // Create a new option object based on the <option /> element.
                        $tmp = JHtml::_('select.option', (string) $option['value'], trim((string) $option), 'value', 'text', $disabled);

                        // Set some option attributes.
                        $tmp->class = (string) $option['class'];
                        $tmp->checked = $checked;

                        // Set some JavaScript option attributes.
                        $tmp->onclick = (string) $option['onclick'];
                        $tmp->onchange = (string) $option['onchange'];

                        // Add the option object to the result set.
                        $options[] = $tmp;
                }

                reset($options);

                return $options;
        }

JFormFieldCheckboxes::setup	(	SimpleXMLElement	$element,
			$value,
			$group = null
	)

Method to attach a JForm object to the field.

Paramètres:

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 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]".

Renvoie:

boolean True on success.

Voir également:

JFormField::setup()

Depuis:

3.2

Réimplémentée à partir de JFormField.

Définition à la ligne 106 du fichier checkboxes.php.

        {
                $return = parent::setup($element, $value, $group);

                if ($return)
                {
                        $this->checkedOptions = (string) $this->element['checked'];
                }

                return $return;
        }

---

Documentation des données membres

JFormFieldCheckboxes::$checkedOptions

Définition à la ligne 46 du fichier checkboxes.php.

JFormFieldCheckboxes::$forceMultiple = true

protected

Définition à la ligne 38 du fichier checkboxes.php.

JFormFieldCheckboxes::$type = 'Checkboxes'

protected

Réimplémentée à partir de JFormField.

Définition à la ligne 30 du fichier checkboxes.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/form/fields/checkboxes.php