Bryar::DataSource::Base(3pm) - phpMan

Bryar::DataSource::Base(3pm)   User Contributed Perl Documentation   Bryar::DataSource::Base(3pm)



NAME
       Bryar::DataSource::Base - Base class for DataSources

SYNOPSIS
               $self->all_documents(...);
               $self->search(...);

DESCRIPTION
       This class doesn't do anything much, but shows you what you need to handle when writing
       your own data source.

METHODS
   all_documents
           $self->all_documents

       Returns all documents making up the blog.

   search
           $self->search($config, %params)

       A more advanced search for specific documents. Here, we do implement the search the slow,
       stupid way, so you can inherit from this if you're really lazy. However, you should use
       the parameters to filter which documents you want to find, doing something like an SQL
       select statement.

       Parameters you want to look out for:

           contains => "some text"           # Full-text search of entries

           subblog  => "blogname"            # Categorised into some sub-blog
           id       => "uniqueid"            # Unique document identifier, used
                                             # for archive links.

           since    => $epoch_time           # Bounds for when the document was
           before   => $epoch_time           # written

   add_comment
           Class->add_comment($config,
                              document => $document,
                                author => $author,
                                   url => $url,
                               content => $content );

       When your class receives this method, it needs to store a comment for a particular
       Bryar::Document with the given author name, link and content. Obviously, we can't
       implement this for you either.

LICENSE
       This module is free software, and may be distributed under the same terms as Perl itself.

AUTHOR
       Copyright (C) 2003, Simon Cozens "simon AT kasei.com"



perl v5.10.0                                2004-11-26               Bryar::DataSource::Base(3pm)

Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-21 22:32 @38.107.179.238 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)