API Documentation

Gdata/App/CaptchaRequiredException.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
App
version
$Id: CaptchaRequiredException.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_App_CaptchaRequiredException

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Gdata_App_CaptchaRequiredException
jump to top

Extends from
Zend_Gdata_App_AuthException
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
App
Constants
ACCOUNTS_URL
Properties
$captchaToken
$captchaUrl
Methods
__construct
getCaptchaToken
getCaptchaUrl

Description

Gdata exceptions

Class to represent an exception that occurs during the use of ClientLogin. This particular exception happens when a CAPTCHA challenge is issued. This challenge is a visual puzzle presented to the user to prove that they are not an automated system.

Constants

ACCOUNTS_URL
jump to class

 ACCOUNTS_URL = 'https://www.google.com/accounts/'

The Google Accounts URL prefix.

Details

value
https://www.google.com/accounts/

Properties

$captchaToken
jump to class

string $captchaToken = ''

The token identifier from the server.

Details

$captchaToken
string
visibility
private
default
final
false
static
false

$captchaUrl
jump to class

string $captchaUrl = ''

The URL of the CAPTCHA image.

Details

$captchaUrl
string
visibility
private
default
final
false
static
false

Methods

__construct
jump to class

__construct( string $captchaToken, string $captchaUrl ) :

Constructs the exception to handle a CAPTCHA required response.

Arguments
$captchaToken
string
The CAPTCHA token ID provided by the server.
$captchaUrl
string
The URL to the CAPTCHA challenge image.
Details
visibility
public
final
false
static
false

getCaptchaToken
jump to class

getCaptchaToken( ) : string

Retrieves the token identifier as provided by the server.

Output
string
Details
visibility
public
final
false
static
false

getCaptchaUrl
jump to class

getCaptchaUrl( ) : string

Retrieves the URL CAPTCHA image as provided by the server.

Output
string
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.