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

Element index for package Services_ReCaptcha

[ a ] [ b ] [ e ] [ g ] [ m ] [ o ] [ r ] [ s ] [ v ] [ _ ]

_

__construct
in file ReCaptcha.php, method Services_ReCaptcha::__construct()
    Constructor, you must pass a valid public and private API key.
__construct
in file MailHide.php, method Services_ReCaptcha_MailHide::__construct()
    Constructor, you must pass a valid public and private API key.
__construct
in file Exception.php, method Services_ReCaptcha_HTTPException::__construct()
    Constructor.
__construct
in file Base.php, method Services_ReCaptcha_Base::__construct()
    Constructor, you must pass a valid public and private API key, and optionnaly an array of options.
__toString
in file Base.php, method Services_ReCaptcha_Base::__toString()
    Returns the corresponding HTML code, this is a "magic" shortcut to the getHTML() method.
top

a

$apiPrivateKey
in file Base.php, variable Services_ReCaptcha_Base::$apiPrivateKey
    reCAPTCHA/reCAPTCHA Mailhide API private key.
$apiPublicKey
in file Base.php, variable Services_ReCaptcha_Base::$apiPublicKey
    reCAPTCHA/reCAPTCHA Mailhide API public key.
$apiSecureURL
in file ReCaptcha.php, variable Services_ReCaptcha::$apiSecureURL
    The reCAPTCHA API secure URL, this is URL is used by default when the script is running on an https host or when you force it via the 'secure' option.
$apiURL
in file ReCaptcha.php, variable Services_ReCaptcha::$apiURL
    The reCAPTCHA API URL.
$apiURL
in file MailHide.php, variable Services_ReCaptcha_MailHide::$apiURL
    Url of the reCATCHA MailHide API.
$apiURL
in file Base.php, variable Services_ReCaptcha_Base::$apiURL
    reCAPTCHA/reCAPTCHA Mailhide API URL.
$apiVerifyURL
in file ReCaptcha.php, variable Services_ReCaptcha::$apiVerifyURL
    Url of the ReCaptcha verify API.
top

b

Base.php
procedural page Base.php
top

e

$email
in file MailHide.php, variable Services_ReCaptcha_MailHide::$email
    The email address you want to "hide".
$error
in file ReCaptcha.php, variable Services_ReCaptcha::$error
    The error code used to display the error message in the captcha.
example-01.php
procedural page example-01.php
example-02.php
procedural page example-02.php
example-03.php
procedural page example-03.php
Exception.php
procedural page Exception.php
top

g

getEmail
in file MailHide.php, method Services_ReCaptcha_MailHide::getEmail()
    Returns the email to "hide".
getError
in file ReCaptcha.php, method Services_ReCaptcha::getError()
    Returns the current error code.
getHTML
in file ReCaptcha.php, method Services_ReCaptcha::getHTML()
    Returns the HTML code to insert into your form.
getHTML
in file Base.php, method Services_ReCaptcha_Base::getHTML()
    Returns the corresponding HTML code.
getHTML
in file MailHide.php, method Services_ReCaptcha_MailHide::getHTML()
    Returns the HTML code snippet that will hide your email.
getOption
in file Base.php, method Services_ReCaptcha_Base::getOption()
    Returns an option from Services_ReCaptcha::$options.
getOptions
in file Base.php, method Services_ReCaptcha_Base::getOptions()
    Returns the Services_ReCaptcha::$options array.
getRequest
in file ReCaptcha.php, method Services_ReCaptcha::getRequest()
    Returns the HTTP_Request2 instance, if it's not yet set it is instanciated on the fly.
getURL
in file ReCaptcha.php, method Services_ReCaptcha::getURL()
    Returns the URL of the script or iframe src attribute.
getURL
in file MailHide.php, method Services_ReCaptcha_MailHide::getURL()
    Returns the URL of the mailhide popup.
top

m

MailHide.php
procedural page MailHide.php
top

o

$options
in file ReCaptcha.php, variable Services_ReCaptcha::$options
    Options to customize the html, the url and the look and feel of the captcha.
$options
in file MailHide.php, variable Services_ReCaptcha_MailHide::$options
    Options to customize the apparence of the generated HTML and the corresponding popup window.
$options
in file Base.php, variable Services_ReCaptcha_Base::$options
    Array of options.
top

r

$request
in file ReCaptcha.php, variable Services_ReCaptcha::$request
    The HTTP_Request2 instance.
$response
in file Exception.php, variable Services_ReCaptcha_HTTPException::$response
    HTTP_Request2_Response instance.
ReCaptcha.php
procedural page ReCaptcha.php
top

s

Services_ReCaptcha
in file ReCaptcha.php, class Services_ReCaptcha
    PHP5 interface to the reCATCHA API.
Services_ReCaptcha_Base
in file Base.php, class Services_ReCaptcha_Base
    Base class for Services_ReCaptcha and Services_ReCaptcha_MailHide.
Services_ReCaptcha_Exception
in file Exception.php, class Services_ReCaptcha_Exception
    Base class for exceptions raised by the Services_ReCaptcha package.
Services_ReCaptcha_HTTPException
in file Exception.php, class Services_ReCaptcha_HTTPException
    Exception raised when an http error occurs.
Services_ReCaptcha_MailHide
in file MailHide.php, class Services_ReCaptcha_MailHide
    PHP5 interface to the reCATCHA MailHide API.
setEmail
in file MailHide.php, method Services_ReCaptcha_MailHide::setEmail()
    Sets the email to "hide" and returns the current Services_ReCaptcha_MailHide instance.
setError
in file ReCaptcha.php, method Services_ReCaptcha::setError()
    Sets the error code to display in the captcha and returns the current Services_ReCaptcha instance.
setOption
in file Base.php, method Services_ReCaptcha_Base::setOption()
    Sets an option in Services_ReCaptcha::$options and returns the current Services_ReCaptcha_Base instance.
setOptions
in file Base.php, method Services_ReCaptcha_Base::setOptions()
    Sets a number of options at once in Services_ReCaptcha::$options and returns the current Services_ReCaptcha_Base instance.
setRequest
in file ReCaptcha.php, method Services_ReCaptcha::setRequest()
    Sets the HTTP_Request2 instance and returns the current Services_ReCaptcha instance.
top

v

validate
in file ReCaptcha.php, method Services_ReCaptcha::validate()
    Validates the challenge response typed by the user and returns true if the challenge response is ok or false otherwise.
top

Documentation generated on Thu, 28 Apr 2011 21:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.