3 Catalyst - The Elegant MVC Web Application Framework
7 See the [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) distribution for comprehensive
8 documentation and tutorials.
10 # Install Catalyst::Devel for helpers and other development tools
11 # use the helper to create a new application
14 # add models, views, controllers
15 script/myapp_create.pl model MyDatabase DBIC::Schema create=static dbi:SQLite:/path/to/db
16 script/myapp_create.pl view MyTemplate TT
17 script/myapp_create.pl controller Search
19 # built in testserver -- use -r to restart automatically on changes
20 # --help to see all available options
21 script/myapp_server.pl
23 # command line testing interface
24 script/myapp_test.pl /yada
27 use Catalyst qw/-Debug/; # include plugins here as well
29 ### In lib/MyApp/Controller/Root.pm (autocreated)
30 sub foo : Chained('/') Args() { # called for /foo, /foo/1, /foo/1/2, etc.
31 my ( $self, $c, @args ) = @_; # args are qw/1 2/ for /foo/1/2
32 $c->stash->{template} = 'foo.tt'; # set the template
33 # lookup something from db -- stash vars are passed to TT
35 $c->model('Database::Foo')->search( { country => $args[0] } );
36 if ( $c->req->params->{bar} ) { # access GET or POST parameters
37 $c->forward( 'bar' ); # process another action
38 # do something else after forward returns
42 # The foo.tt TT template can use the stash data from the database
43 [% WHILE (item = data.next) %]
47 # called for /bar/of/soap, /bar/of/soap/10, etc.
48 sub bar : Chained('/') PathPart('/bar/of/soap') Args() { ... }
50 # called after all actions are finished
52 my ( $self, $c ) = @_;
53 if ( scalar @{ $c->error } ) { ... } # handle errors
54 return if $c->res->body; # already have a response
55 $c->forward( 'MyApp::View::TT' ); # render template
58 See [Catalyst::Manual::Intro](https://metacpan.org/pod/Catalyst::Manual::Intro) for additional information.
62 Catalyst is a modern framework for making web applications without the
63 pain usually associated with this process. This document is a reference
64 to the main Catalyst application. If you are a new user, we suggest you
65 start with [Catalyst::Manual::Tutorial](https://metacpan.org/pod/Catalyst::Manual::Tutorial) or [Catalyst::Manual::Intro](https://metacpan.org/pod/Catalyst::Manual::Intro).
67 See [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) for more documentation.
69 Catalyst plugins can be loaded by naming them as arguments to the "use
70 Catalyst" statement. Omit the `Catalyst::Plugin::` prefix from the
71 plugin name, i.e., `Catalyst::Plugin::My::Module` becomes
74 use Catalyst qw/My::Module/;
76 If your plugin starts with a name other than `Catalyst::Plugin::`, you can
77 fully qualify the name by using a unary plus:
81 +Fully::Qualified::Plugin::Name
84 Special flags like `-Debug` can also be specified as
85 arguments when Catalyst is loaded:
87 use Catalyst qw/-Debug My::Module/;
89 The position of plugins and flags in the chain is important, because
90 they are loaded in the order in which they appear.
92 The following flags are supported:
96 Enables debug output. You can also force this setting from the system
97 environment with CATALYST\_DEBUG or <MYAPP>\_DEBUG. The environment
98 settings override the application, with <MYAPP>\_DEBUG having the highest
101 This sets the log level to 'debug' and enables full debug output on the
102 error screen. If you only want the latter, see [$c->debug](https://metacpan.org/pod/$c->debug).
106 Forces Catalyst to use a specific home directory, e.g.:
108 use Catalyst qw[-Home=/usr/mst];
110 This can also be done in the shell environment by setting either the
111 `CATALYST_HOME` environment variable or `MYAPP_HOME`; where `MYAPP`
112 is replaced with the uppercased name of your application, any "::" in
113 the name will be replaced with underscores, e.g. MyApp::Web should use
114 MYAPP\_WEB\_HOME. If both variables are set, the MYAPP\_HOME one will be used.
116 If none of these are set, Catalyst will attempt to automatically detect the
117 home directory. If you are working in a development environment, Catalyst
118 will try and find the directory containing either Makefile.PL, Build.PL,
119 dist.ini, or cpanfile. If the application has been installed into the system
120 (i.e. you have done `make install`), then Catalyst will use the path to your
121 application module, without the .pm extension (e.g., /foo/MyApp if your
122 application was installed at /foo/MyApp.pm)
126 use Catalyst '-Log=warn,fatal,error';
128 Specifies a comma-delimited list of log levels.
132 Enables statistics collection and reporting.
134 use Catalyst qw/-Stats=1/;
136 You can also force this setting from the system environment with CATALYST\_STATS
137 or <MYAPP>\_STATS. The environment settings override the application, with
138 <MYAPP>\_STATS having the highest priority.
140 Stats are also enabled if [debugging ](#debug) is enabled.
144 ## INFORMATION ABOUT THE CURRENT REQUEST
148 Returns a [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action) object for the current action, which
149 stringifies to the action name. See [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action).
153 Returns the namespace of the current action, i.e., the URI prefix
154 corresponding to the controller of the current action. For example:
156 # in Controller::Foo::Bar
157 $c->namespace; # returns 'foo/bar';
163 Returns the current [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) object, giving access to
164 information about the current client request (including parameters,
165 cookies, HTTP headers, etc.). See [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request).
167 ## REQUEST FLOW HANDLING
169 ## $c->forward( $action \[, \\@arguments \] )
171 ## $c->forward( $class, $method, \[, \\@arguments \] )
173 This is one way of calling another action (method) in the same or
174 a different controller. You can also use `$self->my_method($c, @args)`
175 in the same controller or `$c->controller('MyController')->my_method($c, @args)`
176 in a different controller.
177 The main difference is that 'forward' uses some of the Catalyst request
178 cycle overhead, including debugging, which may be useful to you. On the
179 other hand, there are some complications to using 'forward', restrictions
180 on values returned from 'forward', and it may not handle errors as you prefer.
181 Whether you use 'forward' or not is up to you; it is not considered superior to
182 the other ways to call a method.
184 'forward' calls another action, by its private name. If you give a
185 class name but no method, `process()` is called. You may also optionally
186 pass arguments in an arrayref. The action will receive the arguments in
187 `@_` and `$c->req->args`. Upon returning from the function,
188 `$c->req->args` will be restored to the previous values.
190 Any data `return`ed from the action forwarded to, will be returned by the
193 my $foodata = $c->forward('/foo');
194 $c->forward('index');
195 $c->forward(qw/Model::DBIC::Foo do_stuff/);
196 $c->forward('View::TT');
198 Note that [forward](#c-forward-action-arguments) implies
199 an `eval { }` around the call (actually
200 [execute](#c-execute-class-coderef) does), thus rendering all
201 exceptions thrown by the called action non-fatal and pushing them onto
202 $c->error instead. If you want `die` to propagate you need to do something
206 die join "\n", @{ $c->error } if @{ $c->error };
208 Or make sure to always return true values from your actions and write
211 $c->forward('foo') || return;
213 Another note is that `$c->forward` always returns a scalar because it
214 actually returns $c->state which operates in a scalar context.
215 Thus, something like:
219 in an action that is forwarded to is going to return a scalar,
220 i.e. how many items are in that array, which is probably not what you want.
221 If you need to return an array then return a reference to it,
224 $c->stash->{array} = \@array;
226 and access it from the stash.
228 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.
230 ## $c->detach( $action \[, \\@arguments \] )
232 ## $c->detach( $class, $method, \[, \\@arguments \] )
236 The same as [forward](#c-forward-action-arguments), but
237 doesn't return to the previous action when processing is finished.
239 When called with no arguments it escapes the processing chain entirely.
241 ## $c->visit( $action \[, \\@arguments \] )
243 ## $c->visit( $action \[, \\@captures, \\@arguments \] )
245 ## $c->visit( $class, $method, \[, \\@arguments \] )
247 ## $c->visit( $class, $method, \[, \\@captures, \\@arguments \] )
249 Almost the same as [forward](#c-forward-action-arguments),
250 but does a full dispatch, instead of just calling the new `$action` /
251 `$class->$method`. This means that `begin`, `auto` and the method
252 you go to are called, just like a new request.
254 In addition both `$c->action` and `$c->namespace` are localized.
255 This means, for example, that `$c->action` methods such as
256 [name](https://metacpan.org/pod/Catalyst::Action#name), [class](https://metacpan.org/pod/Catalyst::Action#class) and
257 [reverse](https://metacpan.org/pod/Catalyst::Action#reverse) return information for the visited action
258 when they are invoked within the visited action. This is different from the
259 behavior of [forward](#c-forward-action-arguments), which
260 continues to use the $c->action object from the caller action even when
261 invoked from the called action.
263 `$c->stash` is kept unchanged.
265 In effect, [visit](#c-visit-action-captures-arguments)
266 allows you to "wrap" another action, just as it would have been called by
267 dispatching from a URL, while the analogous
268 [go](#c-go-action-captures-arguments) allows you to
269 transfer control to another action as if it had been reached directly from a URL.
271 ## $c->go( $action \[, \\@arguments \] )
273 ## $c->go( $action \[, \\@captures, \\@arguments \] )
275 ## $c->go( $class, $method, \[, \\@arguments \] )
277 ## $c->go( $class, $method, \[, \\@captures, \\@arguments \] )
279 The relationship between `go` and
280 [visit](#c-visit-action-captures-arguments) is the same as
281 the relationship between
282 [forward](#c-forward-class-method-arguments) and
283 [detach](#c-detach-action-arguments). Like `$c->visit`,
284 `$c->go` will perform a full dispatch on the specified action or method,
285 with localized `$c->action` and `$c->namespace`. Like `detach`,
286 `go` escapes the processing of the current request chain on completion, and
287 does not return to its caller.
289 @arguments are arguments to the final destination of $action. @captures are
290 arguments to the intermediate steps, if any, on the way to the final sub of
297 Returns the current [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response) object, see there for details.
301 Returns a hashref to the stash, which may be used to store data and pass
302 it between components during a request. You can also set hash keys by
303 passing arguments. The stash is automatically sent to the view. The
304 stash is cleared at the end of a request; it cannot be used for
305 persistent storage (for this you must use a session; see
306 [Catalyst::Plugin::Session](https://metacpan.org/pod/Catalyst::Plugin::Session) for a complete system integrated with
309 $c->stash->{foo} = $bar;
310 $c->stash( { moose => 'majestic', qux => 0 } );
311 $c->stash( bar => 1, gorch => 2 ); # equivalent to passing a hashref
313 # stash is automatically passed to the view for use in a template
314 $c->forward( 'MyApp::View::TT' );
316 The stash hash is currently stored in the PSGI `$env` and is managed by
317 [Catalyst::Middleware::Stash](https://metacpan.org/pod/Catalyst::Middleware::Stash). Since it's part of the `$env` items in
318 the stash can be accessed in sub applications mounted under your main
319 [Catalyst](https://metacpan.org/pod/Catalyst) application. For example if you delegate the response of an
320 action to another [Catalyst](https://metacpan.org/pod/Catalyst) application, that sub application will have
321 access to all the stash keys of the main one, and if can of course add
322 more keys of its own. However those new keys will not 'bubble' back up
323 to the main application.
325 For more information the best thing to do is to review the test case:
326 t/middleware-stash.t in the distribution /t directory.
330 ## $c->error($error, ...)
332 ## $c->error($arrayref)
334 Returns an arrayref containing error messages. If Catalyst encounters an
335 error while processing a request, it stores the error in $c->error. This
336 method should only be used to store fatal error messages.
338 my @error = @{ $c->error };
342 $c->error('Something bad happened');
344 Calling this will always return an arrayref (if there are no errors it
345 will be an empty arrayref.
349 Contains the return value of the last executed action.
350 Note that << $c->state >> operates in a scalar context which means that all
351 values it returns are scalar.
353 Please note that if an action throws an exception, the value of state
354 should no longer be considered the return if the last action. It is generally
355 going to be 0, which indicates an error state. Examine $c->error for error
360 Clear errors. You probably don't want to clear the errors unless you are
361 implementing a custom error screen.
363 This is equivalent to running
369 Returns true if you have errors
373 Returns the most recent error in the stack (the one most recently added...)
374 or nothing if there are no errors. This does not modify the contents of the
379 shifts the most recently added error off the error stack and returns it. Returns
380 nothing if there are no more errors.
384 pops the most recently added error off the error stack and returns it. Returns
385 nothing if there are no more errors.
387 ## COMPONENT ACCESSORS
389 ## $c->controller($name)
391 Gets a [Catalyst::Controller](https://metacpan.org/pod/Catalyst::Controller) instance by name.
393 $c->controller('Foo')->do_stuff;
395 If the name is omitted, will return the controller for the dispatched
398 If you want to search for controllers, pass in a regexp as the argument.
400 # find all controllers that start with Foo
401 my @foo_controllers = $c->controller(qr{^Foo});
405 Gets a [Catalyst::Model](https://metacpan.org/pod/Catalyst::Model) instance by name.
407 $c->model('Foo')->do_stuff;
409 Any extra arguments are directly passed to ACCEPT\_CONTEXT, if the model
410 defines ACCEPT\_CONTEXT. If it does not, the args are discarded.
412 If the name is omitted, it will look for
413 - a model object in $c->stash->{current\_model\_instance}, then
414 - a model name in $c->stash->{current\_model}, then
415 - a config setting 'default\_model', or
416 - check if there is only one model, and return it if that's the case.
418 If you want to search for models, pass in a regexp as the argument.
420 # find all models that start with Foo
421 my @foo_models = $c->model(qr{^Foo});
425 Gets a [Catalyst::View](https://metacpan.org/pod/Catalyst::View) instance by name.
427 $c->view('Foo')->do_stuff;
429 Any extra arguments are directly passed to ACCEPT\_CONTEXT.
431 If the name is omitted, it will look for
432 - a view object in $c->stash->{current\_view\_instance}, then
433 - a view name in $c->stash->{current\_view}, then
434 - a config setting 'default\_view', or
435 - check if there is only one view, and return it if that's the case.
437 If you want to search for views, pass in a regexp as the argument.
439 # find all views that start with Foo
440 my @foo_views = $c->view(qr{^Foo});
444 Returns the available names which can be passed to $c->controller
448 Returns the available names which can be passed to $c->model
452 Returns the available names which can be passed to $c->view
456 ## $c->component($name)
458 Gets a component object by name. This method is not recommended,
459 unless you want to get a specific component by full
460 class. `$c->controller`, `$c->model`, and `$c->view`
461 should be used instead.
463 If `$name` is a regexp, a list of components matched against the full
464 component name will be returned.
466 If Catalyst can't find a component by name, it will fallback to regex
467 matching by default. To disable this behaviour set
468 disable\_component\_resolution\_regex\_fallback to a true value.
470 __PACKAGE__->config( disable_component_resolution_regex_fallback => 1 );
472 ## CLASS DATA AND HELPER CLASSES
476 Returns or takes a hashref containing the application's configuration.
478 __PACKAGE__->config( { db => 'dsn:SQLite:foo.db' } );
480 You can also use a `YAML`, `XML` or [Config::General](https://metacpan.org/pod/Config::General) config file
481 like `myapp.conf` in your applications home directory. See
482 [Catalyst::Plugin::ConfigLoader](https://metacpan.org/pod/Catalyst::Plugin::ConfigLoader).
484 ### Cascading configuration
486 The config method is present on all Catalyst components, and configuration
487 will be merged when an application is started. Configuration loaded with
488 [Catalyst::Plugin::ConfigLoader](https://metacpan.org/pod/Catalyst::Plugin::ConfigLoader) takes precedence over other configuration,
489 followed by configuration in your top level `MyApp` class. These two
490 configurations are merged, and then configuration data whose hash key matches a
491 component name is merged with configuration for that component.
493 The configuration for a component is then passed to the `new` method when a
494 component is constructed.
498 MyApp->config({ 'Model::Foo' => { bar => 'baz', overrides => 'me' } });
499 MyApp::Model::Foo->config({ quux => 'frob', overrides => 'this' });
501 will mean that `MyApp::Model::Foo` receives the following data when
504 MyApp::Model::Foo->new({
510 It's common practice to use a Moose attribute
511 on the receiving component to access the config value.
513 package MyApp::Model::Foo;
517 # this attr will receive 'baz' at construction time
523 You can then get the value 'baz' by calling $c->model('Foo')->bar
524 (or $self->bar inside code in the model).
526 **NOTE:** you MUST NOT call `$self->config` or `__PACKAGE__->config`
527 as a way of reading config within your code, as this **will not** give you the
528 correctly merged config back. You **MUST** take the config values supplied to
529 the constructor and use those instead.
533 Returns the logging object instance. Unless it is already set, Catalyst
534 sets this up with a [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) object. To use your own log class,
535 set the logger with the `__PACKAGE__->log` method prior to calling
536 `__PACKAGE__->setup`.
538 __PACKAGE__->log( MyLogger->new );
543 $c->log->info( 'Now logging with my own logger!' );
545 Your log class should implement the methods described in
546 [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log).
550 Returned True if there's a valid encoding
554 Clears the encoding for the current context
558 Sets or gets the application encoding. Setting encoding takes either an
559 Encoding object or a string that we try to resolve via [Encode::find\_encoding](https://metacpan.org/pod/Encode::find_encoding).
561 You would expect to get the encoding object back if you attempt to set it. If
562 there is a failure you will get undef returned and an error message in the log.
566 Returns 1 if debug mode is enabled, 0 otherwise.
568 You can enable debug mode in several ways:
570 - By calling myapp\_server.pl with the -d flag
571 - With the environment variables MYAPP\_DEBUG, or CATALYST\_DEBUG
572 - The -Debug option in your MyApp.pm
573 - By declaring `sub debug { 1 }` in your MyApp.pm.
575 The first three also set the log level to 'debug'.
577 Calling `$c->debug(1)` has no effect.
581 Returns the dispatcher instance. See [Catalyst::Dispatcher](https://metacpan.org/pod/Catalyst::Dispatcher).
585 Returns the engine instance. See [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine).
589 ## $c->path\_to(@path)
591 Merges `@path` with `$c->config->{home}` and returns a
592 [Path::Class::Dir](https://metacpan.org/pod/Path::Class::Dir) object. Note you can usually use this object as
593 a filename, but sometimes you will have to explicitly stringify it
594 yourself by calling the `->stringify` method.
598 $c->path_to( 'db', 'sqlite.db' );
602 Initializes the dispatcher and engine, loads any plugins, and loads the
603 model, view, and controller components. You may also specify an array
604 of plugins to load here, if you choose to not load them in the `use
608 MyApp->setup( qw/-Debug/ );
610 **Note:** You **should not** wrap this method with method modifiers
611 or bad things will happen - wrap the `setup_finalize` method instead.
613 **Note:** You can create a custom setup stage that will execute when the
614 application is starting. Use this to customize setup.
616 MyApp->setup(-Custom=value);
619 my ($class, $value) = @_;
622 Can be handy if you want to hook into the setup phase.
624 ## $app->setup\_finalize
626 A hook to attach modifiers to. This method does not do anything except set the
627 `setup_finished` accessor.
629 Applying method modifiers to the `setup` method doesn't work, because of quirky things done for plugin setup.
633 after setup_finalize => sub {
639 ## $c->uri\_for( $path?, @args?, \\%query\_values?, \\$fragment? )
641 ## $c->uri\_for( $action, \\@captures?, @args?, \\%query\_values?, \\$fragment? )
643 ## $c->uri\_for( $action, \[@captures, @args\], \\%query\_values?, \\$fragment? )
645 Constructs an absolute [URI](https://metacpan.org/pod/URI) object based on the application root, the
646 provided path, and the additional arguments and query parameters provided.
647 When used as a string, provides a textual URI. If you need more flexibility
648 than this (i.e. the option to provide relative URIs etc.) see
649 [Catalyst::Plugin::SmartURI](https://metacpan.org/pod/Catalyst::Plugin::SmartURI).
651 If no arguments are provided, the URI for the current action is returned.
652 To return the current action and also provide @args, use
653 `$c->uri_for( $c->action, @args )`.
655 If the first argument is a string, it is taken as a public URI path relative
656 to `$c->namespace` (if it doesn't begin with a forward slash) or
657 relative to the application root (if it does). It is then merged with
658 `$c->request->base`; any `@args` are appended as additional path
659 components; and any `%query_values` are appended as `?foo=bar` parameters.
661 **NOTE** If you are using this 'stringy' first argument, we skip encoding and
662 allow you to declare something like:
664 $c->uri_for('/foo/bar#baz')
666 Where 'baz' is a URI fragment. We consider this first argument string to be
667 'expert' mode where you are expected to create a valid URL and we for the most
668 part just pass it through without a lot of internal effort to escape and encode.
670 If the first argument is a [Catalyst::Action](https://metacpan.org/pod/Catalyst::Action) it represents an action which
671 will have its path resolved using `$c->dispatcher->uri_for_action`. The
672 optional `\@captures` argument (an arrayref) allows passing the captured
673 variables that are needed to fill in the paths of Chained and Regex actions;
674 once the path is resolved, `uri_for` continues as though a path was
675 provided, appending any arguments or parameters and creating an absolute
678 The captures for the current request can be found in
679 `$c->request->captures`, and actions can be resolved using
680 `Catalyst::Controller->action_for($name)`. If you have a private action
681 path, use `$c->uri_for_action` instead.
683 # Equivalent to $c->req->uri
684 $c->uri_for($c->action, $c->req->captures,
685 @{ $c->req->args }, $c->req->params);
687 # For the Foo action in the Bar controller
688 $c->uri_for($c->controller('Bar')->action_for('Foo'));
690 # Path to a static resource
691 $c->uri_for('/static/images/logo.png');
693 In general the scheme of the generated URI object will follow the incoming request
694 however if your targeted action or action chain has the Scheme attribute it will
697 Also, if the targeted Action or Action chain declares Args/CaptureArgs that have
698 type constraints, we will require that your proposed URL verify on those declared
701 ## $c->uri\_for\_action( $path, \\@captures\_and\_args?, @args?, \\%query\_values? )
703 ## $c->uri\_for\_action( $action, \\@captures\_and\_args?, @args?, \\%query\_values? )
707 A private path to the Catalyst action you want to create a URI for.
709 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`.
711 You can also pass in a Catalyst::Action object, in which case it is passed to
714 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.
716 For example, if the action looks like:
718 package MyApp::Controller::Users;
720 sub lst : Path('the-list') {}
724 $c->uri_for_action('/users/lst')
726 and it will create the URI /users/the-list.
728 - \\@captures\_and\_args?
730 Optional array reference of Captures (i.e. `CaptureArgs` or `$c->req->captures`)
731 and arguments to the request. Usually used with [Catalyst::DispatchType::Chained](https://metacpan.org/pod/Catalyst::DispatchType::Chained)
732 to interpolate all the parameters in the URI.
736 Optional list of extra arguments - can be supplied in the
737 `\@captures_and_args?` array ref, or here - whichever is easier for your
740 Your action can have zero, a fixed or a variable number of args (e.g.
741 `Args(1)` for a fixed number or `Args()` for a variable number)..
745 Optional array reference of query parameters to append. E.g.
751 /rest/of/your/uri?foo=bar
753 ## $c->welcome\_message
755 Returns the Catalyst welcome HTML page.
759 Contains a hash of options passed from the application script, including
760 the original ARGV the script received, the processed values from that
761 ARGV and any extra arguments to the script which were not processed.
763 This can be used to add custom options to your application's scripts
764 and setup your application differently depending on the values of these
769 These methods are not meant to be used by end users.
773 Returns a hash of components.
775 ## $c->context\_class
777 Returns or sets the context class.
781 Returns a hashref containing coderefs and execution counts (needed for
782 deep recursion detection).
786 Returns the number of actions on the current internal execution stack.
790 Dispatches a request to actions.
792 ## $c->dispatcher\_class
794 Returns or sets the dispatcher class.
798 Returns a list of 2-element array references (name, structure) pairs
799 that will be dumped on the error page in debug mode.
803 Returns or sets the engine class.
805 ## $c->execute( $class, $coderef )
807 Execute a coderef in given class and catch exceptions. Errors are available
812 Finalizes the request.
814 ## $c->finalize\_body
818 ## $c->finalize\_cookies
822 ## $c->finalize\_error
824 Finalizes error. If there is only one error in ["error"](#error) and it is an object that
825 does `as_psgi` or `code` we rethrow the error and presume it caught by middleware
826 up the ladder. Otherwise we return the debugging error page (in debug mode) or we
827 return the default error page (production mode).
829 ## $c->finalize\_headers
833 ## $c->finalize\_encoding
835 Make sure your body is encoded properly IF you set an encoding. By
836 default the encoding is UTF-8 but you can disable it by explicitly setting the
837 encoding configuration value to undef.
839 We can only encode when the body is a scalar. Methods for encoding via the
840 streaming interfaces (such as `write` and `write_fh` on [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response)
843 See ["ENCODING"](#encoding).
845 ## $c->finalize\_output
847 An alias for finalize\_body.
849 ## $c->finalize\_read
851 Finalizes the input after reading is complete.
853 ## $c->finalize\_uploads
855 Finalizes uploads. Cleans up any temporary files.
857 ## $c->get\_action( $action, $namespace )
859 Gets an action in a given namespace.
861 ## $c->get\_actions( $action, $namespace )
863 Gets all actions of a given name in a namespace and all parent
866 ## $app->handle\_request( @arguments )
868 Called to handle each HTTP request.
870 ## $class->prepare( @arguments )
872 Creates a Catalyst context from an engine-specific request (Apache, CGI,
875 ## $c->prepare\_action
877 Prepares action. See [Catalyst::Dispatcher](https://metacpan.org/pod/Catalyst::Dispatcher).
881 Prepares message body.
883 ## $c->prepare\_body\_chunk( $chunk )
885 Prepares a chunk of data before sending it to [HTTP::Body](https://metacpan.org/pod/HTTP::Body).
887 See [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine).
889 ## $c->prepare\_body\_parameters
891 Prepares body parameters.
893 ## $c->prepare\_connection
897 ## $c->prepare\_cookies
899 Prepares cookies by ensuring that the attribute on the request
900 object has been built.
902 ## $c->prepare\_headers
904 Prepares request headers by ensuring that the attribute on the request
905 object has been built.
907 ## $c->prepare\_parameters
913 Prepares path and base.
915 ## $c->prepare\_query\_parameters
917 Prepares query parameters.
921 Writes information about the request to the debug logs. This includes:
923 - Request method, path, and remote IP address
924 - Query keywords (see ["query\_keywords" in Catalyst::Request](https://metacpan.org/pod/Catalyst::Request#query_keywords))
930 Writes information about the response to the debug logs by calling
931 `$c->log_response_status_line` and `$c->log_response_headers`.
933 ## $c->log\_response\_status\_line($response)
935 Writes one line of information about the response to the debug logs. This includes:
937 - Response status code
938 - Content-Type header (if present)
939 - Content-Length header (if present)
941 ## $c->log\_response\_headers($headers);
943 Hook method which can be wrapped by plugins to log the response headers.
944 No-op in the default implementation.
946 ## $c->log\_request\_parameters( query => {}, body => {} )
948 Logs request parameters to debug logs
950 ## $c->log\_request\_uploads
952 Logs file uploads included in the request to the debug logs.
953 The parameter name, filename, file type, and file size are all included in
956 ## $c->log\_request\_headers($headers);
958 Hook method which can be wrapped by plugins to log the request headers.
959 No-op in the default implementation.
961 ## $c->log\_headers($type => $headers)
963 Logs [HTTP::Headers](https://metacpan.org/pod/HTTP::Headers) (either request or response) to the debug logs.
967 Prepares the input for reading.
969 ## $c->prepare\_request
971 Prepares the engine request.
973 ## $c->prepare\_uploads
977 ## $c->prepare\_write
979 Prepares the output for writing.
981 ## $c->request\_class
983 Returns or sets the request class. Defaults to [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request).
985 ## $app->request\_class\_traits
987 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s which are applied to the request class. You can
988 name the full namespace of the role, or a namespace suffix, which will then
989 be tried against the following standard namespace prefixes.
991 $MyApp::TraitFor::Request::$trait_suffix
992 Catalyst::TraitFor::Request::$trait_suffix
994 So for example if you set:
996 MyApp->request_class_traits(['Foo']);
998 We try each possible role in turn (and throw an error if none load)
1001 MyApp::TraitFor::Request::Foo
1002 Catalyst::TraitFor::Request::Foo
1004 The namespace part 'TraitFor::Request' was chosen to assist in backwards
1005 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1006 these features in a stand alone package.
1008 ## $app->composed\_request\_class
1010 This is the request class which has been composed with any request\_class\_traits.
1012 ## $c->response\_class
1014 Returns or sets the response class. Defaults to [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response).
1016 ## $app->response\_class\_traits
1018 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s which are applied to the response class. You can
1019 name the full namespace of the role, or a namespace suffix, which will then
1020 be tried against the following standard namespace prefixes.
1022 $MyApp::TraitFor::Response::$trait_suffix
1023 Catalyst::TraitFor::Response::$trait_suffix
1025 So for example if you set:
1027 MyApp->response_class_traits(['Foo']);
1029 We try each possible role in turn (and throw an error if none load)
1032 MyApp::TraitFor::Response::Foo
1033 Catalyst::TraitFor::Responset::Foo
1035 The namespace part 'TraitFor::Response' was chosen to assist in backwards
1036 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1037 these features in a stand alone package.
1039 ## $app->composed\_response\_class
1041 This is the request class which has been composed with any response\_class\_traits.
1043 ## $c->read( \[$maxlength\] )
1045 Reads a chunk of data from the request body. This method is designed to
1046 be used in a while loop, reading `$maxlength` bytes on every call.
1047 `$maxlength` defaults to the size of the request if not specified.
1049 You have to set `MyApp->config(parse_on_demand => 1)` to use this
1052 Warning: If you use read(), Catalyst will not process the body,
1053 so you will not be able to access POST parameters or file uploads via
1054 $c->request. You must handle all body parsing yourself.
1060 ## $c->set\_action( $action, $code, $namespace, $attrs )
1062 Sets an action in a given namespace.
1064 ## $c->setup\_actions($component)
1066 Sets up actions for a component.
1068 ## $c->setup\_components
1070 This method is called internally to set up the application's components.
1072 It finds modules by calling the [locate\_components](https://metacpan.org/pod/locate_components) method, expands them to
1073 package names with the [expand\_component\_module](https://metacpan.org/pod/expand_component_module) method, and then installs
1074 each component into the application.
1076 The `setup_components` config option is passed to both of the above methods.
1078 Installation of each component is performed by the [setup\_component](https://metacpan.org/pod/setup_component) method,
1081 ## $app->setup\_injected\_components
1083 Called by setup\_compoents to setup components that are injected.
1085 ## $app->setup\_injected\_component( $injected\_component\_name, $config )
1087 Setup a given injected component.
1089 ## $app->inject\_component($MyApp\_Component\_name => \\%args);
1091 Add a component that is injected at setup:
1093 MyApp->inject_component( 'Model::Foo' => { from_component => 'Common::Foo' } );
1095 Must be called before ->setup. Expects a component name for your
1096 current application and \\%args where
1100 The target component being injected into your application
1104 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that are applied to your component.
1108 MyApp->inject_component(
1110 from_component => 'Common::Model::Foo',
1111 roles => ['Role1', 'Role2'],
1114 ## $app->inject\_components
1116 Inject a list of components:
1118 MyApp->inject_components(
1119 'Model::FooOne' => {
1120 from_component => 'Common::Model::Foo',
1121 roles => ['Role1', 'Role2'],
1123 'Model::FooTwo' => {
1124 from_component => 'Common::Model::Foo',
1125 roles => ['Role1', 'Role2'],
1128 ## $c->locate\_components( $setup\_component\_config )
1130 This method is meant to provide a list of component modules that should be
1131 setup for the application. By default, it will use [Module::Pluggable](https://metacpan.org/pod/Module::Pluggable).
1133 Specify a `setup_components` config option to pass additional options directly
1134 to [Module::Pluggable](https://metacpan.org/pod/Module::Pluggable). To add additional search paths, specify a key named
1135 `search_extra` as an array reference. Items in the array beginning with `::`
1136 will have the application class name prepended to them.
1138 ## $c->expand\_component\_module( $component, $setup\_component\_config )
1140 Components found by `locate_components` will be passed to this method, which
1141 is expected to return a list of component (package) names to be set up.
1143 ## $app->delayed\_setup\_component
1145 Returns a coderef that points to a setup\_component instance. Used
1146 internally for when you want to delay setup until the first time
1147 the component is called.
1149 ## $c->setup\_component
1151 ## $app->config\_for( $component\_name )
1153 Return the application level configuration (which is not yet merged with any
1154 local component configuration, via $component\_class->config) for the named
1155 component or component object. Example:
1158 'Model::Foo' => { a => 1, b => 2},
1161 my $config = MyApp->config_for('MyApp::Model::Foo');
1163 In this case $config is the hashref `{a=>1, b=>2}`.
1165 This is also handy for looking up configuration for a plugin, to make sure you follow
1166 existing [Catalyst](https://metacpan.org/pod/Catalyst) standards for where a plugin should put its configuration.
1168 ## $c->setup\_dispatcher
1172 ## $c->setup\_engine
1176 ## $c->apply\_default\_middlewares
1178 Adds the following [Plack](https://metacpan.org/pod/Plack) middlewares to your application, since they are
1179 useful and commonly needed:
1181 [Plack::Middleware::LighttpdScriptNameFix](https://metacpan.org/pod/Plack::Middleware::LighttpdScriptNameFix) (if you are using Lighttpd),
1182 [Plack::Middleware::IIS6ScriptNameFix](https://metacpan.org/pod/Plack::Middleware::IIS6ScriptNameFix) (always applied since this middleware
1183 is smart enough to conditionally apply itself).
1185 We will also automatically add [Plack::Middleware::ReverseProxy](https://metacpan.org/pod/Plack::Middleware::ReverseProxy) if we notice
1186 that your HTTP $env variable `REMOTE_ADDR` is '127.0.0.1'. This is usually
1187 an indication that your server is running behind a proxy frontend. However in
1188 2014 this is often not the case. We preserve this code for backwards compatibility
1189 however I **highly** recommend that if you are running the server behind a front
1190 end proxy that you clearly indicate so with the `using_frontend_proxy` configuration
1191 setting to true for your environment configurations that run behind a proxy. This
1192 way if you change your front end proxy address someday your code would inexplicably
1193 stop working as expected.
1195 Additionally if we detect we are using Nginx, we add a bit of custom middleware
1196 to solve some problems with the way that server handles $ENV{PATH\_INFO} and
1199 Please **NOTE** that if you do use `using_frontend_proxy` the middleware is now
1200 adding via `registered_middleware` rather than this method.
1202 If you are using Lighttpd or IIS6 you may wish to apply these middlewares. In
1203 general this is no longer a common case but we have this here for backward
1210 Returns a PSGI application code reference for the catalyst application
1211 `$c`. This is the bare application created without the `apply_default_middlewares`
1212 method called. We do however apply `registered_middleware` since those are
1213 integral to how [Catalyst](https://metacpan.org/pod/Catalyst) functions. Also, unlike starting your application
1214 with a generated server script (via [Catalyst::Devel](https://metacpan.org/pod/Catalyst::Devel) and `catalyst.pl`) we do
1215 not attempt to return a valid [PSGI](https://metacpan.org/pod/PSGI) application using any existing `${myapp}.psgi`
1216 scripts in your $HOME directory.
1218 **NOTE** `apply_default_middlewares` was originally created when the first PSGI
1219 port was done for v5.90000. These are middlewares that are added to achieve
1220 backward compatibility with older applications. If you start your application
1221 using one of the supplied server scripts (generated with [Catalyst::Devel](https://metacpan.org/pod/Catalyst::Devel) and
1222 the project skeleton script `catalyst.pl`) we apply `apply_default_middlewares`
1223 automatically. This was done so that pre and post PSGI port applications would
1226 This is what you want to be using to retrieve the PSGI application code
1227 reference of your Catalyst application for use in a custom `.psgi` or in your
1228 own created server modules.
1232 Sets up the home directory.
1234 ## $c->setup\_encoding
1236 Sets up the input/output encoding. See [ENCODING](https://metacpan.org/pod/ENCODING)
1238 ## handle\_unicode\_encoding\_exception
1240 Hook to let you customize how encoding errors are handled. By default
1241 we just throw an exception and the default error page will pick it up.
1242 Receives a hashref of debug information. Example of call (from the
1243 Catalyst internals):
1245 my $decoded_after_fail = $c->handle_unicode_encoding_exception({
1246 param_value => $value,
1248 encoding_step => 'params',
1251 The calling code expects to receive a decoded string or an exception.
1253 You can override this for custom handling of unicode errors. By
1254 default we just die. If you want a custom response here, one approach
1255 is to throw an HTTP style exception, instead of returning a decoded
1256 string or throwing a generic exception.
1258 sub handle_unicode_encoding_exception {
1259 my ($c, $params) = @_;
1260 HTTP::Exception::BAD_REQUEST->throw(status_message=>$params->{error_msg});
1263 Alternatively you can 'catch' the error, stash it and write handling code later
1264 in your application:
1266 sub handle_unicode_encoding_exception {
1267 my ($c, $params) = @_;
1268 $c->stash(BAD_UNICODE_DATA=>$params);
1269 # return a dummy string.
1273 <B>NOTE:</b> Please keep in mind that once an error like this occurs,
1274 the request setup is still ongoing, which means the state of `$c` and
1275 related context parts like the request and response may not be setup
1276 up correctly (since we haven't finished the setup yet). If you throw
1277 an exception the setup is aborted.
1281 Sets up log by instantiating a [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) object and
1282 passing it to `log()`. Pass in a comma-delimited list of levels to set the
1285 This method also installs a `debug` method that returns a true value into the
1286 catalyst subclass if the "debug" level is passed in the comma-delimited list,
1287 or if the `$CATALYST_DEBUG` environment variable is set to a true value.
1289 Note that if the log has already been setup, by either a previous call to
1290 `setup_log` or by a call such as `__PACKAGE__->log( MyLogger->new )`,
1291 that this method won't actually set up the log object.
1293 ## $c->setup\_plugins
1299 Sets up timing statistics class.
1301 ## $c->registered\_plugins
1303 Returns a sorted list of the plugins which have either been stated in the
1306 If passed a given plugin name, it will report a boolean value indicating
1307 whether or not that plugin is loaded. A fully qualified name is required if
1308 the plugin name does not begin with `Catalyst::Plugin::`.
1310 if ($c->registered_plugins('Some::Plugin')) {
1314 ## default\_middleware
1316 Returns a list of instantiated PSGI middleware objects which is the default
1317 middleware that is active for this application (taking any configuration
1318 options into account, excluding your custom added middleware via the `psgi_middleware`
1319 configuration option). You can override this method if you wish to change
1320 the default middleware (although do so at risk since some middleware is vital
1321 to application function.)
1323 The current default middleware list is:
1325 Catalyst::Middleware::Stash
1326 Plack::Middleware::HTTPExceptions
1327 Plack::Middleware::RemoveRedundantBody
1328 Plack::Middleware::FixMissingBodyInRedirect
1329 Plack::Middleware::ContentLength
1330 Plack::Middleware::MethodOverride
1331 Plack::Middleware::Head
1333 If the configuration setting `using_frontend_proxy` is true we add:
1335 Plack::Middleware::ReverseProxy
1337 If the configuration setting `using_frontend_proxy_path` is true we add:
1339 Plack::Middleware::ReverseProxyPath
1341 But **NOTE** that [Plack::Middleware::ReverseProxyPath](https://metacpan.org/pod/Plack::Middleware::ReverseProxyPath) is not a dependency of the
1342 [Catalyst](https://metacpan.org/pod/Catalyst) distribution so if you want to use this option you should add it to
1343 your project distribution file.
1345 These middlewares will be added at ["setup\_middleware"](#setup_middleware) during the
1346 ["setup"](#setup) phase of application startup.
1348 ## registered\_middlewares
1350 Read only accessor that returns an array of all the middleware in the order
1351 that they were added (which is the REVERSE of the order they will be applied).
1353 The values returned will be either instances of [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) or of a
1354 compatible interface, or a coderef, which is assumed to be inlined middleware
1356 ## setup\_middleware (?@middleware)
1358 Read configuration information stored in configuration key `psgi_middleware` or
1361 See under ["CONFIGURATION"](#configuration) information regarding `psgi_middleware` and how
1362 to use it to enable [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware)
1364 This method is automatically called during 'setup' of your application, so
1365 you really don't need to invoke it. However you may do so if you find the idea
1366 of loading middleware via configuration weird :). For example:
1372 __PACKAGE__->setup_middleware('Head');
1375 When we read middleware definitions from configuration, we reverse the list
1376 which sounds odd but is likely how you expect it to work if you have prior
1377 experience with [Plack::Builder](https://metacpan.org/pod/Plack::Builder) or if you previously used the plugin
1378 [Catalyst::Plugin::EnableMiddleware](https://metacpan.org/pod/Catalyst::Plugin::EnableMiddleware) (which is now considered deprecated)
1380 So basically your middleware handles an incoming request from the first
1381 registered middleware, down and handles the response from the last middleware
1384 ## registered\_data\_handlers
1386 A read only copy of registered Data Handlers returned as a Hash, where each key
1387 is a content type and each value is a subref that attempts to decode that content
1390 ## setup\_data\_handlers (?@data\_handler)
1392 Read configuration information stored in configuration key `data_handlers` or
1395 See under ["CONFIGURATION"](#configuration) information regarding `data_handlers`.
1397 This method is automatically called during 'setup' of your application, so
1398 you really don't need to invoke it.
1400 ## default\_data\_handlers
1402 Default Data Handlers that come bundled with [Catalyst](https://metacpan.org/pod/Catalyst). Currently there are
1403 only two default data handlers, for 'application/json' and an alternative to
1404 'application/x-www-form-urlencoded' which supposed nested form parameters via
1405 [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.
1407 The 'application/json' data handler is used to parse incoming JSON into a Perl
1408 data structure. It uses [JSON::MaybeXS](https://metacpan.org/pod/JSON::MaybeXS). This allows you to fail back to
1409 [JSON::PP](https://metacpan.org/pod/JSON::PP), which is a Pure Perl JSON decoder, and has the smallest dependency
1412 Because we don't wish to add more dependencies to [Catalyst](https://metacpan.org/pod/Catalyst), if you wish to
1413 use this new feature we recommend installing [Cpanel::JSON::XS](https://metacpan.org/pod/Cpanel::JSON::XS) in order to get
1414 the best performance. You should add either to your dependency list
1415 (Makefile.PL, dist.ini, cpanfile, etc.)
1419 Returns an arrayref of the internal execution stack (actions that are
1420 currently executing).
1424 Returns the current timing statistics object. By default Catalyst uses
1425 [Catalyst::Stats](https://metacpan.org/pod/Catalyst::Stats), but can be set otherwise with
1426 [stats\_class](#c-stats_class).
1428 Even if [-Stats](#stats) is not enabled, the stats object is still
1429 available. By enabling it with `$c->stats->enabled(1)`, it can be used to
1430 profile explicitly, although MyApp.pm still won't profile nor output anything
1435 Returns or sets the stats (timing statistics) class. [Catalyst::Stats](https://metacpan.org/pod/Catalyst::Stats) is used by default.
1437 ## $app->stats\_class\_traits
1439 A arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that are applied to the stats\_class before creating it.
1441 ## $app->composed\_stats\_class
1443 this is the stats\_class composed with any 'stats\_class\_traits'. You can
1444 name the full namespace of the role, or a namespace suffix, which will then
1445 be tried against the following standard namespace prefixes.
1447 $MyApp::TraitFor::Stats::$trait_suffix
1448 Catalyst::TraitFor::Stats::$trait_suffix
1450 So for example if you set:
1452 MyApp->stats_class_traits(['Foo']);
1454 We try each possible role in turn (and throw an error if none load)
1457 MyApp::TraitFor::Stats::Foo
1458 Catalyst::TraitFor::Stats::Foo
1460 The namespace part 'TraitFor::Stats' was chosen to assist in backwards
1461 compatibility with [CatalystX::RoleApplicator](https://metacpan.org/pod/CatalystX::RoleApplicator) which previously provided
1462 these features in a stand alone package.
1466 Returns 1 when [stats collection](#stats) is enabled.
1468 Note that this is a static method, not an accessor and should be overridden
1469 by declaring `sub use_stats { 1 }` in your MyApp.pm, not by calling `$c->use_stats(1)`.
1471 ## $c->write( $data )
1473 Writes $data to the output stream. When using this method directly, you
1474 will need to manually set the `Content-Length` header to the length of
1475 your output data, if known.
1479 Returns the Catalyst version number. Mostly useful for "powered by"
1480 messages in template systems.
1484 There are a number of 'base' config variables which can be set:
1486 - `always_catch_http_exceptions` - As of version 5.90060 Catalyst
1487 rethrows errors conforming to the interface described by
1488 [Plack::Middleware::HTTPExceptions](https://metacpan.org/pod/Plack::Middleware::HTTPExceptions) and lets the middleware deal with it.
1489 Set true to get the deprecated behaviour and have Catalyst catch HTTP exceptions.
1490 - `default_model` - The default model picked if you say `$c->model`. See ["$c->model($name)"](#c-model-name).
1491 - `default_view` - The default view to be rendered or returned when `$c->view` is called. See ["$c->view($name)"](#c-view-name).
1492 - `disable_component_resolution_regex_fallback` - Turns
1493 off the deprecated component resolution functionality so
1494 that if any of the component methods (e.g. `$c->controller('Foo')`)
1495 are called then regex search will not be attempted on string values and
1496 instead `undef` will be returned.
1497 - `home` - The application home directory. In an uninstalled application,
1498 this is the top level application directory. In an installed application,
1499 this will be the directory containing `MyApp.pm`.
1500 - `ignore_frontend_proxy` - See ["PROXY SUPPORT"](#proxy-support)
1501 - `name` - The name of the application in debug messages and the debug and
1503 - `parse_on_demand` - The request body (for example file uploads) will not be parsed
1504 until it is accessed. This allows you to (for example) check authentication (and reject
1505 the upload) before actually receiving all the data. See ["ON-DEMAND PARSER"](#on-demand-parser)
1506 - `root` - The root directory for templates. Usually this is just a
1507 subdirectory of the home directory, but you can set it to change the
1508 templates to a different directory.
1509 - `search_extra` - Array reference passed to Module::Pluggable to for additional
1510 namespaces from which components will be loaded (and constructed and stored in
1512 - `show_internal_actions` - If true, causes internal actions such as `_DISPATCH`
1513 to be shown in hit debug tables in the test server.
1514 - `use_request_uri_for_path` - Controls if the `REQUEST_URI` or `PATH_INFO` environment
1515 variable should be used for determining the request path.
1517 Most web server environments pass the requested path to the application using environment variables,
1518 from which Catalyst has to reconstruct the request base (i.e. the top level path to / in the application,
1519 exposed as `$c->request->base`) and the request path below that base.
1521 There are two methods of doing this, both of which have advantages and disadvantages. Which method is used
1522 is determined by the `$c->config(use_request_uri_for_path)` setting (which can either be true or false).
1524 - use\_request\_uri\_for\_path => 0
1526 This is the default (and the) traditional method that Catalyst has used for determining the path information.
1527 The path is generated from a combination of the `PATH_INFO` and `SCRIPT_NAME` environment variables.
1528 The allows the application to behave correctly when `mod_rewrite` is being used to redirect requests
1529 into the application, as these variables are adjusted by mod\_rewrite to take account for the redirect.
1531 However this method has the major disadvantage that it is impossible to correctly decode some elements
1532 of the path, as RFC 3875 says: "`Unlike a URI path, the PATH_INFO is not URL-encoded, and cannot
1533 contain path-segment parameters.`" This means PATH\_INFO is **always** decoded, and therefore Catalyst
1534 can't distinguish / vs %2F in paths (in addition to other encoded values).
1536 - use\_request\_uri\_for\_path => 1
1538 This method uses the `REQUEST_URI` and `SCRIPT_NAME` environment variables. As `REQUEST_URI` is never
1539 decoded, this means that applications using this mode can correctly handle URIs including the %2F character
1540 (i.e. with `AllowEncodedSlashes` set to `On` in Apache).
1542 Given that this method of path resolution is provably more correct, it is recommended that you use
1543 this unless you have a specific need to deploy your application in a non-standard environment, and you are
1544 aware of the implications of not being able to handle encoded URI paths correctly.
1546 However it also means that in a number of cases when the app isn't installed directly at a path, but instead
1547 is having paths rewritten into it (e.g. as a .cgi/fcgi in a public\_html directory, with mod\_rewrite in a
1548 .htaccess file, or when SSI is used to rewrite pages into the app, or when sub-paths of the app are exposed
1549 at other URIs than that which the app is 'normally' based at with `mod_rewrite`), the resolution of
1550 `$c->request->base` will be incorrect.
1552 - `using_frontend_proxy` - See ["PROXY SUPPORT"](#proxy-support).
1553 - `using_frontend_proxy_path` - Enabled [Plack::Middleware::ReverseProxyPath](https://metacpan.org/pod/Plack::Middleware::ReverseProxyPath) on your application (if
1554 installed, otherwise log an error). This is useful if your application is not running on the
1555 'root' (or /) of your host server. **NOTE** if you use this feature you should add the required
1556 middleware to your project dependency list since its not automatically a dependency of [Catalyst](https://metacpan.org/pod/Catalyst).
1557 This has been done since not all people need this feature and we wish to restrict the growth of
1558 [Catalyst](https://metacpan.org/pod/Catalyst) dependencies.
1559 - `encoding` - See ["ENCODING"](#encoding)
1561 This now defaults to 'UTF-8'. You my turn it off by setting this configuration
1564 - `abort_chain_on_error_fix`
1568 When there is an error in an action chain, the default behavior is to
1569 abort the processing of the remaining actions to avoid running them
1570 when the application is in an unexpected state.
1572 Before version 5.90070, the default used to be false. To keep the old
1573 behaviour, you can explicitly set the value to false. E.g.
1575 __PACKAGE__->config(abort_chain_on_error_fix => 0);
1577 If this setting is set to false, then the remaining actions are
1578 performed and the error is caught at the end of the chain.
1580 - `use_hash_multivalue_in_request`
1582 In [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) the methods `query_parameters`, `body_parametes`
1583 and `parameters` return a hashref where values might be scalar or an arrayref
1584 depending on the incoming data. In many cases this can be undesirable as it
1585 leads one to writing defensive code like the following:
1587 my ($val) = ref($c->req->parameters->{a}) ?
1588 @{$c->req->parameters->{a}} :
1589 $c->req->parameters->{a};
1591 Setting this configuration item to true will make [Catalyst](https://metacpan.org/pod/Catalyst) populate the
1592 attributes underlying these methods with an instance of [Hash::MultiValue](https://metacpan.org/pod/Hash::MultiValue)
1593 which is used by [Plack::Request](https://metacpan.org/pod/Plack::Request) and others to solve this very issue. You
1594 may prefer this behavior to the default, if so enable this option (be warned
1595 if you enable it in a legacy application we are not sure if it is completely
1596 backwardly compatible).
1598 - `skip_complex_post_part_handling`
1600 When creating body parameters from a POST, if we run into a multipart POST
1601 that does not contain uploads, but instead contains inlined complex data
1602 (very uncommon) we cannot reliably convert that into field => value pairs. So
1603 instead we create an instance of [Catalyst::Request::PartData](https://metacpan.org/pod/Catalyst::Request::PartData). If this causes
1604 issue for you, you can disable this by setting `skip_complex_post_part_handling`
1605 to true (default is false).
1607 - `skip_body_param_unicode_decoding`
1609 Generally we decode incoming POST params based on your declared encoding (the
1610 default for this is to decode UTF-8). If this is causing you trouble and you
1611 do not wish to turn all encoding support off (with the `encoding` configuration
1612 parameter) you may disable this step atomically by setting this configuration
1615 - `do_not_decode_query`
1617 If true, then do not try to character decode any wide characters in your
1618 request URL query or keywords. Most readings of the relevant specifications
1619 suggest these should be UTF-\* encoded, which is the default that [Catalyst](https://metacpan.org/pod/Catalyst)
1620 will use, however if you are creating a lot of URLs manually or have external
1621 evil clients, this might cause you trouble. If you find the changes introduced
1622 in Catalyst version 5.90080+ break some of your query code, you may disable
1623 the UTF-8 decoding globally using this configuration.
1625 This setting takes precedence over `default_query_encoding`
1627 - `do_not_check_query_encoding`
1629 Catalyst versions 5.90080 - 5.90106 would decode query parts of an incoming
1630 request but would not raise an exception when the decoding failed due to
1631 incorrect unicode. It now does, but if this change is giving you trouble
1632 you may disable it by setting this configuration to true.
1634 - `default_query_encoding`
1636 By default we decode query and keywords in your request URL using UTF-8, which
1637 is our reading of the relevant specifications. This setting allows one to
1638 specify a fixed value for how to decode your query. You might need this if
1639 you are doing a lot of custom encoding of your URLs and not using UTF-8.
1641 - `use_chained_args_0_special_case`
1643 In older versions of Catalyst, when more than one action matched the same path
1644 AND all those matching actions declared Args(0), we'd break the tie by choosing
1645 the first action defined. We now normalized how Args(0) works so that it
1646 follows the same rule as Args(N), which is to say when we need to break a tie
1647 we choose the LAST action defined. If this breaks your code and you don't
1648 have time to update to follow the new normalized approach, you may set this
1649 value to true and it will globally revert to the original chaining behavior.
1651 - `psgi_middleware` - See ["PSGI MIDDLEWARE"](#psgi-middleware).
1652 - `data_handlers` - See ["DATA HANDLERS"](#data-handlers).
1653 - `stats_class_traits`
1655 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your stats class.
1657 - `request_class_traits`
1659 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your request class.
1661 - `response_class_traits`
1663 An arrayref of [Moose::Role](https://metacpan.org/pod/Moose::Role)s that get composed into your response class.
1665 - `inject_components`
1667 A Hashref of [Catalyst::Component](https://metacpan.org/pod/Catalyst::Component) subclasses that are 'injected' into configuration.
1671 inject_components => {
1672 'Controller::Err' => { from_component => 'Local::Controller::Errors' },
1673 'Model::Zoo' => { from_component => 'Local::Model::Foo' },
1674 'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
1676 'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
1677 'Model::Zoo' => { a => 2 },
1678 'Model::Foo' => { a => 100 },
1681 Generally [Catalyst](https://metacpan.org/pod/Catalyst) looks for components in your Model/View or Controller directories.
1682 However for cases when you which to use an existing component and you don't need any
1683 customization (where for when you can apply a role to customize it) you may inject those
1684 components into your application. Please note any configuration should be done 'in the
1685 normal way', with a key under configuration named after the component affix, as in the
1688 Using this type of injection allows you to construct significant amounts of your application
1689 with only configuration!. This may or may not lead to increased code understanding.
1691 Please not you may also call the ->inject\_components application method as well, although
1692 you must do so BEFORE setup.
1696 Generally when you throw an exception inside an Action (or somewhere in
1697 your stack, such as in a model that an Action is calling) that exception
1698 is caught by Catalyst and unless you either catch it yourself (via eval
1699 or something like [Try::Tiny](https://metacpan.org/pod/Try::Tiny) or by reviewing the ["error"](#error) stack, it
1700 will eventually reach ["finalize\_errors"](#finalize_errors) and return either the debugging
1701 error stack page, or the default error page. However, if your exception
1702 can be caught by [Plack::Middleware::HTTPExceptions](https://metacpan.org/pod/Plack::Middleware::HTTPExceptions), [Catalyst](https://metacpan.org/pod/Catalyst) will
1703 instead rethrow it so that it can be handled by that middleware (which
1704 is part of the default middleware). For example this would allow
1706 use HTTP::Throwable::Factory 'http_throw';
1708 sub throws_exception :Local {
1709 my ($self, $c) = @_;
1711 http_throw(SeeOther => { location =>
1712 $c->uri_for($self->action_for('redirect')) });
1718 Catalyst uses internal actions like `_DISPATCH`, `_BEGIN`, `_AUTO`,
1719 `_ACTION`, and `_END`. These are by default not shown in the private
1720 action table, but you can make them visible with a config parameter.
1722 MyApp->config(show_internal_actions => 1);
1726 The request body is usually parsed at the beginning of a request,
1727 but if you want to handle input yourself, you can enable on-demand
1728 parsing with a config parameter.
1730 MyApp->config(parse_on_demand => 1);
1734 Many production servers operate using the common double-server approach,
1735 with a lightweight frontend web server passing requests to a larger
1736 backend server. An application running on the backend server must deal
1737 with two problems: the remote user always appears to be `127.0.0.1` and
1738 the server's hostname will appear to be `localhost` regardless of the
1739 virtual host that the user connected through.
1741 Catalyst will automatically detect this situation when you are running
1742 the frontend and backend servers on the same machine. The following
1743 changes are made to the request.
1745 $c->req->address is set to the user's real IP address, as read from
1746 the HTTP X-Forwarded-For header.
1748 The host value for $c->req->base and $c->req->uri is set to the real
1749 host, as read from the HTTP X-Forwarded-Host header.
1751 Additionally, you may be running your backend application on an insecure
1752 connection (port 80) while your frontend proxy is running under SSL. If there
1753 is a discrepancy in the ports, use the HTTP header `X-Forwarded-Port` to
1754 tell Catalyst what port the frontend listens on. This will allow all URIs to
1755 be created properly.
1757 In the case of passing in:
1759 X-Forwarded-Port: 443
1761 All calls to `uri_for` will result in an https link, as is expected.
1763 Obviously, your web server must support these headers for this to work.
1765 In a more complex server farm environment where you may have your
1766 frontend proxy server(s) on different machines, you will need to set a
1767 configuration option to tell Catalyst to read the proxied data from the
1770 MyApp->config(using_frontend_proxy => 1);
1772 If you do not wish to use the proxy support at all, you may set:
1774 MyApp->config(ignore_frontend_proxy => 0);
1776 ## Note about psgi files
1778 Note that if you supply your own .psgi file, calling
1779 `MyApp->psgi_app(@_);`, then **this will not happen automatically**.
1781 You either need to apply [Plack::Middleware::ReverseProxy](https://metacpan.org/pod/Plack::Middleware::ReverseProxy) yourself
1782 in your psgi, for example:
1785 enable "Plack::Middleware::ReverseProxy";
1789 This will unconditionally add the ReverseProxy support, or you need to call
1790 `$app = MyApp->apply_default_middlewares($app)` (to conditionally
1791 apply the support depending upon your config).
1793 See [Catalyst::PSGI](https://metacpan.org/pod/Catalyst::PSGI) for more information.
1797 Catalyst has been tested under Apache 2's threading `mpm_worker`,
1798 `mpm_winnt`, and the standalone forking HTTP server on Windows. We
1799 believe the Catalyst core to be thread-safe.
1801 If you plan to operate in a threaded environment, remember that all other
1802 modules you are using must also be thread-safe. Some modules, most notably
1803 [DBD::SQLite](https://metacpan.org/pod/DBD::SQLite), are not thread-safe.
1807 The [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) object uses [HTTP::Body](https://metacpan.org/pod/HTTP::Body) to populate 'classic' HTML
1808 form parameters and URL search query fields. However it has become common
1809 for various alternative content types to be PUT or POSTed to your controllers
1810 and actions. People working on RESTful APIs, or using AJAX often use JSON,
1811 XML and other content types when communicating with an application server. In
1812 order to better support this use case, [Catalyst](https://metacpan.org/pod/Catalyst) defines a global configuration
1813 option, `data_handlers`, which lets you associate a content type with a coderef
1814 that parses that content type into something Perl can readily access.
1821 __PACKAGE__->config(
1823 'application/json' => sub { local $/; decode_json $_->getline },
1825 ## Any other configuration.
1830 By default [Catalyst](https://metacpan.org/pod/Catalyst) comes with a generic JSON data handler similar to the
1831 example given above, which uses [JSON::MaybeXS](https://metacpan.org/pod/JSON::MaybeXS) to provide either [JSON::PP](https://metacpan.org/pod/JSON::PP)
1832 (a pure Perl, dependency free JSON parser) or [Cpanel::JSON::XS](https://metacpan.org/pod/Cpanel::JSON::XS) if you have
1833 it installed (if you want the faster XS parser, add it to you project Makefile.PL
1834 or dist.ini, cpanfile, etc.)
1836 The `data_handlers` configuration is a hashref whose keys are HTTP Content-Types
1837 (matched against the incoming request type using a regexp such as to be case
1838 insensitive) and whose values are coderefs that receive a localized version of
1839 `$_` which is a filehandle object pointing to received body.
1841 This feature is considered an early access release and we reserve the right
1842 to alter the interface in order to provide a performant and secure solution to
1843 alternative request body content. Your reports welcomed!
1847 You can define middleware, defined as [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) or a compatible
1848 interface in configuration. Your middleware definitions are in the form of an
1849 arrayref under the configuration key `psgi_middleware`. Here's an example
1850 with details to follow:
1855 use Plack::Middleware::StackTrace;
1857 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
1859 __PACKAGE__->config(
1860 'psgi_middleware', [
1863 $stacktrace_middleware,
1864 'Session' => {store => 'File'},
1869 $env->{myapp.customkey} = 'helloworld';
1878 So the general form is:
1880 __PACKAGE__->config(psgi_middleware => \@middleware_definitions);
1882 Where `@middleware` is one or more of the following, applied in the REVERSE of
1883 the order listed (to make it function similarly to [Plack::Builder](https://metacpan.org/pod/Plack::Builder):
1885 Alternatively, you may also define middleware by calling the ["setup\_middleware"](#setup_middleware)
1892 __PACKAGE__->setup_middleware( \@middleware_definitions);
1895 In the case where you do both (use 'setup\_middleware' and configuration) the
1896 package call to setup\_middleware will be applied earlier (in other words its
1897 middleware will wrap closer to the application). Keep this in mind since in
1898 some cases the order of middleware is important.
1900 The two approaches are not exclusive.
1904 An already initialized object that conforms to the [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware)
1907 my $stacktrace_middleware = Plack::Middleware::StackTrace->new;
1909 __PACKAGE__->config(
1910 'psgi_middleware', [
1911 $stacktrace_middleware,
1918 A coderef that is an inlined middleware:
1920 __PACKAGE__->config(
1921 'psgi_middleware', [
1926 if($env->{PATH_INFO} =~m/forced/) {
1928 ->new(file=>TestApp->path_to(qw/share static forced.txt/))
1931 return $app->($env);
1942 We assume the scalar refers to a namespace after normalizing it using the
1945 (1) If the scalar is prefixed with a "+" (as in `+MyApp::Foo`) then the full string
1946 is assumed to be 'as is', and we just install and use the middleware.
1948 (2) If the scalar begins with "Plack::Middleware" or your application namespace
1949 (the package name of your Catalyst application subclass), we also assume then
1950 that it is a full namespace, and use it.
1952 (3) Lastly, we then assume that the scalar is a partial namespace, and attempt to
1953 resolve it first by looking for it under your application namespace (for example
1954 if you application is "MyApp::Web" and the scalar is "MyMiddleware", we'd look
1955 under "MyApp::Web::Middleware::MyMiddleware") and if we don't find it there, we
1956 will then look under the regular [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) namespace (i.e. for the
1957 previous we'd try "Plack::Middleware::MyMiddleware"). We look under your application
1958 namespace first to let you 'override' common [Plack::Middleware](https://metacpan.org/pod/Plack::Middleware) locally, should
1959 you find that a good idea.
1965 __PACKAGE__->config(
1966 'psgi_middleware', [
1967 'Debug', ## MyAppWeb::Middleware::Debug->wrap or Plack::Middleware::Debug->wrap
1968 'Plack::Middleware::Stacktrace', ## Plack::Middleware::Stacktrace->wrap
1969 '+MyApp::Custom', ## MyApp::Custom->wrap
1974 - a scalar followed by a hashref
1976 Just like the previous, except the following `HashRef` is used as arguments
1977 to initialize the middleware object.
1979 __PACKAGE__->config(
1980 'psgi_middleware', [
1981 'Session' => {store => 'File'},
1984 Please see [PSGI](https://metacpan.org/pod/PSGI) for more on middleware.
1988 Starting in [Catalyst](https://metacpan.org/pod/Catalyst) version 5.90080 encoding is automatically enabled
1989 and set to encode all body responses to UTF8 when possible and applicable.
1990 Following is documentation on this process. If you are using an older
1991 version of [Catalyst](https://metacpan.org/pod/Catalyst) you should review documentation for that version since
1994 By default encoding is now 'UTF-8'. You may turn it off by setting
1995 the encoding configuration to undef.
1997 MyApp->config(encoding => undef);
1999 This is recommended for temporary backwards compatibility only.
2001 To turn it off for a single request use the [clear\_encoding](https://metacpan.org/pod/clear_encoding)
2002 method to turn off encoding for this request. This can be useful
2003 when you are setting the body to be an arbitrary block of bytes,
2004 especially if that block happens to be a block of UTF8 text.
2006 Encoding is automatically applied when the content-type is set to
2007 a type that can be encoded. Currently we encode when the content type
2008 matches the following regular expression:
2010 $content_type =~ /^text|xml$|javascript$/
2012 Encoding is set on the application, but it is copied to the context object
2013 so that you can override it on a request basis.
2015 Be default we don't automatically encode 'application/json' since the most
2016 common approaches to generating this type of response (Either via [Catalyst::View::JSON](https://metacpan.org/pod/Catalyst::View::JSON)
2017 or [Catalyst::Action::REST](https://metacpan.org/pod/Catalyst::Action::REST)) will do so already and we want to avoid double
2020 If you are producing JSON response in an unconventional manner (such
2021 as via a template or manual strings) you should perform the UTF8 encoding
2022 manually as well such as to conform to the JSON specification.
2024 NOTE: We also examine the value of $c->response->content\_encoding. If
2025 you set this (like for example 'gzip', and manually gzipping the body)
2026 we assume that you have done all the necessary encoding yourself, since
2027 we cannot encode the gzipped contents. If you use a plugin like
2028 [Catalyst::Plugin::Compress](https://metacpan.org/pod/Catalyst::Plugin::Compress) you need to update to a modern version in order
2029 to have this function correctly with the new UTF8 encoding code, or you
2030 can use [Plack::Middleware::Deflater](https://metacpan.org/pod/Plack::Middleware::Deflater) or (probably best) do your compression on
2037 Returns an instance of an `Encode` encoding
2039 print $c->encoding->name
2041 - handle\_unicode\_encoding\_exception ($exception\_context)
2043 Method called when decoding process for a request fails.
2045 An `$exception_context` hashref is provided to allow you to override the
2046 behaviour of your application when given data with incorrect encodings.
2048 The default method throws exceptions in the case of invalid request parameters
2049 (resulting in a 500 error), but ignores errors in upload filenames.
2051 The keys passed in the `$exception_context` hash are:
2055 The value which was not able to be decoded.
2059 The exception received from [Encode](https://metacpan.org/pod/Encode).
2063 What type of data was being decoded. Valid values are (currently)
2064 `params` - for request parameters / arguments / captures
2065 and `uploads` - for request upload filenames.
2071 Join #catalyst on irc.perl.org.
2075 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst
2076 http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
2080 http://catalyst.perl.org
2084 http://dev.catalyst.perl.org
2088 ## [Task::Catalyst](https://metacpan.org/pod/Task::Catalyst) - All you need to start with Catalyst
2090 ## [Catalyst::Manual](https://metacpan.org/pod/Catalyst::Manual) - The Catalyst Manual
2092 ## [Catalyst::Component](https://metacpan.org/pod/Catalyst::Component), [Catalyst::Controller](https://metacpan.org/pod/Catalyst::Controller) - Base classes for components
2094 ## [Catalyst::Engine](https://metacpan.org/pod/Catalyst::Engine) - Core engine
2096 ## [Catalyst::Log](https://metacpan.org/pod/Catalyst::Log) - Log class.
2098 ## [Catalyst::Request](https://metacpan.org/pod/Catalyst::Request) - Request object
2100 ## [Catalyst::Response](https://metacpan.org/pod/Catalyst::Response) - Response object
2102 ## [Catalyst::Test](https://metacpan.org/pod/Catalyst::Test) - The test suite.
2106 sri: Sebastian Riedel <sri@cpan.org>
2112 acme: Leon Brocard <leon@astray.com>
2114 abraxxa: Alexander Hartmaier <abraxxa@cpan.org>
2116 andrewalker: André Walker <andre@cpan.org>
2120 Andrew Ford <A.Ford@ford-mason.co.uk>
2124 andyg: Andy Grundman <andy@hybridized.org>
2126 audreyt: Audrey Tang
2128 bricas: Brian Cassidy <bricas@cpan.org>
2130 Caelum: Rafael Kitover <rkitover@io.com>
2132 chansen: Christian Hansen
2134 Chase Venters <chase.venters@gmail.com>
2136 chicks: Christopher Hicks
2138 Chisel Wright <pause@herlpacker.co.uk>
2140 Danijel Milicevic <me@danijel.de>
2142 davewood: David Schmidt <davewood@cpan.org>
2144 David Kamholz <dkamholz@cpan.org>
2146 David Naughton <naughton@umn.edu>
2150 dhoss: Devin Austin <dhoss@cpan.org>
2152 dkubb: Dan Kubb <dan.kubb-cpan@onautopilot.com>
2156 dwc: Daniel Westermann-Clark <danieltwc@cpan.org>
2158 esskar: Sascha Kiefer
2160 fireartist: Carl Franks <cfranks@cpan.org>
2162 frew: Arthur Axel "fREW" Schmidt <frioux@gmail.com>
2164 gabb: Danijel Milicevic
2168 Gavin Henry <ghenry@perl.me.uk>
2172 groditi: Guillermo Roditi <groditi@gmail.com>
2174 hobbs: Andrew Rodland <andrew@cleverdomain.org>
2176 ilmari: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org>
2178 jcamacho: Juan Camacho
2180 jester: Jesse Sheidlower <jester@panix.com>
2182 jhannah: Jay Hannah <jay@jays.net>
2188 jon: Jon Schutz <jjschutz@cpan.org>
2190 Jonathan Rockway <jrockway@cpan.org>
2192 Kieren Diment <kd@totaldatasolution.com>
2194 konobi: Scott McWhirter <konobi@cpan.org>
2196 marcus: Marcus Ramberg <mramberg@cpan.org>
2198 miyagawa: Tatsuhiko Miyagawa <miyagawa@bulknews.net>
2200 mgrimes: Mark Grimes <mgrimes@cpan.org>
2202 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
2206 naughton: David Naughton
2208 ningu: David Kamholz <dkamholz@cpan.org>
2210 nothingmuch: Yuval Kogman <nothingmuch@woobling.org>
2212 numa: Dan Sully <daniel@cpan.org>
2218 omega: Andreas Marienborg
2220 Oleg Kostyuk <cub.uanic@gmail.com>
2222 phaylon: Robert Sedlacek <phaylon@dunkelheit.at>
2224 rafl: Florian Ragwitz <rafl@debian.org>
2226 random: Roland Lammel <lammel@cpan.org>
2228 revmischa: Mischa Spiegelmock <revmischa@cpan.org>
2230 Robert Sedlacek <rs@474.at>
2232 SpiceMan: Marcel Montes
2236 szbalint: Balint Szilakszi <szbalint@cpan.org>
2238 t0m: Tomas Doran <bobtfish@bobtfish.net>
2242 vanstyn: Henry Van Styn <vanstyn@cpan.org>
2244 Viljo Marrandi <vilts@yahoo.com>
2246 Will Hawes <info@whawes.co.uk>
2248 willert: Sebastian Willert <willert@cpan.org>
2250 wreis: Wallace Reis <wreis@cpan.org>
2252 Yuval Kogman <nothingmuch@woobling.org>
2254 rainboxx: Matthias Dietrich <perl@rainboxx.de>
2256 dd070: Dhaval Dhanani <dhaval070@gmail.com>
2258 Upasana <me@upasana.me>
2260 John Napiorkowski (jnap) <jjnapiork@cpan.org>
2264 Copyright (c) 2005-2015, the above named PROJECT FOUNDER and CONTRIBUTORS.
2268 This library is free software. You can redistribute it and/or modify it under
2269 the same terms as Perl itself.