PurpleWiki::Search::Result - Class for search results.

Encapsulates a single search result to be used by the PurpleWiki::Search::Engine module search system.

PurpleWiki::Search::Results provides an extensible class for containing search results, one result per object.

Each object contains the following required fields:

URL

The URL of the entity where the content of the result can be found.

In addition there are the following optional fields:

Title

The title of the entity where the content of the result can be found. If no title is provided, the URL will be displayed in the results.

Summary

A short textual summary string from the content of the result. Some modules use the first N characters. Others use text surrounding the query string.

Modified Time

A epoch time representation of the last modified date of the result entity.

Classes which subclass PurpleWiki::Search::Interface return a list of PurpleWiki::Search::Result objects. Those classes are responsible for filling in the fields of each object and ordering the resulting list.

new()

Creates a new Result object.

setURL($url)

Sets the URL of the object. No checking is performed.

setTitle($title)

Sets the title of the object. There are no explicit length restrictions.

setSummary($summary)

Sets the summary of the object. There are no explicit length restrictions.

setModifiedTime($epochTime)

Sets the Modified Time of the object to the provide epoch time (number of seconds since midnight, 1st of January 1970).

getURL, getTitle, getSummary, getModifiedTime

Access the stored URL, Title, Summary and Modified Time values.

PurpleWiki::Search::Engine PurpleWiki::Search::Interface

Chris Dent, <cdent@blueoxen.org>