Dominic Hargreaves > CGI-Wiki-0.63 > CGI::Wiki::Plugin

Download:
CGI-Wiki-0.63.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

CGI::Wiki::Plugin - A base class for CGI::Wiki plugins.

DESCRIPTION ^

Provides methods for accessing the backend store, search and formatter objects of the CGI::Wiki object that a plugin instance is registered with.

SYNOPSIS ^

  package CGI::Wiki::Plugin::Foo;
  use base qw( CGI::Wiki::Plugin);

  # And then in your script:
  my $wiki = CGI::Wiki->new( ... );
  my $plugin = CGI::Wiki::Plugin::Foo->new;
  $wiki->register_plugin( plugin => $plugin );
  my $node = $plugin->datastore->retrieve_node( "Home" );

METHODS ^

new
  sub new {
      my $class = shift;
      my $self = bless {}, $class;
      $self->_init if $self->can("_init");
      return $self;
  }

Generic contructor, just returns a blessed object.

datastore

Returns the backend store object, or undef if the register_plugin method hasn't been called on a CGI::Wiki object yet.

indexer

Returns the backend search object, or undef if the register_plugin method hasn't been called on a CGI::Wiki object yet, or if the wiki object had no search object defined.

formatter

Returns the backend formatter object, or undef if the register_plugin method hasn't been called on a CGI::Wiki object yet.

SEE ALSO ^

CGI::Wiki

AUTHOR ^

Kake Pugh (kake@earth.li).

COPYRIGHT ^

     Copyright (C) 2003-4 Kake Pugh.  All Rights Reserved.

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

syntax highlighting: