KSx::IndexManager::Plugin - base class for IndexManager plugins

KSx-IndexManager documentation

Contained in the KSx-IndexManager distribution.

Index

NAME
SYNOPSIS
METHODS

Code Index:

package KSx::IndexManager::Plugin
__END__
EOF

NAME

KSx::IndexManager::Plugin - base class for IndexManager plugins

SYNOPSIS

  package KSx::IndexManager::Plugin::Mine;
  use base qw(KSx::IndexManager::Plugin);

  sub after_new {
    my ($plugin, $self) = @_;
    # do something with $self
  }

METHODS

new

Create a new plugin. This is called for you automatically and you should not need to use it.

before_new

after_new

Called when creating a new Manager. before_new is passed the hashref argument to new, and after_new is passed the newly created Manager.

alter_path

Called with the Manager object and a reference to the path as a string.

before_add_doc

after_add_doc

Called when adding a document to the invindex. Both methods are passed the Manager and the object being added.

KSx-IndexManager documentation

Contained in the KSx-IndexManager distribution.

use strict;
use warnings;

package KSx::IndexManager::Plugin;

use base qw(Class::Accessor::Grouped);

sub new { bless $_[1] => $_[0] }

sub before_new { }
sub after_new  { }

sub alter_path { }

sub before_add_doc { }
sub after_add_doc { }

1;
__END__