trusty (3) Mojolicious::Plugin::DefaultHelpers.3pm.gz

NAME

       Mojolicious::Plugin::DefaultHelpers - Default helpers plugin

SYNOPSIS

         # Mojolicious
         $self->plugin('DefaultHelpers');

         # Mojolicious::Lite
         plugin 'DefaultHelpers';

DESCRIPTION

       Mojolicious::Plugin::DefaultHelpers is a collection of renderer helpers for Mojolicious.

       This is a core plugin, that means it is always enabled and its code a good example for learning to build
       new plugins, you're welcome to fork it.

HELPERS

       Mojolicious::Plugin::DefaultHelpers implements the following helpers.

   app
         %= app->secrets->[0]

       Alias for "app" in Mojolicious::Controller.

   config
         %= config 'something'

       Alias for "config" in Mojo.

   content
         %= content foo => begin
           test
         % end
         %= content bar => 'Hello World!'
         %= content 'foo'
         %= content 'bar'
         %= content

       Store partial rendered content in named buffer and retrieve it, defaults to retrieving the named buffer
       "content", which is commonly used for the renderers "layout" and "extends" features. Note that new
       content will be ignored if the named buffer is already in use.

   content_for
         % content_for foo => begin
           test
         % end
         %= content_for 'foo'

       Append partial rendered content to named buffer and retrieve it. Note that named buffers are shared with
       the "content" helper.

         % content_for message => begin
           Hello
         % end
         % content_for message => begin
           world!
         % end
         %= content_for 'message'

   csrf_token
         %= csrf_token

       Get CSRF token from "session", and generate one if none exists.

   current_route
         % if (current_route 'login') {
           Welcome to Mojolicious!
         % }
         %= current_route

       Check or get name of current route.

   dumper
         %= dumper {some => 'data'}

       Dump a Perl data structure with "dumper" in Mojo::Util.

   extends
         % extends 'blue';
         % extends 'blue', title => 'Blue!';

       Extend a template. All additional values get merged into the "stash".

   flash
         %= flash 'foo'

       Alias for "flash" in Mojolicious::Controller.

   include
         %= include 'menubar'
         %= include 'menubar', format => 'txt'

       Include a partial template, all arguments get localized automatically and are only available in the
       partial template.

   layout
         % layout 'green';
         % layout 'green', title => 'Green!';

       Render this template with a layout. All additional values get merged into the "stash".

   param
         %= param 'foo'

       Alias for "param" in Mojolicious::Controller.

   session
         %= session 'foo'

       Alias for "session" in Mojolicious::Controller.

   stash
         %= stash 'foo'
         % stash foo => 'bar';

       Alias for "stash" in Mojolicious::Controller.

         %= stash('name') // 'Somebody'

   title
         % title 'Welcome!';
         % title 'Welcome!', foo => 'bar';
         %= title

       Page title. All additional values get merged into the "stash".

   ua
         %= ua->get('mojolicio.us')->res->dom->at('title')->text

       Alias for "ua" in Mojo.

   url_for
         %= url_for 'named', controller => 'bar', action => 'baz'

       Alias for "url_for" in Mojolicious::Controller.

   url_with
         %= url_with 'named', controller => 'bar', action => 'baz'

       Does the same as "url_for", but inherits query parameters from the current request.

         %= url_with->query([page => 2])

   validation
         %= validation->param('foo')

       Alias for "validation" in Mojolicious::Controller.

METHODS

       Mojolicious::Plugin::DefaultHelpers inherits all methods from Mojolicious::Plugin and implements the
       following new ones.

   register
         $plugin->register(Mojolicious->new);

       Register helpers in Mojolicious application.

SEE ALSO

       Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.