Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres protégées | Attributs protégés
Référence de la classe JFormFieldGroupedList
+ Graphe d'héritage de JFormFieldGroupedList:
+ Graphe de collaboration de JFormFieldGroupedList:

Liste de tous les membres

Fonctions membres protégées

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

Attributs protégés

 $type = 'GroupedList'
- 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

- Fonctions membres publiques inherited from JFormField
 __construct ($form=null)
 __get ($name)
 __set ($name, $value)
 setForm (JForm $form)
 setup (SimpleXMLElement $element, $value, $group=null)
 setValue ($value)
 getAttribute ($name, $default=null)
 getControlGroup ()
- 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 20 du fichier groupedlist.php.

Documentation des fonctions membres

JFormFieldGroupedList::getGroups ( )
protected

Method to get the field option groups.

Renvoie:
array The field option objects as a nested array in groups.
Depuis:
11.1
Exceptions:
UnexpectedValueException

Réimplémentée dans JFormFieldTimezone.

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

Références JText\_(), et JText\alt().

{
$groups = array();
$label = 0;
foreach ($this->element->children() as $element)
{
switch ($element->getName())
{
// The element is an <option />
case 'option':
// Initialize the group if necessary.
if (!isset($groups[$label]))
{
$groups[$label] = array();
}
$disabled = (string) $element['disabled'];
$disabled = ($disabled == 'true' || $disabled == 'disabled' || $disabled == '1');
// Create a new option object based on the <option /> element.
$tmp = JHtml::_(
'select.option', ($element['value']) ? (string) $element['value'] : trim((string) $element),
JText::alt(trim((string) $element), preg_replace('/[^a-zA-Z0-9_\-]/', '_', $this->fieldname)), 'value', 'text',
$disabled
);
// Set some option attributes.
$tmp->class = (string) $element['class'];
// Set some JavaScript option attributes.
$tmp->onclick = (string) $element['onclick'];
// Add the option.
$groups[$label][] = $tmp;
break;
// The element is a <group />
case 'group':
// Get the group label.
if ($groupLabel = (string) $element['label'])
{
$label = JText::_($groupLabel);
}
// Initialize the group if necessary.
if (!isset($groups[$label]))
{
$groups[$label] = array();
}
// Iterate through the children and build an array of options.
foreach ($element->children() as $option)
{
// Only add <option /> elements.
if ($option->getName() != 'option')
{
continue;
}
$disabled = (string) $option['disabled'];
$disabled = ($disabled == 'true' || $disabled == 'disabled' || $disabled == '1');
// Create a new option object based on the <option /> element.
$tmp = JHtml::_(
'select.option', ($option['value']) ? (string) $option['value'] : JText::_(trim((string) $option)),
JText::_(trim((string) $option)), 'value', 'text', $disabled
);
// Set some option attributes.
$tmp->class = (string) $option['class'];
// Set some JavaScript option attributes.
$tmp->onclick = (string) $option['onclick'];
// Add the option.
$groups[$label][] = $tmp;
}
if ($groupLabel)
{
$label = count($groups);
}
break;
// Unknown element type.
default:
throw new UnexpectedValueException(sprintf('Unsupported element %s in JFormFieldGroupedList', $element->getName()), 500);
}
}
reset($groups);
return $groups;
}

+ Voici le graphe d'appel pour cette fonction :

JFormFieldGroupedList::getInput ( )
protected

Method to get the field input markup fora grouped list. Multiselect is enabled by using the multiple attribute.

Renvoie:
string The field input markup.
Depuis:
11.1

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

Définition à la ligne 142 du fichier groupedlist.php.

Références if.

{
$html = array();
$attr = '';
// Initialize some field attributes.
$attr .= !empty($this->class) ? ' class="' . $this->class . '"' : '';
$attr .= $this->disabled ? ' disabled' : '';
$attr .= !empty($this->size) ? ' size="' . $this->size . '"' : '';
$attr .= $this->multiple ? ' multiple' : '';
$attr .= $this->required ? ' required aria-required="true"' : '';
$attr .= $this->autofocus ? ' autofocus' : '';
// Initialize JavaScript field attributes.
$attr .= !empty($this->onchange) ? ' onchange="' . $this->onchange . '"' : '';
// Get the field groups.
$groups = (array) $this->getGroups();
// Create a read-only list (no name) with a hidden input to store the value.
if ($this->readonly)
{
$html[] = JHtml::_(
'select.groupedlist', $groups, null,
array(
'list.attr' => $attr, 'id' => $this->id, 'list.select' => $this->value, 'group.items' => null, 'option.key.toHtml' => false,
'option.text.toHtml' => false
)
);
$html[] = '<input type="hidden" name="' . $this->name . '" value="' . $this->value . '"/>';
}
// Create a regular list.
else
{
$html[] = JHtml::_(
'select.groupedlist', $groups, $this->name,
array(
'list.attr' => $attr, 'id' => $this->id, 'list.select' => $this->value, 'group.items' => null, 'option.key.toHtml' => false,
'option.text.toHtml' => false
)
);
}
return implode($html);
}

Documentation des données membres

JFormFieldGroupedList::$type = 'GroupedList'
protected

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

Réimplémentée dans JFormFieldTimezone.

Définition à la ligne 28 du fichier groupedlist.php.

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