Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ColorField
+ Graphe d'héritage de ColorField:

Fonctions membres publiques

 __get ($name)
 
 __set ($name, $value)
 
 setup (\SimpleXMLElement $element, $value, $group=null)
 
- Fonctions membres publiques hérités de FormField
 __construct ($form=null)
 
 __get ($name)
 
 __set ($name, $value)
 
 setForm (Form $form)
 
 setup (\SimpleXMLElement $element, $value, $group=null)
 
 setValue ($value)
 
 getAttribute ($name, $default=null)
 
 getDataAttributes ()
 
 renderDataAttributes ()
 
 render ($layoutId, $data=array())
 
 renderField ($options=array())
 
 filter ($value, $group=null, Registry $input=null)
 
 validate ($value, $group=null, Registry $input=null)
 
 postProcess ($value, $group=null, Registry $input=null)
 
- Fonctions membres publiques hérités de DatabaseAwareInterface
 setDatabase (DatabaseInterface $db)
 

Fonctions membres protégées

 getInput ()
 
 getLayoutData ()
 
 getSimpleModeLayoutData ()
 
 getAdvancedModeLayoutData ($lang)
 
 getSliderModeLayoutData ()
 
- Fonctions membres protégées hérités de FormField
 getId ($fieldId, $fieldName)
 
 getInput ()
 
 getTitle ()
 
 getLabel ()
 
 getName ($fieldName)
 
 getFieldName ($fieldName)
 
 getLayoutData ()
 
 getLayoutPaths ()
 
 getRenderer ($layoutId='default')
 
 isDebugEnabled ()
 

Attributs protégés

 $type = 'Color'
 
 $control = 'hue'
 
 $default
 
 $display = 'hue'
 
 $format = 'hex'
 
 $keywords = ''
 
 $position = 'default'
 
 $colors
 
 $preview = false
 
 $saveFormat = 'hex'
 
 $split = 3
 
 $layout = 'joomla.form.field.color'
 
- Attributs protégés hérités de FormField
 $description
 
 $hint
 
 $autocomplete = 'on'
 
 $spellcheck = true
 
 $autofocus = false
 
 $element
 
 $form
 
 $formControl
 
 $hidden = false
 
 $hiddenLabel = false
 
 $hiddenDescription = false
 
 $translateLabel = true
 
 $translateDescription = true
 
 $translateHint = true
 
 $id
 
 $input
 
 $label
 
 $multiple = false
 
 $pattern
 
 $validationtext
 
 $name
 
 $fieldname
 
 $group
 
 $required = false
 
 $disabled = false
 
 $readonly = false
 
 $type
 
 $validate
 
 $value
 
 $default
 
 $size
 
 $class
 
 $labelclass
 
 $onchange
 
 $onclick
 
 $showon
 
 $parentclass
 
 $layout
 
 $renderLayout = 'joomla.form.renderfield'
 
 $renderLabelLayout = 'joomla.form.renderlabel'
 
 $dataAttributes = array()
 

Membres hérités additionnels

- Champs de données hérités de FormField
 $repeat = false
 
- Attributs protégés statiques hérités de FormField
static $count = 0
 
static $generated_fieldname = '__field'
 

Description détaillée

Color Form Field class for the Joomla Platform. This implementation is designed to be compatible with HTML5's <input type="color">

1.7.3

Documentation des fonctions membres

◆ __get()

__get (   $name)

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

Paramètres
string$nameThe property name for which to get the value.
Renvoie
mixed The property value or null.
Depuis
3.2

Références $name.

◆ __set()

__set (   $name,
  $value 
)

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

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

Références $name, et $value.

◆ getAdvancedModeLayoutData()

getAdvancedModeLayoutData (   $lang)
protected

Method to get the data for the advanced mode to be passed to the layout for rendering.

Paramètres
object$langThe language object
Renvoie
array
Depuis
3.5

Références $lang.

◆ getInput()

getInput ( )
protected

Method to get the field input markup.

Renvoie
string The field input markup.
Depuis
1.7.3

Références $control.

◆ getLayoutData()

getLayoutData ( )
protected

Method to get the data to be passed to the layout for rendering.

Renvoie
array
Depuis
3.5

Références $color, $data, $lang, $position, elseif, Factory\getApplication(), et value.

◆ getSimpleModeLayoutData()

getSimpleModeLayoutData ( )
protected

Method to get the data for the simple mode to be passed to the layout for rendering.

Renvoie
array
Depuis
3.5

Références $colors, et $count.

◆ getSliderModeLayoutData()

getSliderModeLayoutData ( )
protected

Method to get the data for the slider

Renvoie
array
Depuis
4.0.0

◆ setup()

setup ( \SimpleXMLElement  $element,
  $value,
  $group = null 
)

Method to attach a Form 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 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
FormField::setup()
Depuis
3.2

Références $return, et $value.

Documentation des champs

◆ $colors

$colors
protected

◆ $control

$control = 'hue'
protected

◆ $default

$default
protected

◆ $display

$display = 'hue'
protected

◆ $format

$format = 'hex'
protected

◆ $keywords

$keywords = ''
protected

◆ $layout

$layout = 'joomla.form.field.color'
protected

◆ $position

$position = 'default'
protected

◆ $preview

$preview = false
protected

◆ $saveFormat

$saveFormat = 'hex'
protected

◆ $split

$split = 3
protected

◆ $type

$type = 'Color'
protected

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