Docs For Class ImagesToText

Description

Images To Text HTTP API Client

see: ImagesToText_Client

ImagesToText_Client
   |
   --ImagesToText_HttpClient

Class Constant Summary

BASE_URL = 'http://api.imagestotext.com/api'

Variable Summary

mixed $_conn

mixed $_response_parser

mixed $_response_type

Method Summary

ImagesToText_HttpClient __construct ( $username, $password)

void close ()

void get_captcha ( $cid)

void get_user ()

void report ( $cid)

void upload ( $captcha)

array|null _call (string $cmd, [array $payload = null])

void _connect ()

Variables

mixed $_conn = null (line 321)

access: protected

mixed $_response_parser = null (line 323)

access: protected

mixed $_response_type = '' (line 322)

access: protected

Inherited Variables

Inherited from ImagesToText_Client

ImagesToText_Client::$is_verbose
ImagesToText_Client::$_userpwd

Methods

Constructor __construct (line 435)

see: ImagesToText_Client::__construct()
access: public

ImagesToText_HttpClient __construct ( $username, $password)

$username
$password

Redefinition of:

ImagesToText_Client::__construct()

close (line 455)

see: ImagesToText_Client::close()
access: public

void close ()

Redefinition of:

ImagesToText_Client::close(): Closes opened connection (if any), as gracefully as possible

get_captcha (line 512)

see: ImagesToText_Client::get_captcha()
access: public

void get_captcha ( $cid)

$cid

Redefinition of:

ImagesToText_Client::get_captcha(): Returns CAPTCHA details

get_user (line 470)

see: ImagesToText_Client::get_user()
access: public

void get_user ()

Redefinition of:

ImagesToText_Client::get_user(): Returns user details

report (line 525)

see: ImagesToText_Client::report()
access: public

void report ( $cid)

$cid

Redefinition of:

ImagesToText_Client::report(): Reports an incorrectly solved CAPTCHA

upload (line 484)

see: ImagesToText_Client::upload()
throws: ImagesToText_RuntimeException When failed to save CAPTCHA image to a temporary file
access: public

void upload ( $captcha)

$captcha

Redefinition of:

ImagesToText_Client::upload(): Uploads a CAPTCHA

_call (line 371)

Makes an API call

return: API response hash table on success
throws: ImagesToText_IOException On network related errors
throws: ImagesToText_ServerException On API server errors
throws: ImagesToText_AccessDeniedException On failed login attempt
throws: ImagesToText_InvalidCaptchaException On invalid CAPTCHAs rejected by the service
access: protected

array|null _call (string $cmd, [array $payload = null])

string $cmd: API command
array $payload: API call payload, essentially HTTP POST fields

_connect (line 329)

Sets up CURL connection

access: protected

void _connect ()

Inherited Methods

Inherited From ImagesToText_Client

ImagesToText_Client::__construct()
ImagesToText_Client::close()
ImagesToText_Client::decode()
ImagesToText_Client::get_balance()
ImagesToText_Client::get_captcha()
ImagesToText_Client::get_text()
ImagesToText_Client::get_user()
ImagesToText_Client::parse_json_response()
ImagesToText_Client::parse_plain_response()
ImagesToText_Client::report()
ImagesToText_Client::upload()
ImagesToText_Client::_is_valid_captcha()
ImagesToText_Client::_load_captcha()

Class Constants

BASE_URL = 'http://api.imagestotext.com/api' (line 318)

Inherited Constants

Inherited from ImagesToText_Client

ImagesToText_Client::API_VERSION
ImagesToText_Client::DEFAULT_TIMEOUT
ImagesToText_Client::POLLS_INTERVAL

Class ImagesToText_HttpClient

Inherited Variables

Inherited Methods

Inherited Constants