Brian Cassidy > SRU > SRU::Request

Download:
SRU-1.01.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.01   Source  

NAME ^

SRU::Request - Factories for creating SRU request objects.

SYNOPSIS ^

    use SRU::Request;
    my $request = SRU::Request->newFromURI( $uri );

DESCRIPTION ^

SRU::Request allows you to create the appropriate SRU request object from a URI object. This allows you to pass in a URI and get back one of SRU::Request::Explain, SRU::Request::Scan or SRU::Request::SearchRetrieve depending on the type of URI that is passed in. See the docs for those classes for more information about what they contain.

METHODS ^

new( %query | $uri | $cgi | $env )

Create a new request object which is one of:

One can pass query parameters as hash, as URL, as URI, as CGI object or as PSGI request.

If the request is not formatted properly the call will return undef. The error encountered should be available in $SRU::Error.

newFromURI

newFromCGI

Deprecated aliases for new.

asXML()

Used to generate <echoedExplainRequest>, <echoedSearchRetrieveRequest> and <echoedScanRequest> elements in the response.

asURI( [ $base ] )

Creates a URI of this request. The optional base URL, provided as string or as URI, is set to http://localhost/ by default.

type()

Returns 'searchRetrieve', 'scan' or 'explain' depending on what type of object it is.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by Ed Summers.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: