jjn1056 / catalyst-plugin-currentcomponents

alternative way to setup the current view or model for a given request

NAME

Catalyst::Plugin::CurrentComponents - Declare current components more easily.

SYNOPSIS

Use the plugin in your application class:

package MyApp;
use Catalyst 'CurrentComponents';

MyApp->setup;

Then you can use it in your controllers:

package MyApp::Controller::Example;

use base 'Catalyst::Controller';

sub current_model_instance {
  my ($self, $c) = @_;
  return $c->model("Form::Login", user_database => $c->model('Users'));
}

sub myaction :Local {
  my ($self, $c) = @_;
  my $c->model; # Isa 'MyApp::Model::Form::Login', or whatever that returns;
}

DESCRIPTION

This plugin gives you an alternative to setting the current_view|model(_instance) via a controller method or via context helper methods. You may find this a more readable approach than setting it via the stash.

You may also enable a global option to set the current_model_instance via the return value of a match method. See "CONFIGURATION"

Please Seee documention about Views and Models in Catalyst.

METHODS

This plugin adds the following methods to your context.

current_model

Sets $c->stash->{current_model} if an argument is passed. Always returns the current value of this stash key. Expects the string name of a model.

current_model_instance

Sets $c->stash->{current_model_instance} if an argument is passed. Always returns the current value of this stash key. Expects either the instance of an already created model or can accept arguments that can be validly submitted to $c->model.

current_view

Sets $c->stash->{current_view} if an argument is passed. Always returns the current value of this stash key. Expects the string new of a view.

current_view_instance

Sets $c->stash->{current_view_instance} if an argument is passed. Always returns the current value of this stash key. Expects either the instance of an already created view or can accept arguments that can be validly submitted to $c->view.

CONFIGURATION

This plugin supports configuration under the "Plugin::CurrentComponents" key. For example:

MyApp->config(
  'Plugin::CurrentComponents' => {
    model_instance_from_return => 1,
  },
);

model_instance_from_return

Allows one to set the current_model_instance from the return value of a matched action. Please note this is an experimental option which is off by default. The return value must be a defined, blessed objected for this behavior to take place.

AUTHOR

John Napiorkowski email:[email protected]

SEE ALSO

Catalyst, Catalyst::Response

COPYRIGHT & LICENSE

Copyright 2015, John Napiorkowski email:[email protected]

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