Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JFormFieldCheckbox
+ Graphe d'héritage de JFormFieldCheckbox:
+ Graphe de collaboration de JFormFieldCheckbox:

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 ()

Fonctions membres protégées

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

Attributs protégés

 $type = 'Checkbox'
 $checked = false
- 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 publics inherited from JFormField
 $repeat = false
- Attributs protégés statiques inherited from JFormField
static $count = 0
static $generated_fieldname = '__field'

Description détaillée

Définition à la ligne 23 du fichier checkbox.php.


Documentation des fonctions membres

JFormFieldCheckbox::__get (   $name)

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

Paramètres:
string$nameThe 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 50 du fichier checkbox.php.

{
switch ($name)
{
case 'checked':
return $this->$name;
}
}
JFormFieldCheckbox::__set (   $name,
  $value 
)

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

Paramètres:
string$nameThe property name for which to the the value.
mixed$valueThe value of the property.
Renvoie:
void
Depuis:
3.2

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

Définition à la ligne 71 du fichier checkbox.php.

{
switch ($name)
{
case 'checked':
$value = (string) $value;
$this->$name = ($value == 'true' || $value == $name || $value == '1');
break;
default:
}
}
JFormFieldCheckbox::getInput ( )
protected

Method to get the field input markup. The checked element sets the field to selected.

Renvoie:
string The field input markup.
Depuis:
11.1

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

Définition à la ligne 122 du fichier checkbox.php.

{
// Initialize some field attributes.
$class = !empty($this->class) ? ' class="' . $this->class . '"' : '';
$disabled = $this->disabled ? ' disabled' : '';
$value = !empty($this->default) ? $this->default : '1';
$required = $this->required ? ' required aria-required="true"' : '';
$autofocus = $this->autofocus ? ' autofocus' : '';
$checked = $this->checked || !empty($this->value) ? ' checked' : '';
// Initialize JavaScript field attributes.
$onclick = !empty($this->onclick) ? ' onclick="' . $this->onclick . '"' : '';
$onchange = !empty($this->onchange) ? ' onchange="' . $this->onchange . '"' : '';
// Including fallback code for HTML5 non supported browsers.
JHtml::_('jquery.framework');
JHtml::_('script', 'system/html5fallback.js', false, true);
return '<input type="checkbox" name="' . $this->name . '" id="' . $this->id . '" value="'
. htmlspecialchars($value, ENT_COMPAT, 'UTF-8') . '"' . $class . $checked . $disabled . $onclick . $onchange
. $required . $autofocus . ' />';
}
JFormFieldCheckbox::setup ( SimpleXMLElement  $element,
  $value,
  $group = null 
)

Method to attach a JForm object to the field.

Paramètres:
SimpleXMLElement$elementThe SimpleXMLElement object representing the <field> tag for the form field object.
mixed$valueThe form field value to validate.
string$groupThe 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 99 du fichier checkbox.php.

{
if ($return)
{
$checked = (string) $this->element['checked'];
$this->checked = ($checked == 'true' || $checked == 'checked' || $checked == '1');
empty($this->value) || $this->checked ? null : $this->checked = true;
}
return $return;
}

Documentation des données membres

JFormFieldCheckbox::$checked = false
protected

Définition à la ligne 39 du fichier checkbox.php.

JFormFieldCheckbox::$type = 'Checkbox'
protected

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

Définition à la ligne 31 du fichier checkbox.php.


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