Docs For Class Picasa_Exception_CaptchaRequiredException

Description

Indicates that Google issued a CAPTCHA challenge when the client was attempting to login a user.

Once this exception is caught, display the image from the $captchaUrl field to the user, as well as an input field. Instruct the user to type the letters that appear in the image into the input field. Once the user submits the letters, do the login attempt once again, supplying the value of $captchaToken and the user's submitted text.

author: Cameron Hinkle
version: Version 3.0
copyright: Copyright (c) 2007 Cameron Hinkle
see: Picasa::authorizeWithClientLogin()
link: http://code.google.com/support/bin/answer.py?answer=55815&topic=10954
since: Version 3.0
license: GNU Public License Version 3

Located in /Picasa/Exception/CaptchaRequiredException.php (line 20)

Exception
   |
   --Picasa_Exception
      |
      --Picasa_Exception_CaptchaRequiredException

Variable Summary

string $captchaPath

string $captchaToken

string $captchaUrl

string $emailAddress

string $password

Method Summary

Picasa_Exception_CaptchaRequiredException __construct (string $message, $url, string $emailAddress, string $password, string $captchaToken, string $captchaUrl, $response, [ $code = 0])

string getCaptchaPath ()

string getCaptchaToken ()

string getCaptchaUrl ()

string getEmailAddress ()

string getPassword ()

string __toString ()

Variables

string $captchaPath (line 45)

The path of the CAPTCHA URL, without the server name at the beginning. This field may be useless.

access: private

string $captchaToken (line 29)

The token supplied by Google, which is used by their servers to determine which image the captcha response is in response to.

access: private

string $captchaUrl (line 37)

The URL of the image that contains the challenge.

access: private

string $emailAddress (line 54)

The email address of the user who was attempting to login when this CAPTCHA challenge was issued.

This is to make it easy to retry the login once the user has responded to the challenge.

access: private

string $password (line 64)

The password that the user entered when they recieved the challenge.

This is so that the user does not have to retype his password.

access: private

Inherited Variables

Inherited from Picasa_Exception

Picasa_Exception::$response
Picasa_Exception::$url

Methods

Constructor __construct (line 131)

Constructs the exception.

access: public

Picasa_Exception_CaptchaRequiredException __construct (string $message, $url, string $emailAddress, string $password, string $captchaToken, string $captchaUrl, $response, [ $code = 0])

string $message: The error message.
string $emailAddress: The email address of the user who was attempting to login when this CAPTCHA challenge was issued.
string $password: The password that the user entered when they recieved the challenge.
string $captchaToken: The token supplied by Google.
string $captchaUrl: The URL of the image that contains the challenge.
$url
$response
$code

Redefinition of:

Picasa_Exception::__construct(): Constructs a Picasa_Exception object.

getCaptchaPath (line 83)