NAME
Mojolicious::Plugins - Plugins
SYNOPSIS
use Mojolicious::Plugins;DESCRIPTION
Mojolicous::Plugins is the plugin manager of Mojolicious. In your application you will usually use it to load plugins. To implement your own plugins see Mojolicious::Plugin and the add_hook method below.
ATTRIBUTES
Mojolicious::Plugins implements the following attributes.
hooks
my $hooks = $plugins->hooks;
$plugins = $plugins->hooks({foo => [sub {...}]});Hash reference containing all hooks that have been registered by loaded plugins.
namespaces
my $namespaces = $plugins->namespaces;
$plugins = $plugins->namespaces(['Mojolicious::Plugin']);Namespaces to load plugins from. You can add more namespaces to load application specific plugins.
METHODS
Mojolicious::Plugins inherits all methods from Mojo::Base and implements the following new ones.
add_hook
$plugins = $plugins->add_hook(event => sub {...});Hook into an event. The following events are available. (Note that after_* hooks run in reverse order)
- before_dispatch
-
Runs before the dispatchers determines what action to run. (Passed the default controller instance)
$plugins->add_hook(before_dispatch => sub { my ($self, $c) = @_; }); - after_dispatch
-
Runs after the dispatchers determines what action to run. (Passed the default controller instance)
$plugins->add_hook(after_dispatch => sub { my ($self, $c) = @_; }); - after_static_dispatch
-
Runs after the static dispatcher determines if a static file should be served. (Passed the default controller instance)
$plugins->add_hook(after_static_dispatch => sub { my ($self, $c) = @_; }) - after_build_tx
-
Runs right after the transaction is built and before the HTTP message gets parsed. One usage case would be upload progress bars. (Passed the transaction instance)
$plugins->add_hook(after_build_tx => sub { my ($self, $tx) = @_; })
You could also add custom events by using run_hook and run_hook_reverse in your application.
load_plugin
$plugins = $plugins->load_plugin($app, 'something');
$plugins = $plugins->load_plugin($app, 'something', foo => 23);
$plugins = $plugins->load_plugin($app, 'something', {foo => 23});Load a plugin from the configured namespaces and run register. Optional arguments are passed to register.
run_hook
$plugins = $plugins->run_hook('foo');
$plugins = $plugins->run_hook(foo => 123);Runs a hook.
run_hook_reverse
$plugins = $plugins->run_hook_reverse('foo');
$plugins = $plugins->run_hook_reverse(foo => 123);Runs a hook in reverse order.