/ 
XT-Files-0.001
River stage one • 5 direct dependents • 5 total dependents
/ XT::Files::Plugin

NAME

XT::Files::Plugin - base class for XT::Files plugins

VERSION

Version 0.001

SYNOPSIS

my $obj = XT::Files::Plugin->new( xtf => XT_FILES_OBJECT );

$obj->xtf; # returns XT_FILES_OBJECT

DESCRIPTION

This is the parent class for all XT::Files plugins. There should never be a reason to instantiate this class directly. To write your own plugin, use this class as your parent.

use parent 'XT::Files::Plugin';

Your plugin then must implement a run method which takes a single argument, a reference to an array of array references. These arrays contain the configuration that is forwarded from the config file to your plugin. The following config file entry

[YourPlugin]
key 1 = value 1
key 2 = value 2a
key 2 = value 2b

would result in your plugin being called like so

$obj->run( [
    [ 'key 1' => 'value 1' ],
    [ 'key 2' => 'value 2a' ],
    [ 'key 2' => 'value 2b'],
] );

USAGE

new

Requires the xtf argument.

If you write your own plugin, please do not overwrite new. Use the BUILD method instead. Please see Class::Tiny for further information on the object system.

xtf

Returns the XT::Files object that was passed with new.

SEE ALSO

XT::Files, Class::Tiny

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/skirmess/XT-Files/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/skirmess/XT-Files

git clone https://github.com/skirmess/XT-Files.git

AUTHOR

Sven Kirmess <sven.kirmess@kzone.ch>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2019 by Sven Kirmess.

This is free software, licensed under:

The (two-clause) FreeBSD License