XOOPS  2.6.0
Xoops\Form\SelectUser Class Reference
Inheritance diagram for Xoops\Form\SelectUser:
Inheritance graph

Public Member Functions

 __construct ($caption, $name, $include_anon=false, $value=null, $size=1, $multiple=false)
 
- Public Member Functions inherited from Xoops\Form\ElementTray
 __construct ($caption, $delimiter=" ", $name="")
 
 addElement (Element $formElement, $required=false)
 
 getDelimiter ($encode=false)
 
 getElements ($recursively=false)
 
 getRequired ()
 
 isRequired ()
 
 render ()
 
- Public Member Functions inherited from Xoops\Form\Element
 getAccessKey ()
 
 getAccessString ($str)
 
 getCaption ()
 
 getClass ()
 
 getDatalist ()
 
 getDescription ($encode=false)
 
 getExtra ($encode=false)
 
 getMaxcols ()
 
 getName ()
 
 getPattern ()
 
 getPatternDescription ()
 
 getTitle ()
 
 getValue ($encode=false)
 
 isDatalist ()
 
 isHidden ()
 
 isRequired ()
 
 render ()
 
 renderAttributeString ()
 
 renderValidationJS ()
 
 setAccessKey ($key)
 
 setCaption ($caption)
 
 setClass ($class)
 
 setDatalist ($datalist)
 
 setDescription ($description)
 
 setExtra ($extra, $replace=false)
 
 setHidden ()
 
 setName ($name)
 
 setPattern ($pattern, $pattern_description= '')
 
 setRequired ($bool=true)
 
 setTitle ($title)
 
 setValue ($value)
 
- Public Member Functions inherited from Xoops\Html\Attributes
 addAttribute ($name, $value)
 
 getAttribute ($name)
 
 hasAttribute ($name)
 
 renderAttributeString ()
 
 setAttribute ($name, $value=null)
 
 setAttributes ($values)
 
 unsetAttribute ($name)
 

Additional Inherited Members

- Public Attributes inherited from Xoops\Form\Element
 $customValidationCode = array()
 
- Protected Attributes inherited from Xoops\Form\ElementTray
 $delimiter
 
 $elements = array()
 
 $required = array()
 
- Protected Attributes inherited from Xoops\Form\Element
 $value = ''
 
- Protected Attributes inherited from Xoops\Html\Attributes
 $attributes = array()
 

Detailed Description

Definition at line 30 of file SelectUser.php.

Constructor & Destructor Documentation

Xoops\Form\SelectUser::__construct (   $caption,
  $name,
  $include_anon = false,
  $value = null,
  $size = 1,
  $multiple = false 
)

Constructor

Parameters
string$captioncaption
string$nameelement name
bool$include_anonInclude user "anonymous"?
mixed$valuePre-selected value (or array of them). For an item with massive members, such as "Registered Users", "$value" should be used to store selected temporary users only instead of all members of that item
int$sizeNumber or rows. "1" makes a drop-down-list.
bool$multipleAllow multiple selections?

Definition at line 45 of file SelectUser.php.

References Xoops\Form\Element\$caption, $criteria, $limit, $member_handler, $name, Xoops\Form\Element\$value, $xoops, Xoops\Form\ElementTray\addElement(), and Xoops\getInstance().

Here is the call graph for this function:


The documentation for this class was generated from the following file: