NAME

MooseX::MojoControllerExposingAttributes - expose controller attributes to Mojolicious

SYNOPSIS

package MyApp::Controller::Example;
use MooseX::MojoControllerExposingAttributes;

...;

has some_attribute => (
    is     => 'ro',
    traits => ['ExposeMojo'],
);

# then later in a template: <%= ctrl->some_attribute %>

DESCRIPTION

This class allows you to expose selected Moose attributes from your Mojolicious controller to your templates by marking them with the ExposeMojo trait.

Using this class in a Perl class does several things:

• It makes the class a subclass of Mojolicious::Controller
• It sets up the class with Moose and Moose::NonMoose
• It applies the extra role and metaclass traits to the class so this works with Mojolicious::Plugin::ExposeControllerMethod
• It sets up the ExposeMojo trait

So rather than declaring your controller class a Moose Mojolicious Controller in the usual way:

package MyApp::Controller::Example;
use Mojo::Base 'Mojolicious::Controller';
use Moose::NonMoose;
use Moose;

You should simply say:

package MyApp::Controller::Example;
use MooseX::MojoControllerExposingAttributes;

Once you've done that then you can define attributes in the class (or in roles the class consumes) that are exposed to Mojolicious.

has some_attribute => (
    is     => 'ro',
    traits => ['ExposeMojo'],
);

has some_attribute_with_a_really_long_name => (
   is                => 'ro',
   traits            => ['ExposeMojo'],
   expose_to_mojo_as => 'shorter_name',
);

In order to get the ctrl helper you should make sure you've loaded the Mojolicious::Plugin::ExposeControllerMethod plugin somewhere in your Mojolicious application, typically within the startup method itself:

sub startup {
    my $self = shift;

    $self->plugin('ExposeControllerMethod');

    ...
}

Then you'll be able to access your attributes from within templates that are rendered from that controller:

some attribute: <%= ctrl->some_attribute %>
some attribute with a really long name: <%= ctrl->shorter_name %>

BUGS

It would be nice to be able to set the baseclass instead of always using Mojolicious::Controller

SEE ALSO

Mojolicious::Plugin::ExposeControllerMethod

MooseX::MojoControllerExposingAttributes::Trait::Attribute