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

PurpleWiki documentation Contained in the PurpleWiki distribution.

Index

Code Index:

NAME

Top

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

SYNOPSIS

Top

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

DESCRIPTION

Top

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.

METHODS

Top

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.

SEE ALSO

Top

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

AUTHOR

Top

Chris Dent, <cdent@blueoxen.org>

PurpleWiki documentation Contained in the PurpleWiki distribution. 
# PurpleWiki::Search::Result.pm
# vi:ai:sm:et:sw=4:ts=4
#
# $Id: Result.pm 366 2004-05-19 19:22:17Z eekim $
#
# Copyright (c) Blue Oxen Associates 2002-2004.  All rights reserved.
#
# This file is part of PurpleWiki.  PurpleWiki is derived from:
#
#   UseModWiki v0.92          (c) Clifford A. Adams 2000-2001
#   AtisWiki v0.3             (c) Markus Denker 1998
#   CVWiki CVS-patches        (c) Peter Merel 1997
#   The Original WikiWikiWeb  (c) Ward Cunningham
#
# PurpleWiki is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the
#    Free Software Foundation, Inc.
#    59 Temple Place, Suite 330
#    Boston, MA 02111-1307 USA

package PurpleWiki::Search::Result;

use strict;
use PurpleWiki::Config;

our $VERSION;
$VERSION = sprintf("%d", q$Id: Result.pm 366 2004-05-19 19:22:17Z eekim $ =~ /\s(\d+)\s/);

sub new {
    my $class = shift;
    my $self = {};

    my %params = @_;

    $self->{config} = PurpleWiki::Config->instance();

    bless ($self, $class);

    return $self;
}

sub title {
    my $self = shift;

    $self->{title} = shift if @_;
    return $self->{title};
}

sub url {
    my $self = shift;

    $self->{URL} = shift if @_;
    return $self->{URL};
}

sub summary {
    my $self = shift;

    $self->{summary} = shift if @_;
    return $self->{summary};
}

sub modifiedTime {
    my $self = shift;

    $self->{mtime} = shift if @_;
    return $self->{mtime};
}

sub lastModified { # return a date/time string
    return &_date(shift->{mtime});
}

### private

sub _date {
    my $ts = shift;
    my @datetime = localtime($ts);
    my %monthNames = (
        0 => 'Jan',
        1 => 'Feb',
        2 => 'Mar',
        3 => 'Apr',
        4 => 'May',
        5 => 'Jun',
        6 => 'Jul',
        7 => 'Aug',
        8 => 'Sep',
        9 => 'Oct',
        10 => 'Nov',
        11 => 'Dec');
    my $year = 1900 + $datetime[5];
    my $month = $monthNames{$datetime[4]};
    my $day = $datetime[3];

    return "$month $day, $year";
}

1;
__END__