logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

WWW::OpenSearch::Description - Encapsulate an OpenSearch Description provided by an A9 OpenSearch

Accessors

version()ns()AdultContent()Attribution()Contact()Description()Developer()Format()InputEncoding()Image()Language()LongName()OutputEncoding()Query()SampleSearch()ShortName()SyndicationRight()Tags()Url()

Author

       •   Tatsuhiko Miyagawa <miyagawa@bulknews.net>

       •   Brian Cassidy <bricas@cpan.org>

Constructor

new([$xml])
       Constructs a new instance of WWW::OpenSearch::Description. If scalar parameter $xml is provided, data
       will be automatically loaded from it using load( $xml ).

Description

       WWW::OpenSearch::Description is a module designed to encapsulate an OpenSearch Description provided by an
       A9 OpenSearch compatible engine.  See http://opensearch.a9.com/spec/1.1/description/ for details.

Methods

load($xml)
       Loads description data by parsing provided argument using XML::LibXML.

   urls()
       Return all of the urls associated with this description in an array.

   get_best_url()
       Attempts to retrieve the best URL associated with this description, based on the following content types
       (from most preferred to least preferred):

       •   application/atom+xml

       •   application/rss+xml

       •   text/xml

   get_url_by_type($type)
       Retrieves the first WWW::OpenSearch::URL associated with this description whose type is equal to $type.

Name

       WWW::OpenSearch::Description - Encapsulate an OpenSearch Description provided by an A9 OpenSearch
       compatible engine

Synopsis

           use WWW::OpenSearch;

           my $url = "http://bulkfeeds.net/opensearch.xml";
           my $engine = WWW::OpenSearch->new($url);
           my $description = $engine->description;

           my $format   = $description->Format;   # or $description->format
           my $longname = $description->LongName; # or $description->longname

See Also