X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FActions.pod;h=8794f90c98aa08d0715d22958c5b077296e5704a;hb=a74c2d1a1e12c43e5dbb4caef23f7cc25e57bd1f;hp=838878f9a29a97f9d07dea7abe57179d306a2e57;hpb=41d5da66615f17db3919de6e5d2a20e3b832af37;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Manual/Actions.pod b/lib/Catalyst/Manual/Actions.pod index 838878f..8794f90 100644 --- a/lib/Catalyst/Manual/Actions.pod +++ b/lib/Catalyst/Manual/Actions.pod @@ -4,33 +4,34 @@ Catalyst::Manual::Actions - Catalyst Reusable Actions =head1 DESCRIPTION -This section of the manual describes the reusable action system in catalyst, -how they work, descriptions of some existing ones, and how to write your own. -Reusable actions are attributes on Catalyst methods that allow you to decorate -your method with functions running before or after the method call. -This can be used to implement commonly used action patterns, while still -leaving you full freedom to customize them. +This section of the manual describes the reusable action system in +Catalyst, how they work, descriptions of some existing ones, and how to +write your own. Reusable actions are attributes on Catalyst methods +that allow you to decorate your method with functions running before or +after the method call. This can be used to implement commonly used +action patterns, while still leaving you full freedom to customize them. =head1 USING ACTIONS -This is pretty simple. It works just like the normal dispatch attributes you -are used to, like Local or Private: +This is pretty simple. It works just like the normal dispatch attributes +you are used to, like Local or Private: sub Hello :Local :ActionClass('SayBefore') { $c->res->output( 'Hello '.$c->stash->{what} ); } -In this example, we expect the SayBefore action to magically populate stash with -something relevant before Hello is run. In the next section we'll show you -how to implement it. If you want it in another namespace than Catalyst::Action -you can prefix the action name with a '+', for instance '+Foo::SayBefore', -or if you just want it under your application namespace instead, use MyAction, -like MyAction('SayBefore'). +In this example, we expect the SayBefore action to magically populate +stash with something relevant before C is run. In the next +section we'll show you how to implement it. If you want it in another +namespace than Catalyst::Action you can prefix the action name with a +'+', for instance '+Foo::SayBefore', or if you just want it under your +application namespace instead, use MyAction, like MyAction('SayBefore'). =head1 WRITING YOUR OWN ACTIONS -Implementing the action is self is almost as easy. Just use L -as a base class and decorate the 'execute' call in the Action class: +Implementing the action is self is almost as easy. Just use +L as a base class and decorate the C call in +the Action class: package Catalyst::Action::SayBefore; @@ -45,8 +46,8 @@ as a base class and decorate the 'execute' call in the Action class: 1; -If you want to do something after the action, just put it after the execute -call. Pretty simple, huh? +If you want to do something after the action, just put it after the +C call. Pretty simple, huh? =head1 ACTIONS @@ -56,4 +57,11 @@ This is meant to decorate end actions. It's similar in operation to L, but allows you to decide on an action level rather than on an application level where it should be run. -=cut +=head1 AUTHOR + +The Catalyst Core Team - see http://catalyst.perl.org/ + +=head1 COPYRIGHT + +This program is free software. You can redistribute it and/or modify it +under the same terms as Perl itself.