HTML_QuickForm2_Captcha
[ class tree: HTML_QuickForm2_Captcha ] [ index: HTML_QuickForm2_Captcha ] [ all elements ]

Class: HTML_QuickForm2_Element_Captcha_ReCaptcha

Source Location: /HTML_QuickForm2_Captcha-0.1.2/HTML/QuickForm2/Element/Captcha/ReCaptcha.php

Class Overview

HTML_QuickForm2_Element_Input
   |
   --HTML_QuickForm2_Element_Captcha
      |
      --HTML_QuickForm2_Element_Captcha_ReCaptcha

Captcha element utilizing the ReCaptcha service.


Author(s):

Version:

  • Release: 0.1.2

Variables

Methods


Inherited Variables

Inherited Methods

Class: HTML_QuickForm2_Element_Captcha

HTML_QuickForm2_Element_Captcha::__construct()
Create new instance.
HTML_QuickForm2_Element_Captcha::clearCaptchaSession()
Destroys all captcha session data, so that the previously solved captcha re-appears as unsolved. Question and answers are discarded as well.
HTML_QuickForm2_Element_Captcha::generateCaptcha()
Prepares the session data for the captcha.
HTML_QuickForm2_Element_Captcha::getCaptchaHtml()
Returns the HTML for the captcha (question + input element if applicable)
HTML_QuickForm2_Element_Captcha::getSession()
Returns the captcha session object
HTML_QuickForm2_Element_Captcha::getSessionVarName()
Returns the name to use for the session variable.
HTML_QuickForm2_Element_Captcha::getType()
Returns the CAPTCHA type.
HTML_QuickForm2_Element_Captcha::getValue()
Returns the captcha answer input element value.
HTML_QuickForm2_Element_Captcha::setSession()
Sets a new session object.
HTML_QuickForm2_Element_Captcha::setValue()
Sets the input value
HTML_QuickForm2_Element_Captcha::validate()
Performs the server-side validation.
HTML_QuickForm2_Element_Captcha::verifyCaptcha()
Checks if the captcha is solved now.
HTML_QuickForm2_Element_Captcha::__toString()
Renders the captcha into a HTML string

Class Details

[line 36]
Captcha element utilizing the ReCaptcha service.

In case you need to change ReCaptcha settings, use getReCaptcha() and modify the resulting Services_ReCaptcha object.



[ Top ]


Class Variables

$reCaptcha =  null

[line 44]

ReCaptcha instance
  • Access: protected

Type:   Services_ReCaptcha


[ Top ]



Method Detail

getCaptchaHtml   [line 97]

string getCaptchaHtml( )

Returns the HTML containing the ReCaptcha element.

Used in __toString() and to be used when $data['captchaRender'] is set to false. It is not called when the element is frozen, see getFrozenHtml() for that case. This method is also not called when the captcha has been solved, since $data['captchaSolved'] is shown then.

  • Return: HTML code
  • Access: public

Overrides HTML_QuickForm2_Element_Captcha::getCaptchaHtml() (Returns the HTML for the captcha (question + input element if applicable))
[ Top ]

getReCaptcha   [line 108]

Services_ReCaptcha getReCaptcha( )

Returns the Services_ReCaptcha instance.

May be used to configure the ReCaptcha settings.

  • Return: ReCaptcha instance
  • Access: public

[ Top ]

verifyCaptcha   [line 51]

boolean verifyCaptcha( )

Checks if the captcha is solved now.
  • Return: True if the captcha is solved, false if not.
  • Access: protected

Overrides HTML_QuickForm2_Element_Captcha::verifyCaptcha() (Checks if the captcha is solved now.)
[ Top ]


Documentation generated on Mon, 04 Nov 2013 14:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.