Gdata/App/CaptchaRequiredException.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-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

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

>VConstant  ACCOUNTS_URL = 'https://www.google.com/accounts/'
The Google Accounts URL prefix.

Properties

>VPropertyprivatestring $captchaToken
The token identifier from the server.
Details
Type
string
>VPropertyprivatestring $captchaUrl
The URL of the CAPTCHA image.
Details
Type
string

Methods

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

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

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
methodpublic__construct(string $captchaToken, string $captchaUrl) : void

Constructs the exception to handle a CAPTCHA required response.

Parameters
NameTypeDescription
$captchaTokenstring

The CAPTCHA token ID provided by the server.

$captchaUrlstring

The URL to the CAPTCHA challenge image.

methodpublic__toString() : string
Returns
TypeDescription
string
methodprotected_getPrevious() : \Exception | null
Returns
TypeDescription
\Exception | null
methodpublicgetCaptchaToken() : string

Retrieves the token identifier as provided by the server.

Returns
TypeDescription
string
methodpublicgetCaptchaUrl() : string

Retrieves the URL CAPTCHA image as provided by the server.

Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.