NAME

Net::Trackback::Ping - an object representing a Trackback ping.

SYNOPSIS

use Net::Trackback::Client;
use Net::Trackback::Ping;
my $ping = Net::Trackback::Ping->new();
$ping->title('Net::Trackback Test');
$ping->url('http://search.cpan.org/search?query=Trackback');
$ping->ping_url('http://www.movabletype.org/mt/trackback/62');
my $client = Net::Trackback::Client->new();
my $msg = $client->send_ping($ping);
print $msg->to_xml;

METHODS

Net::Trackback::Ping->new([$hashref])

Constuctor method. It will initialize the object if passed a hash reference. Recognized keys are url, ping_url, id, title, excerpt, and blogname. These keys correspond to the methods like named methods.

Net::Trackback::Ping->parse($CGI)

A method that extracts ping data from an HTTP request and returns a ping object. In the event a bad ping has been passed in the method will return undef. USe the errstr method to retrieve the error message. One required parameter, a reference to a CGI object or some other that has a param method that works just like it. See the list of recognized keys in the new method.

$ping->url([$url])

Accessor to a resource URL. Passing in an optional string parameter sets the value. This value is required to make a ping.

$ping->ping_url([$url])

Accessor to the URL to ping with the resource's Trackback information. Passing in an optional string parameter sets the value. This value is required to make a ping.

$ping->id([$id])

Accessor to the remote resource ID that is to be pinged. Passing in an optional string parameter sets the value.

$ping->title([$title])

Accessor to the title of resource that is to be pinged. Passing in an optional string parameter sets the value.

$ping->excerpt([$excerpt]);

A brief plain text description of the resource at the other end of the url. Passing in an optional string parameter sets the value.

NOTE: While the Trackback specification doesn't specify a limit to the size of an excerpt, some implementations do. For instance as of Movable Type 3.14, Trackback excerpts cannot exceed 255 characters.

$ping->blog_name([$source]);

Accessor to the source of the ping. Passing in an optional string parameter sets the value.

$ping->to_hash

Returns a hash of the object's current state.

$ping->to_urlencoded

Returns a URL encoded string of the object's current state.

Errors

This module is a subclass of Class::ErrorHandler and inherits two methods for passing error message back to a caller.

Class->error($message)

$object->error($message)

Sets the error message for either the class Class or the object $object to the message $message. Returns undef.

Class->errstr

$object->errstr

Accesses the last error message set in the class Class or the object $object, respectively, and returns that error message.

AUTHOR & COPYRIGHT

Please see the Net::Trackback manpage for author, copyright, and license information.