view release on metacpan or  search on metacpan

lib/Catalyst/Controller/BindLex.pm  view on Meta::CPAN

    return $class->NEXT::COMPONENT(@_);
}

sub _bindlex_setup_warning {
    my ($class, $app) = @_;
    return if $class->config->{unsafe_bindlex_ok};
    $app->log->warn("****");
    $app->log->warn("**** IMPORTANT WARNING: BindLex");
    $app->log->warn("****");
    $app->log->warn("Controller class $class using Catalyst::Controller::BindLex; this module is unmaintained and considered -dangerous-");
    $app->log->warn("Please see the documentation for an explanation and how to disable this warning if you want to take the risk");
    $app->log->warn("****");
}

1;

__END__

=pod

=head1 NAME

Catalyst::Controller::BindLex - Unmaintained, dangerous proof of concept

=head1 SYNOPSIS

    package MyApp::Controller::Moose;
    use base qw/Catalyst::Controller::BindLex/;

    sub bar : Local {
        my ( $self, $c ) = @_;

        my $x : Stashed;
        my %y : Stashed;

        $x = 100;
        
        do_something( $c->stash->{x} ); # 100
    
        $c->forward( "gorch" );
    }

    sub gorch : Private {
        my ( $self, $c ) = @_;
        my $x : Stashed;

        do_something( $x ); # still 100
    }

    sub counter : Local {
        my ( $self, $c ) = @_;
        my $count : Session;
        $c->res->body( "request number " . ++$count );
    }

=head1 WARNING

Catalyst::Controller::BindLex does some fairly nasty magic - the attribute
wrapping tricks are complex and will break if you declare the same lexical
name twice in the same method, and the approach to get $c out of the call
stack is hacky and fragile.

It was designed as a PROOF OF CONCEPT ONLY and should not be considered for
use in production. The authors no longer consider it a viable implementation
plan and THIS MODULE IS NOT SUPPORTED AND WILL NOT BE MAINTAINED.

If you really want to use it, please read the source code and be sure you
understand it well enough to fix anything that goes wrong, then set

    __PACKAGE__->config->{unsafe_bindlex_ok} = 1;

in your controller class to suppress the startup warning.

=head1 DESCRIPTION

This plugin lets you put your lexicals on the stash and elsewhere very easily.

It uses some funky modules to get its job done:  L<PadWalker>,
L<Array::RefElem>, L<Devel::Caller>, L<Devel::LexAlias>, and L<attributes>. In
some people's opinion this hurts this plugin's reputation ;-).

If you use the same name for two variables with the same storage binding
attribute they will be aliased to each other, so you can use this for reading
as well as writing values across controller subs. This is almost like sharing
your lexical scope.

=head1 WHY ISN'T THIS A PLUGIN?

The way attributes are handled this can't be a plugin - the
MODIFY_SCALAR_ATTRIBUTES methods and friends need to be in the class where the
lexical is attributed, and this is typically a controller.

=head1 CONFIGURATION

You can add attributes to the configaration by mapping attributes to handlers.

Handlers are either strings of methods to be called on C<$c> with no arguments,
which are expected to return a hash reference (like C<stash>, C<session>, etc),
or code references invoked with C<$c>, a reference to the variable we're
binding, and the name of the variable we're binding, also expected to return a
hash reference.

=head1 DEFAULT ATTRIBUTES

Some default attributes are pre-configured:

=over 4

=item Stash, Stashed

=item Session, Sessioned

=item Flash, Flashed

Bind the variable to a key in C<stash>, C<session>, or C<flash> respectively.

The latter two require the use of a session; see L<Catalyst::Plugin::Session>.

=back

=head1 METHODS