4 package Catalyst::Middleware::Stash;
6 use base 'Plack::Middleware';
10 our @EXPORT_OK = qw(stash get_stash);
12 sub PSGI_KEY () { 'Catalyst.Stash.v2' }
16 return $env->{+PSGI_KEY} ||
17 croak "You requested a stash, but one does not exist.";
21 my ($host, @args) = @_;
22 return get_stash($host->env)
28 my $stash = shift || +{};
31 my $new_stash = @_ > 1 ? {@_} : $_[0];
32 croak('stash takes a hash or hashref')
33 unless ref $new_stash;
34 foreach my $key (keys %$new_stash) {
35 $stash->{$key} = $new_stash->{$key};
43 my ($self, $env) = @_;
44 $env->{+PSGI_KEY} = $self->_create_stash
45 unless exists($env->{+PSGI_KEY});
47 return $self->app->($env);
52 Catalyst::Middleware::Stash - The Catalyst stash - in middleware
56 We've moved the L<Catalyst> stash to middleware. Please don't use this
57 directly since it is likely to move off the Catalyst namespace into a stand
60 We store a coderef under the C<PSGI_KEY> which can be dereferenced with
61 key values or nothing to access the underlying hashref.
63 Anything placed into the stash will be available in the stash of any 'mounted'
64 Catalyst applications. A mounted Catalyst application may set the stash and
65 'pass back' information to the parent application. Non Catalyst applications
66 may use this middleware to access and set stash values.
68 Please note I highly recommend having a stronger interface than a stash key
71 For more information the current test case t/middleware-stash.t is the best
76 This class defines the following subroutines.
80 Returns the hash key where we store the stash. You should not assume
81 the string value here will never change! Also, its better to use
82 L</get_stash> or L</stash>.
88 Exportable subroutine.
90 Get the stash out of the C<$env>.
94 Expects: An object that does C<env> and arguments
96 Exportable subroutine.
98 Given an object with a method C<env> get or set stash values, either
99 as a method or via hashref modification. This stash is automatically
100 reset for each request (it is not persistent or shared across connected
101 clients. Stash key / value are stored in memory.
104 use Catalyst::Middleware::Stash 'stash';
108 my $req = Plack::Request->new($env);
109 my $stashed = $req->stash->{in_the_stash}; # Assume the stash was previously populated.
111 return [200, ['Content-Type' => 'text/plain'],
112 ["I found $stashed in the stash!"]];
115 If the stash does not yet exist, an exception is thrown.
119 This class defines the following methods.
123 Used by plack to call the middleware