3 Catalyst - The Elegant MVC Web Application Framework
9 <a href="https://badge.fury.io/pl/Catalyst-Runtime"><img src="https://badge.fury.io/pl/Catalyst-Runtime.svg" alt="CPAN version" height="18"></a>
10 <a href="https://travis-ci.org/perl-catalyst/catalyst-runtime/"><img src="https://api.travis-ci.org/perl-catalyst/catalyst-runtime.png" alt="Catalyst></a>
11 <a href="http://cpants.cpanauthors.org/dist/Catalyst-Runtime"><img src="http://cpants.cpanauthors.org/dist/Catalyst-Runtime.png" alt='Kwalitee Score' /></a>
15 See the [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) distribution for comprehensive
16 documentation and tutorials.
18 # Install Catalyst::Devel for helpers and other development tools
19 # use the helper to create a new application
22 # add models, views, controllers
23 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
24 script/myapp_create.pl view MyTemplate TT
25 script/myapp_create.pl controller Search
27 # built in testserver -- use -r to restart automatically on changes
28 # --help to see all available options
29 script/myapp_server.pl
31 # command line testing interface
32 script/myapp_test.pl /yada
35 use Catalyst qw/-Debug/; # include plugins here as well
37 ### In lib/MyApp/Controller/Root.pm (autocreated)
38 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
39 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
40 $c->stash->{template} = 'foo.tt'; # set the template
41 # lookup something from db -- stash vars are passed to TT
43 $c->model('Database::Foo')->search( { country => $args[0] } );
44 if ( $c->req->params->{bar} ) { # access GET or POST parameters
45 $c->forward( 'bar' ); # process another action
46 # do something else after forward returns
50 # The foo.tt TT template can use the stash data from the database
51 [% WHILE (item = data.next) %]
55 # called for /bar/of/soap, /bar/of/soap/10, etc.
56 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
58 # called after all actions are finished
60 my ( $self, $c ) = @_;
61 if ( scalar @{ $c->error } ) { ... } # handle errors
62 return if $c->res->body; # already have a response
63 $c->forward( 'MyApp::View::TT' ); # render template
66 See [Catalyst::Manual::Intro](https://metacpan.org/pod/Catalyst::Manual::Intro) for additional information.
70 Catalyst is a modern framework for making web applications without the
71 pain usually associated with this process. This document is a reference
72 to the main Catalyst application. If you are a new user, we suggest you
73 start with [Catalyst::Manual::Tutorial](https://metacpan.org/pod/Catalyst::Manual::Tutorial) or [Catalyst::Manual::Intro](https://metacpan.org/pod/Catalyst::Manual::Intro).
75 See [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) for more documentation.
77 Catalyst plugins can be loaded by naming them as arguments to the "use
78 Catalyst" statement. Omit the `Catalyst::Plugin::` prefix from the
79 plugin name, i.e., `Catalyst::Plugin::My::Module` becomes
82 use Catalyst qw/My::Module/;
84 If your plugin starts with a name other than `Catalyst::Plugin::`, you can
85 fully qualify the name by using a unary plus:
89 +Fully::Qualified::Plugin::Name
92 Special flags like `-Debug` can also be specified as
93 arguments when Catalyst is loaded:
95 use Catalyst qw/-Debug My::Module/;
97 The position of plugins and flags in the chain is important, because
98 they are loaded in the order in which they appear.
100 The following flags are supported:
104 Enables debug output. You can also force this setting from the system
105 environment with CATALYST\_DEBUG or <MYAPP>\_DEBUG. The environment
106 settings override the application, with <MYAPP>\_DEBUG having the highest
109 This sets the log level to 'debug' and enables full debug output on the
110 error screen. If you only want the latter, see [$c->debug](https://metacpan.org/pod/$c->debug).
114 Forces Catalyst to use a specific home directory, e.g.:
116 use Catalyst qw[-Home=/usr/mst];
118 This can also be done in the shell environment by setting either the
119 `CATALYST_HOME` environment variable or `MYAPP_HOME`; where `MYAPP`
120 is replaced with the uppercased name of your application, any "::" in
121 the name will be replaced with underscores, e.g. MyApp::Web should use
122 MYAPP\_WEB\_HOME. If both variables are set, the MYAPP\_HOME one will be used.
124 If none of these are set, Catalyst will attempt to automatically detect the
125 home directory. If you are working in a development environment, Catalyst
126 will try and find the directory containing either Makefile.PL, Build.PL,
127 dist.ini, or cpanfile. If the application has been installed into the system
128 (i.e. you have done `make install`), then Catalyst will use the path to your
129 application module, without the .pm extension (e.g., /foo/MyApp if your
130 application was installed at /foo/MyApp.pm)
134 use Catalyst '-Log=warn,fatal,error';
136 Specifies a comma-delimited list of log levels.
140 Enables statistics collection and reporting.
142 use Catalyst qw/-Stats=1/;
144 You can also force this setting from the system environment with CATALYST\_STATS
145 or <MYAPP>\_STATS. The environment settings override the application, with
146 <MYAPP>\_STATS having the highest priority.
148 Stats are also enabled if [debugging ](#debug) is enabled.
152 ## INFORMATION ABOUT THE CURRENT REQUEST
156 Returns a [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action) object for the current action, which
157 stringifies to the action name. See [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action).
161 Returns the namespace of the current action, i.e., the URI prefix
162 corresponding to the controller of the current action. For example:
164 # in Controller::Foo::Bar
165 $c->namespace; # returns 'foo/bar';
171 Returns the current [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) object, giving access to
172 information about the current client request (including parameters,
173 cookies, HTTP headers, etc.). See [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request).
175 ## REQUEST FLOW HANDLING
177 ## $c->forward( $action \[, \\@arguments \] )
179 ## $c->forward( $class, $method, \[, \\@arguments \] )
181 This is one way of calling another action (method) in the same or
182 a different controller. You can also use `$self->my_method($c, @args)`
183 in the same controller or `$c->controller('MyController')->my_method($c, @args)`
184 in a different controller.
185 The main difference is that 'forward' uses some of the Catalyst request
186 cycle overhead, including debugging, which may be useful to you. On the
187 other hand, there are some complications to using 'forward', restrictions
188 on values returned from 'forward', and it may not handle errors as you prefer.
189 Whether you use 'forward' or not is up to you; it is not considered superior to
190 the other ways to call a method.
192 'forward' calls another action, by its private name. If you give a
193 class name but no method, `process()` is called. You may also optionally
194 pass arguments in an arrayref. The action will receive the arguments in
195 `@_` and `$c->req->args`. Upon returning from the function,
196 `$c->req->args` will be restored to the previous values.
198 Any data `return`ed from the action forwarded to, will be returned by the
201 my $foodata = $c->forward('/foo');
202 $c->forward('index');
203 $c->forward(qw/Model::DBIC::Foo do_stuff/);
204 $c->forward('View::TT');
206 Note that [forward](#c-forward-action-arguments) implies
207 an `eval { }` around the call (actually
208 [execute](#c-execute-class-coderef) does), thus rendering all
209 exceptions thrown by the called action non-fatal and pushing them onto
210 $c->error instead. If you want `die` to propagate you need to do something
214 die join "\n", @{ $c->error } if @{ $c->error };
216 Or make sure to always return true values from your actions and write
219 $c->forward('foo') || return;
221 Another note is that `$c->forward` always returns a scalar because it
222 actually returns $c->state which operates in a scalar context.
223 Thus, something like:
227 in an action that is forwarded to is going to return a scalar,
228 i.e. how many items are in that array, which is probably not what you want.
229 If you need to return an array then return a reference to it,
232 $c->stash->{array} = \@array;
234 and access it from the stash.
236 Keep in mind that the `end` method used is that of the caller action. So a `$c->detach` inside a forwarded action would run the `end` method from the original action requested.
238 ## $c->detach( $action \[, \\@arguments \] )
240 ## $c->detach( $class, $method, \[, \\@arguments \] )
244 The same as [forward](#c-forward-action-arguments), but
245 doesn't return to the previous action when processing is finished.
247 When called with no arguments it escapes the processing chain entirely.
249 ## $c->visit( $action \[, \\@arguments \] )
251 ## $c->visit( $action \[, \\@captures, \\@arguments \] )
253 ## $c->visit( $class, $method, \[, \\@arguments \] )
255 ## $c->visit( $class, $method, \[, \\@captures, \\@arguments \] )
257 Almost the same as [forward](#c-forward-action-arguments),
258 but does a full dispatch, instead of just calling the new `$action` /
259 `$class->$method`. This means that `begin`, `auto` and the method
260 you go to are called, just like a new request.
262 In addition both `$c->action` and `$c->namespace` are localized.
263 This means, for example, that `$c->action` methods such as
264 [name](https://metacpan.org/pod/Catalyst::Action#name), [class](https://metacpan.org/pod/Catalyst::Action#class) and
265 [reverse](https://metacpan.org/pod/Catalyst::Action#reverse) return information for the visited action
266 when they are invoked within the visited action. This is different from the
267 behavior of [forward](#c-forward-action-arguments), which
268 continues to use the $c->action object from the caller action even when
269 invoked from the called action.
271 `$c->stash` is kept unchanged.
273 In effect, [visit](#c-visit-action-captures-arguments)
274 allows you to "wrap" another action, just as it would have been called by
275 dispatching from a URL, while the analogous
276 [go](#c-go-action-captures-arguments) allows you to
277 transfer control to another action as if it had been reached directly from a URL.
279 ## $c->go( $action \[, \\@arguments \] )
281 ## $c->go( $action \[, \\@captures, \\@arguments \] )
283 ## $c->go( $class, $method, \[, \\@arguments \] )
285 ## $c->go( $class, $method, \[, \\@captures, \\@arguments \] )
287 The relationship between `go` and
288 [visit](#c-visit-action-captures-arguments) is the same as
289 the relationship between
290 [forward](#c-forward-class-method-arguments) and
291 [detach](#c-detach-action-arguments). Like `$c->visit`,
292 `$c->go` will perform a full dispatch on the specified action or method,
293 with localized `$c->action` and `$c->namespace`. Like `detach`,
294 `go` escapes the processing of the current request chain on completion, and
295 does not return to its caller.
297 @arguments are arguments to the final destination of $action. @captures are
298 arguments to the intermediate steps, if any, on the way to the final sub of
305 Returns the current [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response) object, see there for details.
309 Returns a hashref to the stash, which may be used to store data and pass
310 it between components during a request. You can also set hash keys by
311 passing arguments. The stash is automatically sent to the view. The
312 stash is cleared at the end of a request; it cannot be used for
313 persistent storage (for this you must use a session; see
314 [Catalyst::Plugin::Session](https://metacpan.org/pod/Catalyst::Plugin::Session) for a complete system integrated with
317 $c->stash->{foo} = $bar;
318 $c->stash( { moose => 'majestic', qux => 0 } );
319 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
321 # stash is automatically passed to the view for use in a template
322 $c->forward( 'MyApp::View::TT' );
324 The stash hash is currently stored in the PSGI `$env` and is managed by
325 [Catalyst::Middleware::Stash](https://metacpan.org/pod/Catalyst::Middleware::Stash). Since it's part of the `$env` items in
326 the stash can be accessed in sub applications mounted under your main
327 [Catalyst](https://metacpan.org/pod/Catalyst) application. For example if you delegate the response of an
328 action to another [Catalyst](https://metacpan.org/pod/Catalyst) application, that sub application will have
329 access to all the stash keys of the main one, and if can of course add
330 more keys of its own. However those new keys will not 'bubble' back up
331 to the main application.
333 For more information the best thing to do is to review the test case:
334 t/middleware-stash.t in the distribution /t directory.
338 ## $c->error($error, ...)
340 ## $c->error($arrayref)
342 Returns an arrayref containing error messages. If Catalyst encounters an
343 error while processing a request, it stores the error in $c->error. This
344 method should only be used to store fatal error messages.
346 my @error = @{ $c->error };
350 $c->error('Something bad happened');
352 Calling this will always return an arrayref (if there are no errors it
353 will be an empty arrayref.
357 Contains the return value of the last executed action.
358 Note that << $c->state >> operates in a scalar context which means that all
359 values it returns are scalar.
361 Please note that if an action throws an exception, the value of state
362 should no longer be considered the return if the last action. It is generally
363 going to be 0, which indicates an error state. Examine $c->error for error
368 Clear errors. You probably don't want to clear the errors unless you are
369 implementing a custom error screen.
371 This is equivalent to running
377 Returns true if you have errors
381 Returns the most recent error in the stack (the one most recently added...)
382 or nothing if there are no errors. This does not modify the contents of the
387 shifts the most recently added error off the error stack and returns it. Returns
388 nothing if there are no more errors.
392 pops the most recently added error off the error stack and returns it. Returns
393 nothing if there are no more errors.
395 ## COMPONENT ACCESSORS
397 ## $c->controller($name)
399 Gets a [Catalyst::Controller](https://metacpan.org/pod/Catalyst::Controller) instance by name.
401 $c->controller('Foo')->do_stuff;
403 If the name is omitted, will return the controller for the dispatched
406 If you want to search for controllers, pass in a regexp as the argument.
408 # find all controllers that start with Foo
409 my @foo_controllers = $c->controller(qr{^Foo});
413 Gets a [Catalyst::Model](https://metacpan.org/pod/Catalyst::Model) instance by name.
415 $c->model('Foo')->do_stuff;
417 Any extra arguments are directly passed to ACCEPT\_CONTEXT, if the model
418 defines ACCEPT\_CONTEXT. If it does not, the args are discarded.
420 If the name is omitted, it will look for
421 - a model object in $c->stash->{current\_model\_instance}, then
422 - a model name in $c->stash->{current\_model}, then
423 - a config setting 'default\_model', or
424 - check if there is only one model, and return it if that's the case.
426 If you want to search for models, pass in a regexp as the argument.
428 # find all models that start with Foo
429 my @foo_models = $c->model(qr{^Foo});
433 Gets a [Catalyst::View](https://metacpan.org/pod/Catalyst::View) instance by name.
435 $c->view('Foo')->do_stuff;
437 Any extra arguments are directly passed to ACCEPT\_CONTEXT.
439 If the name is omitted, it will look for
440 - a view object in $c->stash->{current\_view\_instance}, then
441 - a view name in $c->stash->{current\_view}, then
442 - a config setting 'default\_view', or
443 - check if there is only one view, and return it if that's the case.
445 If you want to search for views, pass in a regexp as the argument.
447 # find all views that start with Foo
448 my @foo_views = $c->view(qr{^Foo});
452 Returns the available names which can be passed to $c->controller
456 Returns the available names which can be passed to $c->model
460 Returns the available names which can be passed to $c->view
464 ## $c->component($name)
466 Gets a component object by name. This method is not recommended,
467 unless you want to get a specific component by full
468 class. `$c->controller`, `$c->model`, and `$c->view`
469 should be used instead.
471 If `$name` is a regexp, a list of components matched against the full
472 component name will be returned.
474 If Catalyst can't find a component by name, it will fallback to regex
475 matching by default. To disable this behaviour set
476 disable\_component\_resolution\_regex\_fallback to a true value.
478 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
480 ## CLASS DATA AND HELPER CLASSES
484 Returns or takes a hashref containing the application's configuration.
486 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
488 You can also use a `YAML`, `XML` or [Config::General](https://metacpan.org/pod/Config::General) config file
489 like `myapp.conf` in your applications home directory. See
490 [Catalyst::Plugin::ConfigLoader](https://metacpan.org/pod/Catalyst::Plugin::ConfigLoader).
492 ### Cascading configuration
494 The config method is present on all Catalyst components, and configuration
495 will be merged when an application is started. Configuration loaded with
496 [Catalyst::Plugin::ConfigLoader](https://metacpan.org/pod/Catalyst::Plugin::ConfigLoader) takes precedence over other configuration,
497 followed by configuration in your top level `MyApp` class. These two
498 configurations are merged, and then configuration data whose hash key matches a
499 component name is merged with configuration for that component.
501 The configuration for a component is then passed to the `new` method when a
502 component is constructed.
506 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
507 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
509 will mean that `MyApp::Model::Foo` receives the following data when
512 MyApp::Model::Foo->new({
518 It's common practice to use a Moose attribute
519 on the receiving component to access the config value.
521 package MyApp::Model::Foo;
525 # this attr will receive 'baz' at construction time
531 You can then get the value 'baz' by calling $c->model('Foo')->bar
532 (or $self->bar inside code in the model).
534 **NOTE:** you MUST NOT call `$self->config` or `__PACKAGE__->config`
535 as a way of reading config within your code, as this **will not** give you the
536 correctly merged config back. You **MUST** take the config values supplied to
537 the constructor and use those instead.
541 Returns the logging object instance. Unless it is already set, Catalyst
542 sets this up with a [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) object. To use your own log class,
543 set the logger with the `__PACKAGE__->log` method prior to calling
544 `__PACKAGE__->setup`.
546 __PACKAGE__->log( MyLogger->new );
551 $c->log->info( 'Now logging with my own logger!' );
553 Your log class should implement the methods described in
554 [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log).
558 Returned True if there's a valid encoding
562 Clears the encoding for the current context
566 Sets or gets the application encoding. Setting encoding takes either an
567 Encoding object or a string that we try to resolve via [Encode::find\_encoding](https://metacpan.org/pod/Encode::find_encoding).
569 You would expect to get the encoding object back if you attempt to set it. If
570 there is a failure you will get undef returned and an error message in the log.
574 Returns 1 if debug mode is enabled, 0 otherwise.
576 You can enable debug mode in several ways:
578 - By calling myapp\_server.pl with the -d flag
579 - With the environment variables MYAPP\_DEBUG, or CATALYST\_DEBUG
580 - The -Debug option in your MyApp.pm
581 - By declaring `sub debug { 1 }` in your MyApp.pm.
583 The first three also set the log level to 'debug'.
585 Calling `$c->debug(1)` has no effect.
589 Returns the dispatcher instance. See [Catalyst::Dispatcher](https://metacpan.org/pod/Catalyst::Dispatcher).
593 Returns the engine instance. See [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine).
597 ## $c->path\_to(@path)
599 Merges `@path` with `$c->config->{home}` and returns a
600 [Path::Class::Dir](https://metacpan.org/pod/Path::Class::Dir) object. Note you can usually use this object as
601 a filename, but sometimes you will have to explicitly stringify it
602 yourself by calling the `->stringify` method.
606 $c->path_to( 'db', 'sqlite.db' );
610 Initializes the dispatcher and engine, loads any plugins, and loads the
611 model, view, and controller components. You may also specify an array
612 of plugins to load here, if you choose to not load them in the `use
616 MyApp->setup( qw/-Debug/ );
618 **Note:** You **should not** wrap this method with method modifiers
619 or bad things will happen - wrap the `setup_finalize` method instead.
621 **Note:** You can create a custom setup stage that will execute when the
622 application is starting. Use this to customize setup.
624 MyApp->setup(-Custom=value);
627 my ($class, $value) = @_;
630 Can be handy if you want to hook into the setup phase.
632 ## $app->setup\_finalize
634 A hook to attach modifiers to. This method does not do anything except set the
635 `setup_finished` accessor.
637 Applying method modifiers to the `setup` method doesn't work, because of quirky things done for plugin setup.
641 after setup_finalize => sub {
647 ## $c->uri\_for( $path?, @args?, \\%query\_values?, \\$fragment? )
649 ## $c->uri\_for( $action, \\@captures?, @args?, \\%query\_values?, \\$fragment? )
651 ## $c->uri\_for( $action, \[@captures, @args\], \\%query\_values?, \\$fragment? )
653 Constructs an absolute [URI](https://metacpan.org/pod/URI) object based on the application root, the
654 provided path, and the additional arguments and query parameters provided.
655 When used as a string, provides a textual URI. If you need more flexibility
656 than this (i.e. the option to provide relative URIs etc.) see
657 [Catalyst::Plugin::SmartURI](https://metacpan.org/pod/Catalyst::Plugin::SmartURI).
659 If no arguments are provided, the URI for the current action is returned.
660 To return the current action and also provide @args, use
661 `$c->uri_for( $c->action, @args )`.
663 If the first argument is a string, it is taken as a public URI path relative
664 to `$c->namespace` (if it doesn't begin with a forward slash) or
665 relative to the application root (if it does). It is then merged with
666 `$c->request->base`; any `@args` are appended as additional path
667 components; and any `%query_values` are appended as `?foo=bar` parameters.
669 **NOTE** If you are using this 'stringy' first argument, we skip encoding and
670 allow you to declare something like:
672 $c->uri_for('/foo/bar#baz')
674 Where 'baz' is a URI fragment. We consider this first argument string to be
675 'expert' mode where you are expected to create a valid URL and we for the most
676 part just pass it through without a lot of internal effort to escape and encode.
678 If the first argument is a [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action) it represents an action which
679 will have its path resolved using `$c->dispatcher->uri_for_action`. The
680 optional `\@captures` argument (an arrayref) allows passing the captured
681 variables that are needed to fill in the paths of Chained and Regex actions;
682 once the path is resolved, `uri_for` continues as though a path was
683 provided, appending any arguments or parameters and creating an absolute
686 The captures for the current request can be found in
687 `$c->request->captures`, and actions can be resolved using
688 `Catalyst::Controller->action_for($name)`. If you have a private action
689 path, use `$c->uri_for_action` instead.
691 # Equivalent to $c->req->uri
692 $c->uri_for($c->action, $c->req->captures,
693 @{ $c->req->args }, $c->req->params);
695 # For the Foo action in the Bar controller
696 $c->uri_for($c->controller('Bar')->action_for('Foo'));
698 # Path to a static resource
699 $c->uri_for('/static/images/logo.png');
701 In general the scheme of the generated URI object will follow the incoming request
702 however if your targeted action or action chain has the Scheme attribute it will
705 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
706 type constraints, we will require that your proposed URL verify on those declared
709 ## $c->uri\_for\_action( $path, \\@captures\_and\_args?, @args?, \\%query\_values? )
711 ## $c->uri\_for\_action( $action, \\@captures\_and\_args?, @args?, \\%query\_values? )
715 A private path to the Catalyst action you want to create a URI for.
717 This is a shortcut for calling `$c->dispatcher->get_action_by_path($path)` and passing the resulting `$action` and the remaining arguments to `$c->uri_for`.
719 You can also pass in a Catalyst::Action object, in which case it is passed to
722 Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.
724 For example, if the action looks like:
726 package MyApp::Controller::Users;
728 sub lst : Path('the-list') {}
732 $c->uri_for_action('/users/lst')
734 and it will create the URI /users/the-list.
736 - \\@captures\_and\_args?
738 Optional array reference of Captures (i.e. `<CaptureArgs or $c-`req->captures>)
739 and arguments to the request. Usually used with [Catalyst::DispatchType::Chained](https://metacpan.org/pod/Catalyst::DispatchType::Chained)
740 to interpolate all the parameters in the URI.
744 Optional list of extra arguments - can be supplied in the
745 `\@captures_and_args?` array ref, or here - whichever is easier for your
748 Your action can have zero, a fixed or a variable number of args (e.g.
749 `Args(1)` for a fixed number or `Args()` for a variable number)..
753 Optional array reference of query parameters to append. E.g.
759 /rest/of/your/uri?foo=bar
761 ## $c->welcome\_message
763 Returns the Catalyst welcome HTML page.
767 Contains a hash of options passed from the application script, including
768 the original ARGV the script received, the processed values from that
769 ARGV and any extra arguments to the script which were not processed.
771 This can be used to add custom options to your application's scripts
772 and setup your application differently depending on the values of these
777 These methods are not meant to be used by end users.
781 Returns a hash of components.
783 ## $c->context\_class
785 Returns or sets the context class.
789 Returns a hashref containing coderefs and execution counts (needed for
790 deep recursion detection).
794 Returns the number of actions on the current internal execution stack.
798 Dispatches a request to actions.
800 ## $c->dispatcher\_class
802 Returns or sets the dispatcher class.
806 Returns a list of 2-element array references (name, structure) pairs
807 that will be dumped on the error page in debug mode.
811 Returns or sets the engine class.
813 ## $c->execute( $class, $coderef )
815 Execute a coderef in given class and catch exceptions. Errors are available
820 Finalizes the request.
822 ## $c->finalize\_body
826 ## $c->finalize\_cookies
830 ## $c->finalize\_error
832 Finalizes error. If there is only one error in ["error"](#error) and it is an object that
833 does `as_psgi` or `code` we rethrow the error and presume it caught by middleware
834 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
835 return the default error page (production mode).
837 ## $c->finalize\_headers
841 ## $c->finalize\_encoding
843 Make sure your body is encoded properly IF you set an encoding. By
844 default the encoding is UTF-8 but you can disable it by explicitly setting the
845 encoding configuration value to undef.
847 We can only encode when the body is a scalar. Methods for encoding via the
848 streaming interfaces (such as `write` and `write_fh` on [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response)
851 See ["ENCODING"](#encoding).
853 ## $c->finalize\_output
855 An alias for finalize\_body.
857 ## $c->finalize\_read
859 Finalizes the input after reading is complete.
861 ## $c->finalize\_uploads
863 Finalizes uploads. Cleans up any temporary files.
865 ## $c->get\_action( $action, $namespace )
867 Gets an action in a given namespace.
869 ## $c->get\_actions( $action, $namespace )
871 Gets all actions of a given name in a namespace and all parent
874 ## $app->handle\_request( @arguments )
876 Called to handle each HTTP request.
878 ## $class->prepare( @arguments )
880 Creates a Catalyst context from an engine-specific request (Apache, CGI,
883 ## $c->prepare\_action
885 Prepares action. See [Catalyst::Dispatcher](https://metacpan.org/pod/Catalyst::Dispatcher).
889 Prepares message body.
891 ## $c->prepare\_body\_chunk( $chunk )
893 Prepares a chunk of data before sending it to [HTTP::Body](https://metacpan.org/pod/HTTP::Body).
895 See [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine).
897 ## $c->prepare\_body\_parameters
899 Prepares body parameters.
901 ## $c->prepare\_connection
905 ## $c->prepare\_cookies
907 Prepares cookies by ensuring that the attribute on the request
908 object has been built.
910 ## $c->prepare\_headers
912 Prepares request headers by ensuring that the attribute on the request
913 object has been built.
915 ## $c->prepare\_parameters
921 Prepares path and base.
923 ## $c->prepare\_query\_parameters
925 Prepares query parameters.
929 Writes information about the request to the debug logs. This includes:
931 - Request method, path, and remote IP address
932 - Query keywords (see ["query\_keywords" in Catalyst::Request](https://metacpan.org/pod/Catalyst::Request#query_keywords))
938 Writes information about the response to the debug logs by calling
939 `$c->log_response_status_line` and `$c->log_response_headers`.
941 ## $c->log\_response\_status\_line($response)
943 Writes one line of information about the response to the debug logs. This includes:
945 - Response status code
946 - Content-Type header (if present)
947 - Content-Length header (if present)
949 ## $c->log\_response\_headers($headers);
951 Hook method which can be wrapped by plugins to log the response headers.
952 No-op in the default implementation.
954 ## $c->log\_request\_parameters( query => {}, body => {} )
956 Logs request parameters to debug logs
958 ## $c->log\_request\_uploads
960 Logs file uploads included in the request to the debug logs.
961 The parameter name, filename, file type, and file size are all included in
964 ## $c->log\_request\_headers($headers);
966 Hook method which can be wrapped by plugins to log the request headers.
967 No-op in the default implementation.
969 ## $c->log\_headers($type => $headers)
971 Logs [HTTP::Headers](https://metacpan.org/pod/HTTP::Headers) (either request or response) to the debug logs.
975 Prepares the input for reading.
977 ## $c->prepare\_request
979 Prepares the engine request.
981 ## $c->prepare\_uploads
985 ## $c->prepare\_write
987 Prepares the output for writing.
989 ## $c->request\_class
991 Returns or sets the request class. Defaults to [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request).
993 ## $app->request\_class\_traits
995 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s which are applied to the request class. You can
996 name the full namespace of the role, or a namespace suffix, which will then
997 be tried against the following standard namespace prefixes.
999 $MyApp::TraitFor::Request::$trait_suffix
1000 Catalyst::TraitFor::Request::$trait_suffix
1002 So for example if you set:
1004 MyApp->request_class_traits(['Foo']);
1006 We try each possible role in turn (and throw an error if none load)
1009 MyApp::TraitFor::Request::Foo
1010 Catalyst::TraitFor::Request::Foo
1012 The namespace part 'TraitFor::Request' was chosen to assist in backwards
1013 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1014 these features in a stand alone package.
1016 ## $app->composed\_request\_class
1018 This is the request class which has been composed with any request\_class\_traits.
1020 ## $c->response\_class
1022 Returns or sets the response class. Defaults to [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response).
1024 ## $app->response\_class\_traits
1026 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s which are applied to the response class. You can
1027 name the full namespace of the role, or a namespace suffix, which will then
1028 be tried against the following standard namespace prefixes.
1030 $MyApp::TraitFor::Response::$trait_suffix
1031 Catalyst::TraitFor::Response::$trait_suffix
1033 So for example if you set:
1035 MyApp->response_class_traits(['Foo']);
1037 We try each possible role in turn (and throw an error if none load)
1040 MyApp::TraitFor::Response::Foo
1041 Catalyst::TraitFor::Responset::Foo
1043 The namespace part 'TraitFor::Response' was chosen to assist in backwards
1044 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1045 these features in a stand alone package.
1047 ## $app->composed\_response\_class
1049 This is the request class which has been composed with any response\_class\_traits.
1051 ## $c->read( \[$maxlength\] )
1053 Reads a chunk of data from the request body. This method is designed to
1054 be used in a while loop, reading `$maxlength` bytes on every call.
1055 `$maxlength` defaults to the size of the request if not specified.
1057 You have to set `MyApp->config(parse_on_demand => 1)` to use this
1060 Warning: If you use read(), Catalyst will not process the body,
1061 so you will not be able to access POST parameters or file uploads via
1062 $c->request. You must handle all body parsing yourself.
1068 ## $c->set\_action( $action, $code, $namespace, $attrs )
1070 Sets an action in a given namespace.
1072 ## $c->setup\_actions($component)
1074 Sets up actions for a component.
1076 ## $c->setup\_components
1078 This method is called internally to set up the application's components.
1080 It finds modules by calling the [locate\_components](https://metacpan.org/pod/locate_components) method, expands them to
1081 package names with the [expand\_component\_module](https://metacpan.org/pod/expand_component_module) method, and then installs
1082 each component into the application.
1084 The `setup_components` config option is passed to both of the above methods.
1086 Installation of each component is performed by the [setup\_component](https://metacpan.org/pod/setup_component) method,
1089 ## $app->setup\_injected\_components
1091 Called by setup\_compoents to setup components that are injected.
1093 ## $app->setup\_injected\_component( $injected\_component\_name, $config )
1095 Setup a given injected component.
1097 ## $app->inject\_component($MyApp\_Component\_name => \\%args);
1099 Add a component that is injected at setup:
1101 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
1103 Must be called before ->setup. Expects a component name for your
1104 current application and \\%args where
1108 The target component being injected into your application
1112 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that are applied to your component.
1116 MyApp->inject_component(
1118 from_component => 'Common::Model::Foo',
1119 roles => ['Role1', 'Role2'],
1122 ## $app->inject\_components
1124 Inject a list of components:
1126 MyApp->inject_components(
1127 'Model::FooOne' => {
1128 from_component => 'Common::Model::Foo',
1129 roles => ['Role1', 'Role2'],
1131 'Model::FooTwo' => {
1132 from_component => 'Common::Model::Foo',
1133 roles => ['Role1', 'Role2'],
1136 ## $c->locate\_components( $setup\_component\_config )
1138 This method is meant to provide a list of component modules that should be
1139 setup for the application. By default, it will use [Module::Pluggable](https://metacpan.org/pod/Module::Pluggable).
1141 Specify a `setup_components` config option to pass additional options directly
1142 to [Module::Pluggable](https://metacpan.org/pod/Module::Pluggable). To add additional search paths, specify a key named
1143 `search_extra` as an array reference. Items in the array beginning with `::`
1144 will have the application class name prepended to them.
1146 ## $c->expand\_component\_module( $component, $setup\_component\_config )
1148 Components found by `locate_components` will be passed to this method, which
1149 is expected to return a list of component (package) names to be set up.
1151 ## $app->delayed\_setup\_component
1153 Returns a coderef that points to a setup\_component instance. Used
1154 internally for when you want to delay setup until the first time
1155 the component is called.
1157 ## $c->setup\_component
1159 ## $app->config\_for( $component\_name )
1161 Return the application level configuration (which is not yet merged with any
1162 local component configuration, via $component\_class->config) for the named
1163 component or component object. Example:
1166 'Model::Foo' => { a => 1, b => 2},
1169 my $config = MyApp->config_for('MyApp::Model::Foo');
1171 In this case $config is the hashref ` {a=`1, b=>2} >.
1173 This is also handy for looking up configuration for a plugin, to make sure you follow
1174 existing [Catalyst](https://metacpan.org/pod/Catalyst) standards for where a plugin should put its configuration.
1176 ## $c->setup\_dispatcher
1180 ## $c->setup\_engine
1184 ## $c->apply\_default\_middlewares
1186 Adds the following [Plack](https://metacpan.org/pod/Plack) middlewares to your application, since they are
1187 useful and commonly needed:
1189 [Plack::Middleware::LighttpdScriptNameFix](https://metacpan.org/pod/Plack::Middleware::LighttpdScriptNameFix) (if you are using Lighttpd),
1190 [Plack::Middleware::IIS6ScriptNameFix](https://metacpan.org/pod/Plack::Middleware::IIS6ScriptNameFix) (always applied since this middleware
1191 is smart enough to conditionally apply itself).
1193 We will also automatically add [Plack::Middleware::ReverseProxy](https://metacpan.org/pod/Plack::Middleware::ReverseProxy) if we notice
1194 that your HTTP $env variable `REMOTE_ADDR` is '127.0.0.1'. This is usually
1195 an indication that your server is running behind a proxy frontend. However in
1196 2014 this is often not the case. We preserve this code for backwards compatibility
1197 however I **highly** recommend that if you are running the server behind a front
1198 end proxy that you clearly indicate so with the `using_frontend_proxy` configuration
1199 setting to true for your environment configurations that run behind a proxy. This
1200 way if you change your front end proxy address someday your code would inexplicably
1201 stop working as expected.
1203 Additionally if we detect we are using Nginx, we add a bit of custom middleware
1204 to solve some problems with the way that server handles $ENV{PATH\_INFO} and
1207 Please **NOTE** that if you do use `using_frontend_proxy` the middleware is now
1208 adding via `registered_middleware` rather than this method.
1210 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
1211 general this is no longer a common case but we have this here for backward
1218 Returns a PSGI application code reference for the catalyst application
1219 `$c`. This is the bare application created without the `apply_default_middlewares`
1220 method called. We do however apply `registered_middleware` since those are
1221 integral to how [Catalyst](https://metacpan.org/pod/Catalyst) functions. Also, unlike starting your application
1222 with a generated server script (via [Catalyst::Devel](https://metacpan.org/pod/Catalyst::Devel) and `catalyst.pl`) we do
1223 not attempt to return a valid [PSGI](https://metacpan.org/pod/PSGI) application using any existing `${myapp}.psgi`
1224 scripts in your $HOME directory.
1226 **NOTE** `apply_default_middlewares` was originally created when the first PSGI
1227 port was done for v5.90000. These are middlewares that are added to achieve
1228 backward compatibility with older applications. If you start your application
1229 using one of the supplied server scripts (generated with [Catalyst::Devel](https://metacpan.org/pod/Catalyst::Devel) and
1230 the project skeleton script `catalyst.pl`) we apply `apply_default_middlewares`
1231 automatically. This was done so that pre and post PSGI port applications would
1234 This is what you want to be using to retrieve the PSGI application code
1235 reference of your Catalyst application for use in a custom `.psgi` or in your
1236 own created server modules.
1240 Sets up the home directory.
1242 ## $c->setup\_encoding
1244 Sets up the input/output encoding. See [ENCODING](https://metacpan.org/pod/ENCODING)
1246 ## handle\_unicode\_encoding\_exception
1248 Hook to let you customize how encoding errors are handled. By default
1249 we just throw an exception and the default error page will pick it up.
1250 Receives a hashref of debug information. Example of call (from the
1251 Catalyst internals):
1253 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
1254 param_value => $value,
1256 encoding_step => 'params',
1259 The calling code expects to receive a decoded string or an exception.
1261 You can override this for custom handling of unicode errors. By
1262 default we just die. If you want a custom response here, one approach
1263 is to throw an HTTP style exception, instead of returning a decoded
1264 string or throwing a generic exception.
1266 sub handle_unicode_encoding_exception {
1267 my ($c, $params) = @_;
1268 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
1271 Alternatively you can 'catch' the error, stash it and write handling code later
1272 in your application:
1274 sub handle_unicode_encoding_exception {
1275 my ($c, $params) = @_;
1276 $c->stash(BAD_UNICODE_DATA=>$params);
1277 # return a dummy string.
1281 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
1282 the request setup is still ongoing, which means the state of `$c` and
1283 related context parts like the request and response may not be setup
1284 up correctly (since we haven't finished the setup yet). If you throw
1285 an exception the setup is aborted.
1289 Sets up log by instantiating a [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) object and
1290 passing it to `log()`. Pass in a comma-delimited list of levels to set the
1293 This method also installs a `debug` method that returns a true value into the
1294 catalyst subclass if the "debug" level is passed in the comma-delimited list,
1295 or if the `$CATALYST_DEBUG` environment variable is set to a true value.
1297 Note that if the log has already been setup, by either a previous call to
1298 `setup_log` or by a call such as `__PACKAGE__->log( MyLogger->new )`,
1299 that this method won't actually set up the log object.
1301 ## $c->setup\_plugins
1307 Sets up timing statistics class.
1309 ## $c->registered\_plugins
1311 Returns a sorted list of the plugins which have either been stated in the
1314 If passed a given plugin name, it will report a boolean value indicating
1315 whether or not that plugin is loaded. A fully qualified name is required if
1316 the plugin name does not begin with `Catalyst::Plugin::`.
1318 if ($c->registered_plugins('Some::Plugin')) {
1322 ## default\_middleware
1324 Returns a list of instantiated PSGI middleware objects which is the default
1325 middleware that is active for this application (taking any configuration
1326 options into account, excluding your custom added middleware via the `psgi_middleware`
1327 configuration option). You can override this method if you wish to change
1328 the default middleware (although do so at risk since some middleware is vital
1329 to application function.)
1331 The current default middleware list is:
1333 Catalyst::Middleware::Stash
1334 Plack::Middleware::HTTPExceptions
1335 Plack::Middleware::RemoveRedundantBody
1336 Plack::Middleware::FixMissingBodyInRedirect
1337 Plack::Middleware::ContentLength
1338 Plack::Middleware::MethodOverride
1339 Plack::Middleware::Head
1341 If the configuration setting `using_frontend_proxy` is true we add:
1343 Plack::Middleware::ReverseProxy
1345 If the configuration setting `using_frontend_proxy_path` is true we add:
1347 Plack::Middleware::ReverseProxyPath
1349 But **NOTE** that [Plack::Middleware::ReverseProxyPath](https://metacpan.org/pod/Plack::Middleware::ReverseProxyPath) is not a dependency of the
1350 [Catalyst](https://metacpan.org/pod/Catalyst) distribution so if you want to use this option you should add it to
1351 your project distribution file.
1353 These middlewares will be added at ["setup\_middleware"](#setup_middleware) during the
1354 ["setup"](#setup) phase of application startup.
1356 ## registered\_middlewares
1358 Read only accessor that returns an array of all the middleware in the order
1359 that they were added (which is the REVERSE of the order they will be applied).
1361 The values returned will be either instances of [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) or of a
1362 compatible interface, or a coderef, which is assumed to be inlined middleware
1364 ## setup\_middleware (?@middleware)
1366 Read configuration information stored in configuration key `psgi_middleware` or
1369 See under ["CONFIGURATION"](#configuration) information regarding `psgi_middleware` and how
1370 to use it to enable [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware)
1372 This method is automatically called during 'setup' of your application, so
1373 you really don't need to invoke it. However you may do so if you find the idea
1374 of loading middleware via configuration weird :). For example:
1380 __PACKAGE__->setup_middleware('Head');
1383 When we read middleware definitions from configuration, we reverse the list
1384 which sounds odd but is likely how you expect it to work if you have prior
1385 experience with [Plack::Builder](https://metacpan.org/pod/Plack::Builder) or if you previously used the plugin
1386 [Catalyst::Plugin::EnableMiddleware](https://metacpan.org/pod/Catalyst::Plugin::EnableMiddleware) (which is now considered deprecated)
1388 So basically your middleware handles an incoming request from the first
1389 registered middleware, down and handles the response from the last middleware
1392 ## registered\_data\_handlers
1394 A read only copy of registered Data Handlers returned as a Hash, where each key
1395 is a content type and each value is a subref that attempts to decode that content
1398 ## setup\_data\_handlers (?@data\_handler)
1400 Read configuration information stored in configuration key `data_handlers` or
1403 See under ["CONFIGURATION"](#configuration) information regarding `data_handlers`.
1405 This method is automatically called during 'setup' of your application, so
1406 you really don't need to invoke it.
1408 ## default\_data\_handlers
1410 Default Data Handlers that come bundled with [Catalyst](https://metacpan.org/pod/Catalyst). Currently there are
1411 only two default data handlers, for 'application/json' and an alternative to
1412 'application/x-www-form-urlencoded' which supposed nested form parameters via
1413 [CGI::Struct](https://metacpan.org/pod/CGI::Struct) or via [CGI::Struct::XS](https://metacpan.org/pod/CGI::Struct::XS) IF you've installed it.
1415 The 'application/json' data handler is used to parse incoming JSON into a Perl
1416 data structure. It used either [JSON::MaybeXS](https://metacpan.org/pod/JSON::MaybeXS) or [JSON](https://metacpan.org/pod/JSON), depending on which
1417 is installed. This allows you to fail back to [JSON:PP](JSON:PP), which is a Pure Perl
1418 JSON decoder, and has the smallest dependency impact.
1420 Because we don't wish to add more dependencies to [Catalyst](https://metacpan.org/pod/Catalyst), if you wish to
1421 use this new feature we recommend installing [JSON](https://metacpan.org/pod/JSON) or [JSON::MaybeXS](https://metacpan.org/pod/JSON::MaybeXS) in
1422 order to get the best performance. You should add either to your dependency
1423 list (Makefile.PL, dist.ini, cpanfile, etc.)
1427 Returns an arrayref of the internal execution stack (actions that are
1428 currently executing).
1432 Returns the current timing statistics object. By default Catalyst uses
1433 [Catalyst::Stats](https://metacpan.org/pod/Catalyst::Stats), but can be set otherwise with
1434 [stats\_class](#c-stats_class).
1436 Even if [-Stats](#stats) is not enabled, the stats object is still
1437 available. By enabling it with ` $c-`stats->enabled(1) >, it can be used to
1438 profile explicitly, although MyApp.pm still won't profile nor output anything
1443 Returns or sets the stats (timing statistics) class. [Catalyst::Stats](https://metacpan.org/pod/Catalyst::Stats) is used by default.
1445 ## $app->stats\_class\_traits
1447 A arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that are applied to the stats\_class before creating it.
1449 ## $app->composed\_stats\_class
1451 this is the stats\_class composed with any 'stats\_class\_traits'. You can
1452 name the full namespace of the role, or a namespace suffix, which will then
1453 be tried against the following standard namespace prefixes.
1455 $MyApp::TraitFor::Stats::$trait_suffix
1456 Catalyst::TraitFor::Stats::$trait_suffix
1458 So for example if you set:
1460 MyApp->stats_class_traits(['Foo']);
1462 We try each possible role in turn (and throw an error if none load)
1465 MyApp::TraitFor::Stats::Foo
1466 Catalyst::TraitFor::Stats::Foo
1468 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
1469 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1470 these features in a stand alone package.
1474 Returns 1 when [stats collection](#stats) is enabled.
1476 Note that this is a static method, not an accessor and should be overridden
1477 by declaring `sub use_stats { 1 }` in your MyApp.pm, not by calling `$c->use_stats(1)`.
1479 ## $c->write( $data )
1481 Writes $data to the output stream. When using this method directly, you
1482 will need to manually set the `Content-Length` header to the length of
1483 your output data, if known.
1487 Returns the Catalyst version number. Mostly useful for "powered by"
1488 messages in template systems.
1492 There are a number of 'base' config variables which can be set:
1494 - `always_catch_http_exceptions` - As of version 5.90060 Catalyst
1495 rethrows errors conforming to the interface described by
1496 [Plack::Middleware::HTTPExceptions](https://metacpan.org/pod/Plack::Middleware::HTTPExceptions) and lets the middleware deal with it.
1497 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
1498 - `default_model` - The default model picked if you say `$c->model`. See ["$c->model($name)"](#c-model-name).
1499 - `default_view` - The default view to be rendered or returned when `$c->view` is called. See ["$c->view($name)"](#c-view-name).
1500 - `disable_component_resolution_regex_fallback` - Turns
1501 off the deprecated component resolution functionality so
1502 that if any of the component methods (e.g. `$c->controller('Foo')`)
1503 are called then regex search will not be attempted on string values and
1504 instead `undef` will be returned.
1505 - `home` - The application home directory. In an uninstalled application,
1506 this is the top level application directory. In an installed application,
1507 this will be the directory containing `MyApp.pm`.
1508 - `ignore_frontend_proxy` - See ["PROXY SUPPORT"](#proxy-support)
1509 - `name` - The name of the application in debug messages and the debug and
1511 - `parse_on_demand` - The request body (for example file uploads) will not be parsed
1512 until it is accessed. This allows you to (for example) check authentication (and reject
1513 the upload) before actually receiving all the data. See ["ON-DEMAND PARSER"](#on-demand-parser)
1514 - `root` - The root directory for templates. Usually this is just a
1515 subdirectory of the home directory, but you can set it to change the
1516 templates to a different directory.
1517 - `search_extra` - Array reference passed to Module::Pluggable to for additional
1518 namespaces from which components will be loaded (and constructed and stored in
1520 - `show_internal_actions` - If true, causes internal actions such as `_DISPATCH`
1521 to be shown in hit debug tables in the test server.
1522 - `use_request_uri_for_path` - Controls if the `REQUEST_URI` or `PATH_INFO` environment
1523 variable should be used for determining the request path.
1525 Most web server environments pass the requested path to the application using environment variables,
1526 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
1527 exposed as `$c->request->base`) and the request path below that base.
1529 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
1530 is determined by the `$c->config(use_request_uri_for_path)` setting (which can either be true or false).
1532 - use\_request\_uri\_for\_path => 0
1534 This is the default (and the) traditional method that Catalyst has used for determining the path information.
1535 The path is generated from a combination of the `PATH_INFO` and `SCRIPT_NAME` environment variables.
1536 The allows the application to behave correctly when `mod_rewrite` is being used to redirect requests
1537 into the application, as these variables are adjusted by mod\_rewrite to take account for the redirect.
1539 However this method has the major disadvantage that it is impossible to correctly decode some elements
1540 of the path, as RFC 3875 says: "`Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
1541 contain path-segment parameters.`" This means PATH\_INFO is **always** decoded, and therefore Catalyst
1542 can't distinguish / vs %2F in paths (in addition to other encoded values).
1544 - use\_request\_uri\_for\_path => 1
1546 This method uses the `REQUEST_URI` and `SCRIPT_NAME` environment variables. As `REQUEST_URI` is never
1547 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
1548 (i.e. with `AllowEncodedSlashes` set to `On` in Apache).
1550 Given that this method of path resolution is provably more correct, it is recommended that you use
1551 this unless you have a specific need to deploy your application in a non-standard environment, and you are
1552 aware of the implications of not being able to handle encoded URI paths correctly.
1554 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
1555 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public\_html directory, with mod\_rewrite in a
1556 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
1557 at other URIs than that which the app is 'normally' based at with `mod_rewrite`), the resolution of
1558 `$c->request->base` will be incorrect.
1560 - `using_frontend_proxy` - See ["PROXY SUPPORT"](#proxy-support).
1561 - `using_frontend_proxy_path` - Enabled [Plack::Middleware::ReverseProxyPath](https://metacpan.org/pod/Plack::Middleware::ReverseProxyPath) on your application (if
1562 installed, otherwise log an error). This is useful if your application is not running on the
1563 'root' (or /) of your host server. **NOTE** if you use this feature you should add the required
1564 middleware to your project dependency list since its not automatically a dependency of [Catalyst](https://metacpan.org/pod/Catalyst).
1565 This has been done since not all people need this feature and we wish to restrict the growth of
1566 [Catalyst](https://metacpan.org/pod/Catalyst) dependencies.
1567 - `encoding` - See ["ENCODING"](#encoding)
1569 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
1572 - `abort_chain_on_error_fix`
1576 When there is an error in an action chain, the default behavior is to
1577 abort the processing of the remaining actions to avoid running them
1578 when the application is in an unexpected state.
1580 Before version 5.90070, the default used to be false. To keep the old
1581 behaviour, you can explicitely set the value to false. E.g.
1583 __PACKAGE__->config(abort_chain_on_error_fix => 0);
1585 If this setting is set to false, then the remaining actions are
1586 performed and the error is caught at the end of the chain.
1588 - `use_hash_multivalue_in_request`
1590 In [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) the methods `query_parameters`, `body_parametes`
1591 and `parameters` return a hashref where values might be scalar or an arrayref
1592 depending on the incoming data. In many cases this can be undesirable as it
1593 leads one to writing defensive code like the following:
1595 my ($val) = ref($c->req->parameters->{a}) ?
1596 @{$c->req->parameters->{a}} :
1597 $c->req->parameters->{a};
1599 Setting this configuration item to true will make [Catalyst](https://metacpan.org/pod/Catalyst) populate the
1600 attributes underlying these methods with an instance of [Hash::MultiValue](https://metacpan.org/pod/Hash::MultiValue)
1601 which is used by [Plack::Request](https://metacpan.org/pod/Plack::Request) and others to solve this very issue. You
1602 may prefer this behavior to the default, if so enable this option (be warned
1603 if you enable it in a legacy application we are not sure if it is completely
1604 backwardly compatible).
1606 - `skip_complex_post_part_handling`
1608 When creating body parameters from a POST, if we run into a multipart POST
1609 that does not contain uploads, but instead contains inlined complex data
1610 (very uncommon) we cannot reliably convert that into field => value pairs. So
1611 instead we create an instance of [Catalyst::Request::PartData](https://metacpan.org/pod/Catalyst::Request::PartData). If this causes
1612 issue for you, you can disable this by setting `skip_complex_post_part_handling`
1613 to true (default is false).
1615 - `skip_body_param_unicode_decoding`
1617 Generally we decode incoming POST params based on your declared encoding (the
1618 default for this is to decode UTF-8). If this is causing you trouble and you
1619 do not wish to turn all encoding support off (with the `encoding` configuration
1620 parameter) you may disable this step atomically by setting this configuration
1623 - `do_not_decode_query`
1625 If true, then do not try to character decode any wide characters in your
1626 request URL query or keywords. Most readings of the relevant specifications
1627 suggest these should be UTF-\* encoded, which is the default that [Catalyst](https://metacpan.org/pod/Catalyst)
1628 will use, however if you are creating a lot of URLs manually or have external
1629 evil clients, this might cause you trouble. If you find the changes introduced
1630 in Catalyst version 5.90080+ break some of your query code, you may disable
1631 the UTF-8 decoding globally using this configuration.
1633 This setting takes precedence over `default_query_encoding`
1635 - `do_not_check_query_encoding`
1637 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
1638 request but would not raise an exception when the decoding failed due to
1639 incorrect unicode. It now does, but if this change is giving you trouble
1640 you may disable it by setting this configuration to true.
1642 - `default_query_encoding`
1644 By default we decode query and keywords in your request URL using UTF-8, which
1645 is our reading of the relevant specifications. This setting allows one to
1646 specify a fixed value for how to decode your query. You might need this if
1647 you are doing a lot of custom encoding of your URLs and not using UTF-8.
1649 - `use_chained_args_0_special_case`
1651 In older versions of Catalyst, when more than one action matched the same path
1652 AND all those matching actions declared Args(0), we'd break the tie by choosing
1653 the first action defined. We now normalized how Args(0) works so that it
1654 follows the same rule as Args(N), which is to say when we need to break a tie
1655 we choose the LAST action defined. If this breaks your code and you don't
1656 have time to update to follow the new normalized approach, you may set this
1657 value to true and it will globally revert to the original chaining behavior.
1659 - `psgi_middleware` - See ["PSGI MIDDLEWARE"](#psgi-middleware).
1660 - `data_handlers` - See ["DATA HANDLERS"](#data-handlers).
1661 - `stats_class_traits`
1663 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your stats class.
1665 - `request_class_traits`
1667 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your request class.
1669 - `response_class_traits`
1671 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your response class.
1673 - `inject_components`
1675 A Hashref of [Catalyst::Component](https://metacpan.org/pod/Catalyst::Component) subclasses that are 'injected' into configuration.
1679 inject_components => {
1680 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
1681 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
1682 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
1684 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
1685 'Model::Zoo' => { a => 2 },
1686 'Model::Foo' => { a => 100 },
1689 Generally [Catalyst](https://metacpan.org/pod/Catalyst) looks for components in your Model/View or Controller directories.
1690 However for cases when you which to use an existing component and you don't need any
1691 customization (where for when you can apply a role to customize it) you may inject those
1692 components into your application. Please note any configuration should be done 'in the
1693 normal way', with a key under configuration named after the component affix, as in the
1696 Using this type of injection allows you to construct significant amounts of your application
1697 with only configuration!. This may or may not lead to increased code understanding.
1699 Please not you may also call the ->inject\_components application method as well, although
1700 you must do so BEFORE setup.
1704 Generally when you throw an exception inside an Action (or somewhere in
1705 your stack, such as in a model that an Action is calling) that exception
1706 is caught by Catalyst and unless you either catch it yourself (via eval
1707 or something like [Try::Tiny](https://metacpan.org/pod/Try::Tiny) or by reviewing the ["error"](#error) stack, it
1708 will eventually reach ["finalize\_errors"](#finalize_errors) and return either the debugging
1709 error stack page, or the default error page. However, if your exception
1710 can be caught by [Plack::Middleware::HTTPExceptions](https://metacpan.org/pod/Plack::Middleware::HTTPExceptions), [Catalyst](https://metacpan.org/pod/Catalyst) will
1711 instead rethrow it so that it can be handled by that middleware (which
1712 is part of the default middleware). For example this would allow
1714 use HTTP::Throwable::Factory 'http_throw';
1716 sub throws_exception :Local {
1717 my ($self, $c) = @_;
1719 http_throw(SeeOther => { location =>
1720 $c->uri_for($self->action_for('redirect')) });
1726 Catalyst uses internal actions like `_DISPATCH`, `_BEGIN`, `_AUTO`,
1727 `_ACTION`, and `_END`. These are by default not shown in the private
1728 action table, but you can make them visible with a config parameter.
1730 MyApp->config(show_internal_actions => 1);
1734 The request body is usually parsed at the beginning of a request,
1735 but if you want to handle input yourself, you can enable on-demand
1736 parsing with a config parameter.
1738 MyApp->config(parse_on_demand => 1);
1742 Many production servers operate using the common double-server approach,
1743 with a lightweight frontend web server passing requests to a larger
1744 backend server. An application running on the backend server must deal
1745 with two problems: the remote user always appears to be `127.0.0.1` and
1746 the server's hostname will appear to be `localhost` regardless of the
1747 virtual host that the user connected through.
1749 Catalyst will automatically detect this situation when you are running
1750 the frontend and backend servers on the same machine. The following
1751 changes are made to the request.
1753 $c->req->address is set to the user's real IP address, as read from
1754 the HTTP X-Forwarded-For header.
1756 The host value for $c->req->base and $c->req->uri is set to the real
1757 host, as read from the HTTP X-Forwarded-Host header.
1759 Additionally, you may be running your backend application on an insecure
1760 connection (port 80) while your frontend proxy is running under SSL. If there
1761 is a discrepancy in the ports, use the HTTP header `X-Forwarded-Port` to
1762 tell Catalyst what port the frontend listens on. This will allow all URIs to
1763 be created properly.
1765 In the case of passing in:
1767 X-Forwarded-Port: 443
1769 All calls to `uri_for` will result in an https link, as is expected.
1771 Obviously, your web server must support these headers for this to work.
1773 In a more complex server farm environment where you may have your
1774 frontend proxy server(s) on different machines, you will need to set a
1775 configuration option to tell Catalyst to read the proxied data from the
1778 MyApp->config(using_frontend_proxy => 1);
1780 If you do not wish to use the proxy support at all, you may set:
1782 MyApp->config(ignore_frontend_proxy => 0);
1784 ## Note about psgi files
1786 Note that if you supply your own .psgi file, calling
1787 `MyApp->psgi_app(@_);`, then **this will not happen automatically**.
1789 You either need to apply [Plack::Middleware::ReverseProxy](https://metacpan.org/pod/Plack::Middleware::ReverseProxy) yourself
1790 in your psgi, for example:
1793 enable "Plack::Middleware::ReverseProxy";
1797 This will unconditionally add the ReverseProxy support, or you need to call
1798 `$app = MyApp->apply_default_middlewares($app)` (to conditionally
1799 apply the support depending upon your config).
1801 See [Catalyst::PSGI](https://metacpan.org/pod/Catalyst::PSGI) for more information.
1805 Catalyst has been tested under Apache 2's threading `mpm_worker`,
1806 `mpm_winnt`, and the standalone forking HTTP server on Windows. We
1807 believe the Catalyst core to be thread-safe.
1809 If you plan to operate in a threaded environment, remember that all other
1810 modules you are using must also be thread-safe. Some modules, most notably
1811 [DBD::SQLite](https://metacpan.org/pod/DBD::SQLite), are not thread-safe.
1815 The [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) object uses [HTTP::Body](https://metacpan.org/pod/HTTP::Body) to populate 'classic' HTML
1816 form parameters and URL search query fields. However it has become common
1817 for various alternative content types to be PUT or POSTed to your controllers
1818 and actions. People working on RESTful APIs, or using AJAX often use JSON,
1819 XML and other content types when communicating with an application server. In
1820 order to better support this use case, [Catalyst](https://metacpan.org/pod/Catalyst) defines a global configuration
1821 option, `data_handlers`, which lets you associate a content type with a coderef
1822 that parses that content type into something Perl can readily access.
1829 __PACKAGE__->config(
1831 'application/json' => sub { local $/; decode_json $_->getline },
1833 ## Any other configuration.
1838 By default [Catalyst](https://metacpan.org/pod/Catalyst) comes with a generic JSON data handler similar to the
1839 example given above, which uses [JSON::Maybe](https://metacpan.org/pod/JSON::Maybe) to provide either [JSON::PP](https://metacpan.org/pod/JSON::PP)
1840 (a pure Perl, dependency free JSON parser) or [Cpanel::JSON::XS](https://metacpan.org/pod/Cpanel::JSON::XS) if you have
1841 it installed (if you want the faster XS parser, add it to you project Makefile.PL
1842 or dist.ini, cpanfile, etc.)
1844 The `data_handlers` configuration is a hashref whose keys are HTTP Content-Types
1845 (matched against the incoming request type using a regexp such as to be case
1846 insensitive) and whose values are coderefs that receive a localized version of
1847 `$_` which is a filehandle object pointing to received body.
1849 This feature is considered an early access release and we reserve the right
1850 to alter the interface in order to provide a performant and secure solution to
1851 alternative request body content. Your reports welcomed!
1855 You can define middleware, defined as [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) or a compatible
1856 interface in configuration. Your middleware definitions are in the form of an
1857 arrayref under the configuration key `psgi_middleware`. Here's an example
1858 with details to follow:
1863 use Plack::Middleware::StackTrace;
1865 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
1867 __PACKAGE__->config(
1868 'psgi_middleware', [
1871 $stacktrace_middleware,
1872 'Session' => {store => 'File'},
1877 $env->{myapp.customkey} = 'helloworld';
1886 So the general form is:
1888 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
1890 Where `@middleware` is one or more of the following, applied in the REVERSE of
1891 the order listed (to make it function similarly to [Plack::Builder](https://metacpan.org/pod/Plack::Builder):
1893 Alternatively, you may also define middleware by calling the ["setup\_middleware"](#setup_middleware)
1900 __PACKAGE__->setup_middleware( \@middleware_definitions);
1903 In the case where you do both (use 'setup\_middleware' and configuration) the
1904 package call to setup\_middleware will be applied earlier (in other words its
1905 middleware will wrap closer to the application). Keep this in mind since in
1906 some cases the order of middleware is important.
1908 The two approaches are not exclusive.
1912 An already initialized object that conforms to the [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware)
1915 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
1917 __PACKAGE__->config(
1918 'psgi_middleware', [
1919 $stacktrace_middleware,
1926 A coderef that is an inlined middleware:
1928 __PACKAGE__->config(
1929 'psgi_middleware', [
1934 if($env->{PATH_INFO} =~m/forced/) {
1936 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
1939 return $app->($env);
1950 We assume the scalar refers to a namespace after normalizing it using the
1953 (1) If the scalar is prefixed with a "+" (as in `+MyApp::Foo`) then the full string
1954 is assumed to be 'as is', and we just install and use the middleware.
1956 (2) If the scalar begins with "Plack::Middleware" or your application namespace
1957 (the package name of your Catalyst application subclass), we also assume then
1958 that it is a full namespace, and use it.
1960 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
1961 resolve it first by looking for it under your application namespace (for example
1962 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
1963 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
1964 will then look under the regular [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) namespace (i.e. for the
1965 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
1966 namespace first to let you 'override' common [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) locally, should
1967 you find that a good idea.
1973 __PACKAGE__->config(
1974 'psgi_middleware', [
1975 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
1976 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
1977 '+MyApp::Custom', ## MyApp::Custom->wrap
1982 - a scalar followed by a hashref
1984 Just like the previous, except the following `HashRef` is used as arguments
1985 to initialize the middleware object.
1987 __PACKAGE__->config(
1988 'psgi_middleware', [
1989 'Session' => {store => 'File'},
1992 Please see [PSGI](https://metacpan.org/pod/PSGI) for more on middleware.
1996 Starting in [Catalyst](https://metacpan.org/pod/Catalyst) version 5.90080 encoding is automatically enabled
1997 and set to encode all body responses to UTF8 when possible and applicable.
1998 Following is documentation on this process. If you are using an older
1999 version of [Catalyst](https://metacpan.org/pod/Catalyst) you should review documentation for that version since
2002 By default encoding is now 'UTF-8'. You may turn it off by setting
2003 the encoding configuration to undef.
2005 MyApp->config(encoding => undef);
2007 This is recommended for temporary backwards compatibility only.
2009 To turn it off for a single request use the [clear\_encoding](https://metacpan.org/pod/clear_encoding)
2010 method to turn off encoding for this request. This can be useful
2011 when you are setting the body to be an arbitrary block of bytes,
2012 especially if that block happens to be a block of UTF8 text.
2014 Encoding is automatically applied when the content-type is set to
2015 a type that can be encoded. Currently we encode when the content type
2016 matches the following regular expression:
2018 $content_type =~ /^text|xml$|javascript$/
2020 Encoding is set on the application, but it is copied to the context object
2021 so that you can override it on a request basis.
2023 Be default we don't automatically encode 'application/json' since the most
2024 common approaches to generating this type of response (Either via [Catalyst::View::JSON](https://metacpan.org/pod/Catalyst::View::JSON)
2025 or [Catalyst::Action::REST](https://metacpan.org/pod/Catalyst::Action::REST)) will do so already and we want to avoid double
2028 If you are producing JSON response in an unconventional manner (such
2029 as via a template or manual strings) you should perform the UTF8 encoding
2030 manually as well such as to conform to the JSON specification.
2032 NOTE: We also examine the value of $c->response->content\_encoding. If
2033 you set this (like for example 'gzip', and manually gzipping the body)
2034 we assume that you have done all the necessary encoding yourself, since
2035 we cannot encode the gzipped contents. If you use a plugin like
2036 [Catalyst::Plugin::Compress](https://metacpan.org/pod/Catalyst::Plugin::Compress) you need to update to a modern version in order
2037 to have this function correctly with the new UTF8 encoding code, or you
2038 can use [Plack::Middleware::Deflater](https://metacpan.org/pod/Plack::Middleware::Deflater) or (probably best) do your compression on
2045 Returns an instance of an `Encode` encoding
2047 print $c->encoding->name
2049 - handle\_unicode\_encoding\_exception ($exception\_context)
2051 Method called when decoding process for a request fails.
2053 An `$exception_context` hashref is provided to allow you to override the
2054 behaviour of your application when given data with incorrect encodings.
2056 The default method throws exceptions in the case of invalid request parameters
2057 (resulting in a 500 error), but ignores errors in upload filenames.
2059 The keys passed in the `$exception_context` hash are:
2063 The value which was not able to be decoded.
2067 The exception received from [Encode](https://metacpan.org/pod/Encode).
2071 What type of data was being decoded. Valid values are (currently)
2072 `params` - for request parameters / arguments / captures
2073 and `uploads` - for request upload filenames.
2079 Join #catalyst on irc.perl.org.
2083 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2084 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2088 http://catalyst.perl.org
2092 http://dev.catalyst.perl.org
2096 ## [Task::Catalyst](https://metacpan.org/pod/Task::Catalyst) - All you need to start with Catalyst
2098 ## [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) - The Catalyst Manual
2100 ## [Catalyst::Component](https://metacpan.org/pod/Catalyst::Component), [Catalyst::Controller](https://metacpan.org/pod/Catalyst::Controller) - Base classes for components
2102 ## [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine) - Core engine
2104 ## [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) - Log class.
2106 ## [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) - Request object
2108 ## [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response) - Response object
2110 ## [Catalyst::Test](https://metacpan.org/pod/Catalyst::Test) - The test suite.
2114 sri: Sebastian Riedel <sri@cpan.org>
2120 acme: Leon Brocard <leon@astray.com>
2122 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2124 andrewalker: André Walker <andre@cpan.org>
2128 Andrew Ford <A.Ford@ford-mason.co.uk>
2132 andyg: Andy Grundman <andy@hybridized.org>
2134 audreyt: Audrey Tang
2136 bricas: Brian Cassidy <bricas@cpan.org>
2138 Caelum: Rafael Kitover <rkitover@io.com>
2140 chansen: Christian Hansen
2142 Chase Venters `chase.venters@gmail.com`
2144 chicks: Christopher Hicks
2146 Chisel Wright `pause@herlpacker.co.uk`
2148 Danijel Milicevic `me@danijel.de`
2150 davewood: David Schmidt <davewood@cpan.org>
2152 David Kamholz <dkamholz@cpan.org>
2154 David Naughton, `naughton@umn.edu`
2158 dhoss: Devin Austin <dhoss@cpan.org>
2160 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2164 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2166 esskar: Sascha Kiefer
2168 fireartist: Carl Franks <cfranks@cpan.org>
2170 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2172 gabb: Danijel Milicevic
2176 Gavin Henry `ghenry@perl.me.uk`
2180 groditi: Guillermo Roditi <groditi@gmail.com>
2182 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2184 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2186 jcamacho: Juan Camacho
2188 jester: Jesse Sheidlower `jester@panix.com`
2190 jhannah: Jay Hannah <jay@jays.net>
2196 jon: Jon Schutz <jjschutz@cpan.org>
2198 Jonathan Rockway `<jrockway@cpan.org>`
2200 Kieren Diment `kd@totaldatasolution.com`
2202 konobi: Scott McWhirter <konobi@cpan.org>
2204 marcus: Marcus Ramberg <mramberg@cpan.org>
2206 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2208 mgrimes: Mark Grimes <mgrimes@cpan.org>
2210 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2214 naughton: David Naughton
2216 ningu: David Kamholz <dkamholz@cpan.org>
2218 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2220 numa: Dan Sully <daniel@cpan.org>
2226 omega: Andreas Marienborg
2228 Oleg Kostyuk <cub.uanic@gmail.com>
2230 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2232 rafl: Florian Ragwitz <rafl@debian.org>
2234 random: Roland Lammel <lammel@cpan.org>
2236 Robert Sedlacek `<rs@474.at>`
2238 SpiceMan: Marcel Montes
2242 szbalint: Balint Szilakszi <szbalint@cpan.org>
2244 t0m: Tomas Doran <bobtfish@bobtfish.net>
2248 vanstyn: Henry Van Styn <vanstyn@cpan.org>
2250 Viljo Marrandi `vilts@yahoo.com`
2252 Will Hawes `info@whawes.co.uk`
2254 willert: Sebastian Willert <willert@cpan.org>
2256 wreis: Wallace Reis <wreis@cpan.org>
2258 Yuval Kogman, `nothingmuch@woobling.org`
2260 rainboxx: Matthias Dietrich, `perl@rainboxx.de`
2262 dd070: Dhaval Dhanani <dhaval070@gmail.com>
2264 Upasana <me@upasana.me>
2266 John Napiorkowski (jnap) <jjnapiork@cpan.org>
2270 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
2274 This library is free software. You can redistribute it and/or modify it under
2275 the same terms as Perl itself.