/ 
Net-Google-1.0
River stage one • 2 direct dependents • 2 total dependents
/ Net::Google::Spelling

NAME

Net::Google::Spelling - simple OOP-ish interface to the Google SOAP API for spelling suggestions

SYNOPSIS

use Net::Google::Spelling;
my $spelling = Net::Google::Spelling(\%args);

$spelling->phrase("muntreal qweebec");
print $spelling->suggest()."\n";

DESCRIPTION

Provides a simple OOP-ish interface to the Google SOAP API for spelling suggestions.

This package is used by Net::Google.

PACKAGE METHODS

$pkg = __PACKAGE__->new(\%args)

Valid arguments are :

  • key

    string.A Google API key.

    If none is provided then the key passed to the parent Net::Google object will be used.

  • phrase

    string or array reference.

  • http_proxy

    url. A URL for proxy-ing HTTP requests.

  • debug

    Valid options are:

    • boolean

      If true prints debugging information returned by SOAP::Lite to STDERR

    • coderef.

      Your own subroutine for munging the debugging information returned by SOAP::Lite.

The object constructor in Net::Google 0.53, and earlier, expected a GoogleSearchService object as its first argument followed by a hash reference of argument. Versions 0.6 and higher are backwards compatible.

Returns an object. Woot!

OBJECT METHODS

$obj->key($string)

Get/set the Google API key for this object.

$obj->http_proxy($url)

Get/set the HTTP proxy for this object.

Returns a string.

$obj->phrase(@words)

Add one or more words to the phrase you want to spell-check.

If the first item in @words is empty, then any existing phrase data will be removed before the new data is added.

Returns a string. Returns undef if there was an error.

$obj->suggest()

Fetch the spelling suggestion from the Google servers.

Returns a string. Returns undef if there was an error.

$obj->queries_exhausted()

Returns true or false depending on whether or not the current in-memory session has exhausted the Google API 1000 query limit.

VERSION

1.0

DATE

$Date: 2005/03/26 20:49:03 $

AUTHOR

Aaron Straup Cope

SEE ALSO

Net::Google

LICENSE

Copyright (c) 2002-2005, Aaron Straup Cope. All Rights Reserved.

This is free software, you may use it and distribute it under the same terms as Perl itself.