Peter Karman

NAME

Search::OpenSearch::FeedParser - parse Search::OpenSearch::Response::XML

SYNOPSIS

 use Search::OpenSearch::FeedParser;
 my $parser = Search::OpenSearch::FeedParser->new();
 my $feed = $parser->parse( $sos_response );

DESCRIPTION

Search::OpenSearch::FeedParser is the client parser for Search::OpenSearch::Response::XML. It is similar in concept to WWW::OpenSearch but because the SOS::Response::XML format is a superset of the OpenSearch standard, this module implements a different API.

METHODS

new( args )

Instantiate a new FeedParser object. You can re-use a single FeedParser object to parse multiple responses.

args should be a hash of key/value pairs, including:

debug bool
fields arrayref

debug([bool])

Get/set the debug flag for the parser.

fields

Get/set the arrayref of field names the parser should expect in each response.

parse( sos_response )

Parse the contents of sos_response and return a Search::OpenSearch::Feed object. sos_response may be a string of XML or a Search::OpenSearch::Response::XML object.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-search-opensearch-feed at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Search-OpenSearch-Feed. 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::Feed

You can also look for information at:

ACKNOWLEDGEMENTS

Thanks to American Public Media Group for sponsoring this module.

LICENSE AND COPYRIGHT

Copyright 2013 American Public Media Group.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.