- SEE ALSO
- COPYRIGHT AND LICENSE
XT::Files::Plugin - base class for XT::Files plugins
my $obj = XT::Files::Plugin->new( xtf => XT_FILES_OBJECT ); $obj->xtf; # returns XT_FILES_OBJECT
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'], ] );
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.
Returns the XT::Files object that was passed with
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.
This is open source software. The code repository is available for public review and contribution under the terms of the license.
git clone https://github.com/skirmess/XT-Files.git
Sven Kirmess <email@example.com>
This software is Copyright (c) 2018-2019 by Sven Kirmess.
This is free software, licensed under:
The (two-clause) FreeBSD License