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

Public Member Functions

 __construct ($caption= '', $name= 'xoopscaptcha', $skipmember=true, $configs=array())
 
 render ()
 
 renderValidationJS ()
 
 setConfig ($name, $val)
 
- 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

 $captchaHandler
 
- Public Attributes inherited from Xoops\Form\Element
 $customValidationCode = array()
 

Additional Inherited Members

- Protected Attributes inherited from Xoops\Form\Element
 $value = ''
 
- Protected Attributes inherited from Xoops\Html\Attributes
 $attributes = array()
 

Detailed Description

Definition at line 40 of file Captcha.php.

Constructor & Destructor Documentation

Xoops\Form\Captcha::__construct (   $caption = '',
  $name = 'xoopscaptcha',
  $skipmember = true,
  $configs = array() 
)

__construct

Parameters
string$captionCaption of the form element, default value is defined in captcha/language/
string$nameName for the input box
boolean$skipmemberSkip CAPTCHA check for members
array$configskey/value pairs

Definition at line 55 of file Captcha.php.

References Xoops\Form\Element\$caption, $configs, $name, XoopsCaptcha\getInstance(), Xoops\Form\Element\setCaption(), Xoops\Form\Element\setHidden(), and Xoops\Form\Element\setName().

Here is the call graph for this function:

Member Function Documentation

Xoops\Form\Captcha::render ( )

render

Returns
string

Definition at line 89 of file Captcha.php.

Xoops\Form\Captcha::renderValidationJS ( )

renderValidationJS

Returns
string

Definition at line 99 of file Captcha.php.

Xoops\Form\Captcha::setConfig (   $name,
  $val 
)

setConfig

Parameters
type$namename
type$valvalue
Returns
boolean

Definition at line 79 of file Captcha.php.

References $name.

Member Data Documentation

Xoops\Form\Captcha::$captchaHandler

Definition at line 45 of file Captcha.php.


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