XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe XoopsFormSelect
+ Graphe d'héritage de XoopsFormSelect:
+ Graphe de collaboration de XoopsFormSelect:

Fonctions membres publiques

 __construct ($caption, $name, $value=null, $size=1, $multiple=false)
 
 isMultiple ()
 
 getSize ()
 
 getValue ($encode=false)
 
 setValue ($value)
 
 addOption ($value, $name='')
 
 addOptionArray ($options)
 
 getOptions ($encode=false)
 
 render ()
 
 renderValidationJS ()
 
- Fonctions membres publiques hérités de XoopsFormElement
 __construct ()
 
 isContainer ()
 
 setName ($name)
 
 getName ($encode=true)
 
 setAccessKey ($key)
 
 getAccessKey ()
 
 getAccessString ($str)
 
 setClass ($class)
 
 getClass ()
 
 setCaption ($caption)
 
 getCaption ($encode=false)
 
 getTitle ($encode=true)
 
 setDescription ($description)
 
 getDescription ($encode=false)
 
 setHidden ()
 
 isHidden ()
 
 isRequired ()
 
 setExtra ($extra, $replace=false)
 
 getExtra ($encode=false)
 
 setNocolspan ($nocolspan=true)
 
 getNocolspan ()
 
 getFormType ()
 
 setFormType ($value='')
 

Champs de données

 $_options = array()
 
 $_multiple = false
 
 $_size
 
 $_value = array()
 
- Champs de données hérités de XoopsFormElement
 $customValidationCode = array()
 
 $_name
 
 $_caption
 
 $_accesskey = ''
 
 $_class = array()
 
 $_hidden = false
 
 $_extra = array()
 
 $_required = false
 
 $_description = ''
 
 $_nocolspan = false
 
 $_formtype = ''
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $caption,
  $name,
  $value = null,
  $size = 1,
  $multiple = false 
)

Constructor

Paramètres
string$captionCaption
string$name"name" attribute
mixed$valuePre-selected value (or array of them).
int$sizeNumber or rows. "1" makes a drop-down-list
bool$multipleAllow multiple selections?

Réimplémentée dans XoopsFormSelectTheme.

+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ addOption()

addOption (   $value,
  $name = '' 
)

Add an option

Paramètres
string$value"value" attribute
string$name"name" attribute
+ Voici le graphe des appelants de cette fonction :

◆ addOptionArray()

addOptionArray (   $options)

Add multiple options

Paramètres
array$optionsAssociative array of value->name pairs
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ getOptions()

getOptions (   $encode = false)

Get an array with all the options

Note: both name and value should be sanitized. However for backward compatibility, only value is sanitized for now.

Paramètres
bool | int$encodeTo sanitizer the text? potential values: 0 - skip; 1 - only for value; 2 - for both value and name
Renvoie
array Associative array of value->name pairs
+ Voici le graphe des appelants de cette fonction :

◆ getSize()

getSize ( )

Get the size

Renvoie
int
+ Voici le graphe des appelants de cette fonction :

◆ getValue()

getValue (   $encode = false)

Get an array of pre-selected values

Paramètres
bool$encodeTo sanitizer the text?
Renvoie
array
+ Voici le graphe des appelants de cette fonction :

◆ isMultiple()

isMultiple ( )

Are multiple selections allowed?

Renvoie
bool
+ Voici le graphe des appelants de cette fonction :

◆ render()

render ( )

Prepare HTML for output

Renvoie
string HTML

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

+ Voici le graphe d'appel pour cette fonction :

◆ renderValidationJS()

renderValidationJS ( )

Render custom javascript validation code

@seealso XoopsForm::renderValidationJS

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

+ Voici le graphe d'appel pour cette fonction :

◆ setValue()

setValue (   $value)

Set pre-selected values

Paramètres
mixed$value
+ Voici le graphe des appelants de cette fonction :

Documentation des champs

◆ $_multiple

$_multiple = false

◆ $_options

$_options = array()

◆ $_size

$_size

◆ $_value

$_value = array()

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