icms_form_elements_captcha_Object

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_form_elements_captcha_Object

Creates the captcha object

• Class name: icms_form_elements_captcha_Object
• Namespace:

Properties

$active

public mixed $active = \true

• Visibility: public

$mode

public mixed $mode = text

potential values: image, text

• Visibility: public

$config

public mixed $config = array()

• Visibility: public

$message

public mixed $message = array()

Logging error messages

• Visibility: public

Methods

__construct

mixed icms_form_elements_captcha_Object::__construct()

Constructor

• Visibility: public

setMode

mixed icms_form_elements_captcha_Object::setMode(string mode)

Set CAPTCHA mode

For future possible modes, right now force to use text or image

• Visibility: public

Arguments

• mode string - <p>if no mode is set, just verify current mode</p>

instance

object icms_form_elements_captcha_Object::instance()

Creates instance of icms_form_elements_captcha_Object Object

• Visibility: public
• This method is static.

setConfig

bool icms_form_elements_captcha_Object::setConfig(string name, string val)

Sets the Captcha Config

• Visibility: public

Arguments

• name string - <p>Config Name</p>
• val string - <p>Config Value</p>

init

mixed icms_form_elements_captcha_Object::init(string name, string skipmember, string num_chars, string fontsize_min, string fontsize_max, string background_type, string background_num)

Initializing the CAPTCHA class

• Visibility: public

Arguments

• name string - <p>name of the instance</p>
• skipmember string - <p>Skip the captcha because the user is member / logged in</p>
• num_chars string - <p>comes from config, just initializes the variable</p>
• fontsize_min string - <p>comes from config, just initializes the variable</p>
• fontsize_max string - <p>comes from config, just initializes the variable</p>
• background_type string - <p>comes from config, just initializes the variable</p>
• background_num string - <p>comes from config, just initializes the variable</p>

verify

mixed icms_form_elements_captcha_Object::verify(bool skipMember)

Verify user submission

• Visibility: public

Arguments

• skipMember bool - <p>Skip Captcha because user is member / logged in</p>

destroyGarbage

bool icms_form_elements_captcha_Object::destroyGarbage(bool clearSession)

Destory historical stuff

• Visibility: public

Arguments

• clearSession bool - <p>also clear session variables?</p>

getCaption

string icms_form_elements_captcha_Object::getCaption()

Get Caption

• Visibility: public

getMessage

string icms_form_elements_captcha_Object::getMessage()

Set Message

• Visibility: public

render

string icms_form_elements_captcha_Object::render()

Render

• Visibility: public

loadForm

string icms_form_elements_captcha_Object::loadForm()

Load Form

• Visibility: public