Gdata/App/CaptchaRequiredException.php

Show: inherited

• Classes
  • \Zend_Gdata_App_CaptchaRequiredException

Table of Contents

Category

Zend  

Copyright

Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  

License

New BSD License  

Package

Zend_Gdata  

Subpackage

App  

Version

$Id: CaptchaRequiredException.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_App_CaptchaRequiredException

jump to top

Package: Zend\Gdata\App

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.

Parent(s)

\Zend_Gdata_App_AuthException < \Zend_Gdata_App_Exception < \Zend_Exception < \Exception

Category

Zend  

Copyright

Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  

License

New BSD License  

Constants

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

The Google Accounts URL prefix.

Properties

null|\Exception $_previous = null

inherited

Inherited from: \Zend_Exception::$$_previous\Zend_Gdata_App_Exception::$$_previous\Zend_Gdata_App_AuthException::$$_previous

Default valuenullDetails

Type

null | \Exception

Inherited_from

\Zend_Exception::$$_previous  

Inherited_from

\Zend_Gdata_App_Exception::$$_previous  

Inherited_from

\Zend_Gdata_App_AuthException::$$_previous  

string $captchaToken =

The token identifier from the server.

Details

Type

string

string $captchaUrl =

The URL of the CAPTCHA image.

Details

Type

string

Methods

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

inherited

Overloading

Inherited from: \Zend_Exception::__call()\Zend_Gdata_App_Exception::__call()\Zend_Gdata_App_AuthException::__call()

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

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

__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.

__toString() : string

inherited

String representation of the exception

Inherited from: \Zend_Exception::__toString()\Zend_Gdata_App_Exception::__toString()\Zend_Gdata_App_AuthException::__toString()

Returns

Type	Description
string

_getPrevious() : \Exception | null

inherited

Returns previous Exception

Inherited from: \Zend_Exception::_getPrevious()\Zend_Gdata_App_Exception::_getPrevious()\Zend_Gdata_App_AuthException::_getPrevious()

Returns

Type	Description
\Exception | null

getCaptchaToken() : string

Retrieves the token identifier as provided by the server.

Returns

Type	Description
string

getCaptchaUrl() : string

Retrieves the URL CAPTCHA image as provided by the server.

Returns

Type	Description
string

getCode() : void

finalinherited

Inherited from: \Zend_Exception::getCode()\Zend_Gdata_App_Exception::getCode()\Zend_Gdata_App_AuthException::getCode()

getFile() : void

finalinherited

Inherited from: \Zend_Exception::getFile()\Zend_Gdata_App_Exception::getFile()\Zend_Gdata_App_AuthException::getFile()

getLine() : void

finalinherited

Inherited from: \Zend_Exception::getLine()\Zend_Gdata_App_Exception::getLine()\Zend_Gdata_App_AuthException::getLine()

getMessage() : void

finalinherited

Inherited from: \Zend_Exception::getMessage()\Zend_Gdata_App_Exception::getMessage()\Zend_Gdata_App_AuthException::getMessage()

getPrevious() : void

finalinherited

Inherited from: \Zend_Exception::getPrevious()\Zend_Gdata_App_Exception::getPrevious()\Zend_Gdata_App_AuthException::getPrevious()

getTrace() : void

finalinherited

Inherited from: \Zend_Exception::getTrace()\Zend_Gdata_App_Exception::getTrace()\Zend_Gdata_App_AuthException::getTrace()

getTraceAsString() : void

finalinherited

Inherited from: \Zend_Exception::getTraceAsString()\Zend_Gdata_App_Exception::getTraceAsString()\Zend_Gdata_App_AuthException::getTraceAsString()