GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  WWW::OPENSEARCH::DESCRIPTION (3)

.ds Aq ’

NAME

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

CONTENTS

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



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.

CONSTRUCTOR

new( [ CW$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 ).

METHODS

load( CW$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):
o application/atom+xml
o application/rss+xml
o text/xml

get_url_by_type( CW$type )

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

ACCESSORS

    version( )

    ns( )

    AdultContent( )

    Attribution( )

    Contact( )

    Description( )

    Developer( )

    Format( )

    InputEncoding( )

    Image( )

    Language( )

    LongName( )

    OutputEncoding( )

    Query( )

    SampleSearch( )

    ShortName( )

    SyndicationRight( )

    Tags( )

    Url( )

AUTHOR

o Tatsuhiko Miyagawa <miyagawa@bulknews.net>
o Brian Cassidy <bricas@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2005-2013 by Tatsuhiko Miyagawa and Brian Cassidy

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WWW::OPENSEARCH::DESCRIPTION (3) 2013-01-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.