NAME

Yukki::Web::Plugin - base class for Yukki plugins

VERSION

version 0.991_004

SYNOPSIS

  package MyPlugins::LowerCase;
  use 5.12.1;
  use Moo;

  use Types::Standard qw( HashRef CodeRef );

  extends 'Yukki::Web::Plugin';

  has format_helpers => (
      is          => 'ro',
      isa         => HashRef[CodeRef],
      default     => sub { +{
          'lc' => \&lc_helper,
      } },
  );

  with 'Yukki::Web::Plugin::Role::FormatHelper';

  sub lc_helper {
      my ($params) = @_;
      return lc $params->{arg};
  }

DESCRIPTION

This is the base class for Yukki plugins. It doesn't do much but allow your plugin access to the application singleton and its configuration. For your plugin to actually do something, you must implement a plugin role. See these roles for details:

• Yukki::Web::Plugin::Role::Formatter. Formats a file for output as HTML.

• Yukki::Web::Plugin::Role::FormatHelper. This gives you the ability to create quick helpers in your yukkitext using the {{helper:...}} notation.

ATTRIBUTES

app

This is the Yukki::Web singleton. All the methods required in Yukki::Role::App will be delegated.

AUTHOR

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Qubling Software LLC.

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