CaptchaManager Class Reference

Provides a central management class for event handlers and common functionality for the captcha component. More...

Public Member Functions
	CaptchaManager ()
	addCaptchaToForm ($form)

Static Public Member Functions
static	registerCaptchaProvider ($name, $class)
static	setDefaults ()
static	registerSettingsFormExtension ()
static	settingsExtension ($form)

Static Public Attributes
static	$providers = array()

Detailed Description

Provides a central management class for event handlers and common functionality for the captcha component.

Definition at line 13 of file captcha_manager.inc.

Member Function Documentation

addCaptchaToForm()

CaptchaManager::addCaptchaToForm

(

$form

)

Definition at line 22 of file captcha_manager.inc.

     {
          $provider = Settings::getValue("captcha", "captcha_provider");
          if (!$provider) return;
          
          $renderer = new $provider($form);       
     }

CaptchaManager()

CaptchaManager::CaptchaManager

(

)

Definition at line 17 of file captcha_manager.inc.

     {
          ComponentManager::fireEvent("RegisterCaptchaProvider");
     }

registerCaptchaProvider()

static CaptchaManager::registerCaptchaProvider (   $name,   $class  )

static

Definition at line 30 of file captcha_manager.inc.

     {
          CaptchaManager::$providers[$class] = $name;
     }

registerSettingsFormExtension()

static CaptchaManager::registerSettingsFormExtension ( )

static

Definition at line 40 of file captcha_manager.inc.

     {
          SettingsManager::registerExtension("captcha", array(CaptchaManager, settingsExtension));       
     }

setDefaults()

static CaptchaManager::setDefaults ( )

static

Definition at line 35 of file captcha_manager.inc.

     {
          Settings::setDefaultValue("captcha", "captcha_provider", "", String, "Select the Captcha provider to use on your site", "CAPTCHA Provider");
     }

settingsExtension()

static CaptchaManager::settingsExtension (   $form )

static

Definition at line 45 of file captcha_manager.inc.

     {
          $mgr = new CaptchaManager();
          $providerSelect = new SelectFieldRenderer($form, "captcha_provider", "Captcha Provider", CaptchaManager::$providers);
          $providerSelect->defaultBlank = true;
     }

Member Data Documentation

$providers

CaptchaManager::$providers = array()

static

Definition at line 15 of file captcha_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/captcha/captcha_manager.inc