XOOPS  2.6.0
XoopsCaptcha Class Reference
Inheritance diagram for XoopsCaptcha:
Inheritance graph

Public Member Functions

 destroyGarbage ($clearSession=false)
 
 getCaption ()
 
 getMessage ()
 
 isActive ()
 
 loadBasicConfig ($filename= 'config')
 
 loadConfig ($name= 'config')
 
 loadForm ()
 
 loadHandler ($name=null)
 
 readConfig ($filename= 'config')
 
 render ()
 
 renderValidationJS ()
 
 setCode ($code=null)
 
 setConfig ($name, $val)
 
 setConfigs ($configs)
 
 verify ($skipMember=null, $name=null)
 
 writeConfig ($filename= 'config', $config)
 

Static Public Member Functions

static getInstance ()
 

Public Attributes

 $active
 
 $config = array()
 
 $configPath
 
 $handler
 
 $message = array()
 
 $name
 
 $path_basic
 
 $path_plugin
 

Protected Member Functions

 __construct ()
 

Detailed Description

Definition at line 28 of file xoopscaptcha.php.

Constructor & Destructor Documentation

XoopsCaptcha::__construct ( )
protected

construct

Definition at line 73 of file xoopscaptcha.php.

References $xoops_root_path, XoopsBaseConfig\get(), and loadConfig().

Here is the call graph for this function:

Member Function Documentation

XoopsCaptcha::destroyGarbage (   $clearSession = false)

Destory historical stuff

Parameters
bool$clearSession
Returns
bool

Definition at line 345 of file xoopscaptcha.php.

References $_SESSION, $config, and loadHandler().

Referenced by verify().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::getCaption ( )

XoopsCaptcha::getCaption()

Returns
string

Definition at line 323 of file xoopscaptcha.php.

References XoopsLocaleEn_US\CONFIRMATION_CODE.

static XoopsCaptcha::getInstance ( )
static

Get Instance

Returns
XoopsCaptcha

Definition at line 90 of file xoopscaptcha.php.

Referenced by Xcaptcha\__construct(), Xoops\Form\Captcha\__construct(), XoopsCaptchaImageHandler\__construct(), and Comments\displayPost().

Here is the caller graph for this function:

XoopsCaptcha::getMessage ( )

XoopsCaptcha::getMessage()

Returns
string

Definition at line 333 of file xoopscaptcha.php.

XoopsCaptcha::isActive ( )

XoopsCaptcha::isActive()

Returns
bool

Definition at line 178 of file xoopscaptcha.php.

References $active, $xoops, Xoops\getInstance(), and loadHandler().

Referenced by verify().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::loadBasicConfig (   $filename = 'config')

XoopsCaptcha::loadBasicConfig()

Parameters
string$filename
Returns
array

Definition at line 128 of file xoopscaptcha.php.

References $config, $file, and XoopsLoad\fileExists().

Referenced by loadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::loadConfig (   $name = 'config')

XoopsCaptcha::loadConfig()

Parameters
string$name
Returns
array

Definition at line 107 of file xoopscaptcha.php.

References $config, $name, loadBasicConfig(), readConfig(), and writeConfig().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::loadForm ( )

XoopsCaptcha::loadForm()

Returns
string

Definition at line 424 of file xoopscaptcha.php.

References $form, and setCode().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::loadHandler (   $name = null)

XoopsCaptcha::loadHandler()

Parameters
string$name
Returns
XoopsCaptchaMethod|null

Definition at line 207 of file xoopscaptcha.php.

References $file, $handler, $name, and XoopsLoad\fileExists().

Referenced by destroyGarbage(), and isActive().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::readConfig (   $filename = 'config')

XoopsCaptcha::readConfig()

Parameters
string$filename
Returns
array

Definition at line 151 of file xoopscaptcha.php.

References $file, and XoopsFile\getHandler().

Referenced by loadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

XoopsCaptcha::render ( )

XoopsCaptcha::render()

Returns
string

Definition at line 363 of file xoopscaptcha.php.

References $_SESSION, $config, $form, XoopsLocaleEn_US\E_TO_MANY_ATTEMPTS, and loadForm().

Here is the call graph for this function:

XoopsCaptcha::renderValidationJS ( )

XoopsCaptcha::renderValidationJS()

Returns
string

Definition at line 394 of file xoopscaptcha.php.

XoopsCaptcha::setCode (   $code = null)

XoopsCaptcha::setCode()

Parameters
mixed$code
Returns
bool

Definition at line 409 of file xoopscaptcha.php.

References $_SESSION, and $code.

Referenced by loadForm().

Here is the caller graph for this function:

XoopsCaptcha::setConfig (   $name,
  $val 
)

XoopsCaptcha::setConfig()

Parameters
mixed$name
mixed$val
Returns
bool

Definition at line 259 of file xoopscaptcha.php.

References $name.

Referenced by setConfigs().

Here is the caller graph for this function:

XoopsCaptcha::setConfigs (   $configs)

XoopsCaptcha::setConfigs()

Parameters
mixed$configs
Returns
bool

Definition at line 243 of file xoopscaptcha.php.

References $configs, and setConfig().

Here is the call graph for this function:

XoopsCaptcha::verify (   $skipMember = null,
  $name = null 
)

XoopsCaptcha::verify()

Verify user submission

Parameters
bool$skipMember
string$name
Returns
bool

Definition at line 279 of file xoopscaptcha.php.

References $_SESSION, $name, $xoops, destroyGarbage(), XoopsLocaleEn_US\E_INVALID_CONFIRMATION_CODE, XoopsLocaleEn_US\E_TO_MANY_ATTEMPTS, Xoops\getInstance(), and isActive().

Here is the call graph for this function:

XoopsCaptcha::writeConfig (   $filename = 'config',
  $config 
)

XoopsCaptcha::writeConfig()

Parameters
string$filename
array$config
Returns
array

Definition at line 166 of file xoopscaptcha.php.

References $config, $file, and XoopsFile\getHandler().

Referenced by loadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

XoopsCaptcha::$active

Definition at line 33 of file xoopscaptcha.php.

Referenced by isActive().

XoopsCaptcha::$config = array()

Definition at line 63 of file xoopscaptcha.php.

Referenced by destroyGarbage(), loadBasicConfig(), loadConfig(), render(), and writeConfig().

XoopsCaptcha::$configPath

Definition at line 53 of file xoopscaptcha.php.

XoopsCaptcha::$handler

Definition at line 38 of file xoopscaptcha.php.

Referenced by loadHandler().

XoopsCaptcha::$message = array()

Definition at line 68 of file xoopscaptcha.php.

XoopsCaptcha::$name
XoopsCaptcha::$path_basic

Definition at line 43 of file xoopscaptcha.php.

XoopsCaptcha::$path_plugin

Definition at line 48 of file xoopscaptcha.php.


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