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

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 = 'Color'
 $control = 'hue'
 $position = 'right'
 $colors
 $split = 3
- 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 21 du fichier color.php.

Documentation des fonctions membres

JFormFieldColor::__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 72 du fichier color.php.

{
switch ($name)
{
case 'control':
case 'exclude':
case 'colors':
case 'split':
return $this->$name;
}
return parent::__get($name);
}
JFormFieldColor::__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 96 du fichier color.php.

{
switch ($name)
{
case 'split':
$value = (int) $value;
case 'control':
case 'exclude':
case 'colors':
$this->$name = (string) $value;
break;
default:
parent::__set($name, $value);
}
}
JFormFieldColor::getInput ( )
protected

Method to get the field input markup.

Renvoie:
string The field input markup.
Depuis:
11.3

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

Définition à la ligne 149 du fichier color.php.

Références JText\_().

{
// Translate placeholder text
$hint = $this->translateHint ? JText::_($this->hint) : $this->hint;
// Control value can be: hue (default), saturation, brightness, wheel or simple
$control = $this->control;
// Position of the panel can be: right (default), left, top or bottom
$position = ' data-position="' . $this->position . '"';
$onchange = !empty($this->onchange) ? ' onchange="' . $this->onchange . '"' : '';
$class = $this->class;
$required = $this->required ? ' required aria-required="true"' : '';
$disabled = $this->disabled ? ' disabled' : '';
$autofocus = $this->autofocus ? ' autofocus' : '';
$color = strtolower($this->value);
if (!$color || in_array($color, array('none', 'transparent')))
{
$color = 'none';
}
elseif ($color['0'] != '#')
{
$color = '#' . $color;
}
if ($control == 'simple')
{
$class = ' class="' . trim('simplecolors chzn-done ' . $class) . '"';
JHtml::_('behavior.simplecolorpicker');
$colors = strtolower($this->colors);
if (empty($colors))
{
$colors = array(
'none',
'#049cdb',
'#46a546',
'#9d261d',
'#ffc40d',
'#f89406',
'#c3325f',
'#7a43b6',
'#ffffff',
'#999999',
'#555555',
'#000000'
);
}
else
{
$colors = explode(',', $colors);
}
$split = $this->split;
if (!$split)
{
$count = count($colors);
if ($count % 5 == 0)
{
$split = 5;
}
else
{
if ($count % 4 == 0)
{
$split = 4;
}
}
}
$split = $split ? $split : 3;
$html = array();
$html[] = '<select name="' . $this->name . '" id="' . $this->id . '"' . $disabled . $required
. $class . $position . $onchange . $autofocus . ' style="visibility:hidden;width:22px;height:1px">';
foreach ($colors as $i => $c)
{
$html[] = '<option' . ($c == $color ? ' selected="selected"' : '') . '>' . $c . '</option>';
if (($i + 1) % $split == 0)
{
$html[] = '<option>-</option>';
}
}
$html[] = '</select>';
return implode('', $html);
}
else
{
$class = ' class="' . trim('minicolors ' . $class) . '"';
$control = $control ? ' data-control="' . $control . '"' : '';
$readonly = $this->readonly ? ' readonly' : '';
$hint = $hint ? ' placeholder="' . $hint . '"' : ' placeholder="#rrggbb"';
$autocomplete = !$this->autocomplete ? ' autocomplete="off"' : '';
// Including fallback code for HTML5 non supported browsers.
JHtml::_('jquery.framework');
JHtml::_('script', 'system/html5fallback.js', false, true);
JHtml::_('behavior.colorpicker');
return '<input type="text" name="' . $this->name . '" id="' . $this->id . '"' . ' value="'
. htmlspecialchars($color, ENT_COMPAT, 'UTF-8') . '"' . $hint . $class . $position . $control
. $readonly . $disabled . $required . $onchange . $autocomplete . $autofocus . '/>';
}
}

+ Voici le graphe d'appel pour cette fonction :

JFormFieldColor::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 127 du fichier color.php.

{
$return = parent::setup($element, $value, $group);
if ($return)
{
$this->control = isset($this->element['control']) ? (string) $this->element['control'] : 'hue';
$this->position = isset($this->element['position']) ? (string) $this->element['position'] : 'right';
$this->colors = (string) $this->element['colors'];
$this->split = isset($this->element['split']) ? (int) $this->element['split'] : 3;
}
return $return;
}

Documentation des données membres

JFormFieldColor::$colors
protected

Définition à la ligne 53 du fichier color.php.

JFormFieldColor::$control = 'hue'
protected

Définition à la ligne 37 du fichier color.php.

JFormFieldColor::$position = 'right'
protected

Définition à la ligne 45 du fichier color.php.

JFormFieldColor::$split = 3
protected

Définition à la ligne 61 du fichier color.php.

JFormFieldColor::$type = 'Color'
protected

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

Définition à la ligne 29 du fichier color.php.

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