Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SRU::Request(3)	      User Contributed Perl Documentation      SRU::Request(3)

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:

       o   SRU::Request::Explain

       o   SRU::Request::Scan

       o   SRU::Request::SearchRetrieve

       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.

perl v5.32.0			  2013-10-18		       SRU::Request(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=SRU::Request&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help