The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
CGI-Application-Plugin-RunmodeDeclare-0.10
River stage zero No dependents
++
/ CGI::Application::Plugin::RunmodeDeclare

NAME

CGI::Application::Plugin::RunmodeDeclare - Declare runmodes with keywords

VERSION

version 0.10

SYNOPSIS

    package My::CgiApp;

    use base 'CGI::Application';
    use CGI::Application::Plugin::RunmodeDeclare;

    startmode hello { "Hello!" }

    runmode world($name) {
        return $self->hello
        . ', '
        . $name || "World!";
    }

    errormode oops($c: $exception) {
        return "Something went wrong at "
        . $c->get_current_runmode
        . ". Exception: $exception";
    }

DESCRIPTION

This module allows you to declare run modes with a simple keyword. It provides the same features as Method::Signatures::Simple.

It respects inheritance: run modes defined in the superclass are also available in the subclass.

Beyond automatically registering the run mode, and providing $self, it also optionally pulls named parameters from $self->query->param or $self->param.

  • Basic example

        runmode foo { $self->bar }

    This declares the run mode "foo". Notice how $self is ready for use.

  • Rename invocant

        runmode bar ($c:) { $c->baz }

    Same as above, only use $c instead of $self.

        use CGI::Application::Plugin::RunmodeDeclare invocant => '$c';
    runmode baz { $c->quux }

    Same as above, but every runmode gets $c by default. You can still say runmode ($self:) to rename the invocant.

  • With a parameter list

        runmode baz ( $id, $name ) {
        return $self->wibble("I received $id and $name from a form submission
                              or a method invocation.");
    }

    Here, we specify that the method expects two parameters, $id and $name. Values can be supplied through a method call (e.g. $self->baz(1, "me")), or from the cgiapp object (e.g. $self->param( id => 42 )), or from the query object (e.g. from /script?id=42;name=me).

  • Code attributes

        runmode secret :Auth { ... }

    Code attributes are supported as well.

  • Combining with other ways to set run modes

    This all works:

        sub setup {
        my $self = shift;
        $self->run_modes([ qw/ foo / ]);
    }

    sub foo {
        my $self = shift;
        return $self->other;
    }

    runmode bar {
        return $self->other;
    }

    sub other : Runmode {
        my $self = shift;
        return $self->param('other');
    }

    So you can still use the classic way of setting up run modes, and you can still use CGI::Application::Plugin::AutoRunmode, *and* you can mix and match.

EXPORT

  • errormode

    Define the run mode that serves as $self->error_mode. You can only declare one errormode per package.

  • startmode

    Define the run mode that serves as $self->start_mode. You can only declare one startmode per package.

  • runmode

    Define run mode.

AUTHOR

Rhesa Rozendaal, <rhesa at cpan.org>

DIAGNOSTICS

  • error mode redefined (from %s) at %s line %s

    You tried to install another errormode. Placeholders are filled with

     * fully qualified name of existing errormode
 * file name
 * line number

  • start mode redefined (from %s) at %s line %s

    You tried to install another startmode. Placeholders are filled with

     * fully qualified name of existing startmode
 * file name
 * line number

BUGS

Please report any bugs or feature requests to bug-cgi-application-plugin-runmodedeclare at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CGI-Application-Plugin-RunmodeDeclare. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc CGI::Application::Plugin::RunmodeDeclare

You can also look for information at:

ACKNOWLEDGEMENTS

Matt S. Trout for Devel::Declare, and Michael G. Schwern for providing the inspiration with Method::Signatures.

COPYRIGHT & LICENSE

Copyright 2008 Rhesa Rozendaal, all rights reserved.

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