API Documentation

Gdata/App/CaptchaRequiredException.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
App  
version
$Id: CaptchaRequiredException.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Gdata_App_CaptchaRequiredException

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.

Extends from
\Zend_Gdata_App_AuthException
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
App  

Constants

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

The Google Accounts URL prefix.

Properties

Propertyprivatestring  $captchaToken= ''

The token identifier from the server.

Details
Type
string
Propertyprivatestring  $captchaUrl= ''

The URL of the CAPTCHA image.

Details
Type
string

Methods

methodpublic__call( string $method, array $args ) : mixed

Overloading

Inherited from: \Zend_Exception::__call()

For PHP < 5.3.0, provides access to the getPrevious() method.

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__construct( string $captchaToken, string $captchaUrl ) : void

Constructs the exception to handle a CAPTCHA required response.

Parameters
Name Type Description
$captchaToken string The CAPTCHA token ID provided by the server.
$captchaUrl string The URL to the CAPTCHA challenge image.
methodpublic__toString( ) : string

String representation of the exception

Inherited from: \Zend_Exception::__toString()
Returns
Type Description
string
methodprotected_getPrevious( ) : \Exception|null

Returns previous Exception

Inherited from: \Zend_Exception::_getPrevious()
Returns
Type Description
\Exceptionnull
methodpublicgetCaptchaToken( ) : string

Retrieves the token identifier as provided by the server.

Returns
Type Description
string
methodpublicgetCaptchaUrl( ) : string

Retrieves the URL CAPTCHA image as provided by the server.

Returns
Type Description
string
methodpublicgetCode( ) : void
final

Inherited from:
methodpublicgetFile( ) : void
final

Inherited from:
methodpublicgetLine( ) : void
final

Inherited from:
methodpublicgetMessage( ) : void
final

Inherited from:
methodpublicgetPrevious( ) : void
final

Inherited from:
methodpublicgetTrace( ) : void
final

Inherited from:
methodpublicgetTraceAsString( ) : void
final

Inherited from:
Documentation was generated by DocBlox 0.13.3.