Class icms_form_elements_captcha_Object

Creates the captcha object

Package: Form\Elements
Category: ICMS
Copyright: The XOOPS project http://www.xoops.org/
License: GNU public license
Author: modified by Sina Asghari (aka stranger) pesian_stranger@users.sourceforge.net
Located at form/elements/captcha/Object.php

Methods summary
`public`	# `__construct( )` Constructor Constructor
`public static object &`	# `instance( )` Creates instance of icms_form_elements_captcha_Object Object Creates instance of icms_form_elements_captcha_Object Object Returns object Reference to the icms_form_elements_captcha_Object Object
`public boolean`	# `setConfig( string $name, string $val )` Sets the Captcha Config Sets the Captcha Config Parameters `$name` Config Name `$val` Config Value Returns boolean Always returns true if the setting of the config has succeeded
`public`	# `setMode( string $mode = NULL )` Set CAPTCHA mode Set CAPTCHA mode For future possible modes, right now force to use text or image Parameters `$mode` if no mode is set, just verify current mode
`public`	# `init( string $name = 'icmscaptcha', string $skipmember = NULL, string $num_chars = NULL, string $fontsize_min = NULL, string $fontsize_max = NULL, string $background_type = NULL, string $background_num = NULL )` Initializing the CAPTCHA class Initializing the CAPTCHA class Parameters `$name` name of the instance `$skipmember` Skip the captcha because the user is member / logged in `$num_chars` comes from config, just initializes the variable `$fontsize_min` comes from config, just initializes the variable `$fontsize_max` comes from config, just initializes the variable `$background_type` comes from config, just initializes the variable `$background_num` comes from config, just initializes the variable
`public`	# `verify( boolean $skipMember = NULL )` Verify user submission Verify user submission Parameters `$skipMember` Skip Captcha because user is member / logged in
`public string`	# `getCaption( )` Get Caption Get Caption Returns string The Caption Constant
`public string`	# `getMessage( )` Set Message Set Message Returns string The message
`public boolean`	# `destroyGarbage( boolean $clearSession = FALSE )` Destory historical stuff Destory historical stuff Parameters `$clearSession` also clear session variables? Returns boolean True if destroying succeeded
`public string`	# `render( )` Render Render Returns string the rendered form
`public string`	# `loadForm( )` Load Form Load Form Returns string The Loaded Captcha Form

Properties summary
`public boolean`	`$active`	# `TRUE`
`public string`	`$mode` potential values: image, text potential values: image, text	# `"text"`
`public array`	`$config`	# `array()`
`public array`	`$message` Logging error messages Logging error messages	# `array()`

Packages

Classes

Class icms_form_elements_captcha_Object

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns