Peter Karman > Search-OpenSearch > Search::OpenSearch::Response::XML

Download:
Search-OpenSearch-0.407.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.407   Source  

NAME ^

Search::OpenSearch::Response::XML - provide search results in XML format

SYNOPSIS ^

 use Search::OpenSearch;
 my $engine = Search::OpenSearch->engine(
    type    => 'KSx',
    index   => [qw( path/to/index1 path/to/index2 )],
    facets  => {
        names       => [qw( color size flavor )],
        sample_size => 10_000,
    },
    fields  => [qw( color size flavor )],
 );
 my $response = $engine->search(
    q           => 'quick brown fox',   # query
    s           => 'score desc',        # sort order
    o           => 0,                   # offset
    p           => 25,                  # page size
    h           => 1,                   # highlight query terms in results
    c           => 0,                   # return count stats only (no results)
    L           => 'field|low|high',    # limit results to inclusive range
    f           => 1,                   # include facets
    r           => 1,                   # include results
    format      => 'XML',               # or JSON
 );
 print $response;

DESCRIPTION ^

Search::OpenSearch::Response::XML serializes to XML following the OpenSearch specification at http://www.opensearch.org/Specifications/OpenSearch/1.1.

METHODS ^

This class is a subclass of Search::OpenSearch::Response. Only new or overridden methods are documented here.

stringify

Returns the Response in XML format.

Response objects are overloaded to call stringify().

content_type

Returns appropriate MIME type for the format returned by stringify().

AUTHOR ^

Peter Karman, <karman at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-search-opensearch at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Search-OpenSearch. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Search::OpenSearch::Response

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2010 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: