icms_form_elements_Captcha

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

icms_form_elements_Captcha

CAPTCHA form element

Usage

For form creation: Add form element where proper: $form->addElement(new icms_form_elements_Captcha($caption, $name, $skipmember, ...);

For verification: $icmsCaptcha = icms_form_elements_captcha_Object::instance(); if (!$icmsCaptcha->verify()) { echo $icmsCaptcha->getMessage(); ... }

• Class name: icms_form_elements_Captcha
• Namespace:
• Parent class: icms_form_Element

Properties

$_captchaHandler

private mixed $_captchaHandler

• Visibility: private

Methods

__construct

mixed icms_form_elements_Captcha::__construct(string caption, string name, bool skipmember, int numchar, int minfontsize, int maxfontsize, int backgroundtype, int backgroundnum)

• Visibility: public

Arguments

• caption string - <p>Caption of the form element, default value is defined in captcha/language/</p>
• name string - <p>Name for the input box</p>
• skipmember bool - <p>Skip CAPTCHA check for members</p>
• numchar int - <p>Number of characters in image mode, and input box size for text mode</p>
• minfontsize int - <p>Minimum font-size of characters in image mode</p>
• maxfontsize int - <p>Maximum font-size of characters in image mode</p>
• backgroundtype int - <p>Background type in image mode: 0 - bar; 1 - circle; 2 - line; 3 - rectangle; 4 - ellipse; 5 - polygon; 100 - generated from files</p>
• backgroundnum int - <p>Number of background images in image mode</p>

setConfig

\icms_form_elements_captcha_Object icms_form_elements_Captcha::setConfig(string name, string val)

Sets the Config

• Visibility: public

Arguments

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

render

mixed icms_form_elements_Captcha::render()

• Visibility: public