Jose Marti Weeks > E2-Interface-0.34 > E2::Search

Download:
E2-Interface-0.34.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.32   Source  

NAME ^

E2::Search - A module for searching for nodes on http://everything2.com

SYNOPSIS ^

        use E2::Search;

        my $search = new E2::Search;

        # Fetch 10 results for a keyword search on "William Shatner"

        my @results = $search->search( "William Shatner", 'e2node', 10 );

        foreach my $r ( @results ) {
                print $r->{title};
        }

DESCRIPTION ^

This module provides an interface to everything2.com's search interface. It inherits E2::Ticker.

CONSTRUCTOR ^

new [ USERNAME ]

new creates an E2::Search object.

METHODS ^

$search->search KEYWORDS [, NODETYPE ] [, MAX_RESULTS ]

search performs a title search and returns a list of hashrefs to the titles found (with "title" and "node_id" as keys to each hash). NODETYPE is the type of node intended ("e2node" is default; other possibilities include "user", "group", "room", "document", "superdoc", and possible others). MAX_RESULTS (if set) is the maximum number of results to return.

SEE ALSO ^

E2::Interface, E2::Ticker, E2::UserSearch, http://everything2.com, http://everything2.com/?node=clientdev

AUTHOR ^

Jose M. Weeks <jose@joseweeks.com> (Simpleton on E2)

COPYRIGHT ^

This software is public domain.

syntax highlighting: