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

Public Member Functions

 __construct (Form $form, $name= 'editor', $value=null, $nohtml=false, $allowed_editors=array())
 
 render ()
 
- 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)
 

Public Attributes

 $allowed_editors = array()
 
 $form
 
 $name
 
 $nohtml
 
 $value
 
- Public Attributes inherited from Xoops\Form\Element
 $customValidationCode = array()
 

Additional Inherited Members

- 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 25 of file SelectEditor.php.

Constructor & Destructor Documentation

Xoops\Form\SelectEditor::__construct ( Form  $form,
  $name = 'editor',
  $value = null,
  $nohtml = false,
  $allowed_editors = array() 
)

Constructor

Parameters
Form$formthe form calling the editor selection
string$nameeditor name
string$valuePre-selected text value
boolean$nohtmldohtml disabled
array$allowed_editorsallowed editors

Definition at line 61 of file SelectEditor.php.

References Xoops\Form\SelectEditor\$allowed_editors, Xoops\Form\SelectEditor\$form, Xoops\Form\SelectEditor\$name, Xoops\Form\SelectEditor\$nohtml, Xoops\Form\SelectEditor\$value, XoopsLocaleEn_US\A_SELECT, and form.

Member Function Documentation

Xoops\Form\SelectEditor::render ( )

render

Returns
string

Definition at line 81 of file SelectEditor.php.

References Xoops\Form\SelectEditor\$allowed_editors, Xoops\Form\Element\$extra, Xoops\Form\ElementTray\addElement(), form, and XoopsEditorHandler\getInstance().

Here is the call graph for this function:

Member Data Documentation

Xoops\Form\SelectEditor::$allowed_editors = array()
Xoops\Form\SelectEditor::$form

Definition at line 35 of file SelectEditor.php.

Referenced by Xoops\Form\SelectEditor\__construct().

Xoops\Form\SelectEditor::$name

Definition at line 45 of file SelectEditor.php.

Referenced by Xoops\Form\SelectEditor\__construct().

Xoops\Form\SelectEditor::$nohtml

Definition at line 50 of file SelectEditor.php.

Referenced by Xoops\Form\SelectEditor\__construct().

Xoops\Form\SelectEditor::$value

Definition at line 40 of file SelectEditor.php.

Referenced by Xoops\Form\SelectEditor\__construct().


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