=head1 SYNOPSIS
+ # Install Catalyst::Devel for helpers and other development tools
# use the helper to create a new application
catalyst.pl MyApp
=head1 DESCRIPTION
-Catalyst is a modern framework for making web applications without the pain usually associated with this process. This document is a reference to the main Catalyst application. If you are a new user, we suggest you start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>
+Catalyst is a modern framework for making web applications without the
+pain usually associated with this process. This document is a reference
+to the main Catalyst application. If you are a new user, we suggest you
+start with L<Catalyst::Manual::Tutorial> or L<Catalyst::Manual::Intro>.
See L<Catalyst::Manual> for more documentation.
use Catalyst qw/-Debug My::Module/;
The position of plugins and flags in the chain is important, because
-they are loaded in exactly the order in which they appear.
+they are loaded in the order in which they appear.
The following flags are supported:
=head2 -Debug
Enables debug output. You can also force this setting from the system
-environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment settings
-override the app, with <MYAPP>_DEBUG having highest priority.
+environment with CATALYST_DEBUG or <MYAPP>_DEBUG. The environment
+settings override the application, with <MYAPP>_DEBUG having the highest
+priority.
=head2 -Engine
Forces Catalyst to use a specific home directory, e.g.:
- use Catalyst qw[-Home=/usr/sri];
+ use Catalyst qw[-Home=/usr/mst];
=head2 -Log
=head2 $c->namespace
-Returns the namespace of the current action, i.e., the uri prefix
+Returns the namespace of the current action, i.e., the URI prefix
corresponding to the controller of the current action. For example:
# in Controller::Foo::Bar
=head2 $c->req
-Returns the current L<Catalyst::Request> object. See
-L<Catalyst::Request>.
+Returns the current L<Catalyst::Request> object, giving access to
+information about the current client request (including parameters,
+cookies, HTTP headers, etc.). See L<Catalyst::Request>.
=head2 REQUEST FLOW HANDLING
=head2 $c->forward( $class, $method, [, \@arguments ] )
-Forwards processing to another action, by it's private name. If you give a
+Forwards processing to another action, by its private name. If you give a
class name but no method, C<process()> is called. You may also optionally
pass arguments in an arrayref. The action will receive the arguments in
C<@_> and C<$c-E<gt>req-E<gt>args>. Upon returning from the function,
$c->forward(qw/MyApp::Model::DBIC::Foo do_stuff/);
$c->forward('MyApp::View::TT');
-Note that forward implies an C<<eval { }>> around the call (well, actually
-C<execute> does), thus de-fatalizing all 'dies' within the called action. If
-you want C<die> to propagate you need to do something like:
+Note that forward implies an C<<eval { }>> around the call (actually
+C<execute> does), thus de-fatalizing all 'dies' within the called
+action. If you want C<die> to propagate you need to do something like:
$c->forward('foo');
die $c->error if $c->error;
-Or make sure to always return true values from your actions and write your code
-like this:
+Or make sure to always return true values from your actions and write
+your code like this:
$c->forward('foo') || return;
=head2 $c->res
-Returns the current L<Catalyst::Response> object.
+Returns the current L<Catalyst::Response> object, q.v.
=head2 $c->stash
it between components during a request. You can also set hash keys by
passing arguments. The stash is automatically sent to the view. The
stash is cleared at the end of a request; it cannot be used for
-persistent storage.
+persistent storage (for this you must use a session; see
+L<Catalyst::Plugin::Session> for a complete system integrated with
+Catalyst).
$c->stash->{foo} = $bar;
$c->stash( { moose => 'majestic', qux => 0 } );
}
-
-
# search via regex
sub _comp_search {
my ( $c, @names ) = @_;
$c->controller('Foo')->do_stuff;
-If name is omitted, will return the controller for the dispatched action.
+If the name is omitted, will return the controller for the dispatched
+action.
=cut
$c->view('Foo')->do_stuff;
-If the name is omitted, it will look for a config setting 'default_view',
-or check if there is only one view, and forward to it if that's the case.
+If the name is omitted, it will look for a config setting
+'default_view', or check if there is only one view, and forward to it if
+that's the case.
=cut
=head2 $c->log
-Returns the logging object instance. Unless it is already set, Catalyst sets
-this up with a L<Catalyst::Log> object. To use your own log class, set the
-logger with the C<< __PACKAGE__->log >> method prior to calling
+Returns the logging object instance. Unless it is already set, Catalyst
+sets this up with a L<Catalyst::Log> object. To use your own log class,
+set the logger with the C<< __PACKAGE__->log >> method prior to calling
C<< __PACKAGE__->setup >>.
__PACKAGE__->log( MyLogger->new );
$c->log->info( 'Now logging with my own logger!' );
-Your log class should implement the methods described in the
-L<Catalyst::Log> man page.
+Your log class should implement the methods described in
+L<Catalyst::Log>.
=head2 $c->debug
=head2 $c->uri_for( $path, @args?, \%query_values? )
-Merges path with C<$c-E<gt>request-E<gt>base> for absolute uri's and
-with C<$c-E<gt>namespace> for relative uri's, then returns a
-normalized L<URI> object. If any args are passed, they are added at the
-end of the path. If the last argument to uri_for is a hash reference,
-it is assumed to contain GET parameter key/value pairs, which will be
-appended to the URI in standard fashion.
+Merges path with C<$c-E<gt>request-E<gt>base> for absolute URIs and with
+C<$c-E<gt>namespace> for relative URIs, then returns a normalized L<URI>
+object. If any args are passed, they are added at the end of the path.
+If the last argument to C<uri_for> is a hash reference, it is assumed to
+contain GET parameter key/value pairs, which will be appended to the URI
+in standard fashion.
-Instead of $path, you can also optionally pass a $action object which will
-be resolved to a path using $c->dispatcher->uri_for_action; if the first
-element of @args is an arrayref it is treated as a list of captures to be
-passed to uri_for_action.
+Instead of C<$path>, you can also optionally pass a C<$action> object
+which will be resolved to a path using
+C<$c-E<gt>dispatcher-E<gt>uri_for_action>; if the first element of
+C<@args> is an arrayref it is treated as a list of captures to be passed
+to C<uri_for_action>.
=cut
=head2 $c->setup_components
-Sets up components. Specify a C<setup_components> config option to pass additional options
-directly to L<Module::Pluggable>. To add additional search paths, specify a key named
-C<search_extra> as an array reference. Items in the array beginning with C<::> will have the
+Sets up components. Specify a C<setup_components> config option to pass
+additional options directly to L<Module::Pluggable>. To add additional
+search paths, specify a key named C<search_extra> as an array
+reference. Items in the array beginning with C<::> will have the
application class name prepended to them.
=cut
=head2 $c->stack
-Returns an arrayref of the internal execution stack (actions that are currently
-executing).
+Returns an arrayref of the internal execution stack (actions that are
+currently executing).
=head2 $c->write( $data )
=head1 THREAD SAFETY
-Catalyst has been tested under Apache 2's threading mpm_worker, mpm_winnt,
-and the standalone forking HTTP server on Windows. We believe the Catalyst
-core to be thread-safe.
+Catalyst has been tested under Apache 2's threading C<mpm_worker>,
+C<mpm_winnt>, and the standalone forking HTTP server on Windows. We
+believe the Catalyst core to be thread-safe.
If you plan to operate in a threaded environment, remember that all other
modules you are using must also be thread-safe. Some modules, most notably
=head1 INSTALLATION
-On one hand, Catalyst gains immediate power and flexibility
-through its use of CPAN (the Comprehensive Perl Archive
-Network, an enormous global repository containing over 10,000
-free modules). On the other hand, Catalyst's reliance on CPAN
-can complicate initial installations, especially in
-shared-hosting environments where you, the user, do not have
-easy control over what versions other modules are installed.
-
-It is worth stressing that the difficulties found in installing
-Catalyst are caused not by anything intrinsic to Catalyst
-itself, but rather by the interrelated dependencies of a large
-number of required modules.
-
-Fortunately, there are a growing number of methods that can
-dramatically ease this undertaking:
+One of the frequent problems reported by new users of Catalyst is that
+it can be extremely time-consuming and difficult to install.
+
+One of the great strengths of Perl as a programming language is its use
+of CPAN, the Comprehensive Perl Archive Network, an enormous global
+repository containing over 10,000 free modules. For almost any basic
+task--and a very large number of non-basic ones--there is a module on
+CPAN that will help you. Catalyst has taken advantage of this, and uses
+a very large number of CPAN modules, rather than reinventing the wheel
+over and over again. On the one hand, Catalyst gains power and
+flexibility through this re-use of existing code. On the other hand,
+Catalyst's reliance on CPAN can complicate initial installations,
+especially in shared-hosting environments where you, the user, do not
+have easy control over what versions of other modules are installed.
+
+It is worth stressing that the difficulties found in installing Catalyst
+are caused not by anything intrinsic to Catalyst itself, but rather by
+the interrelated dependencies of a large number of required modules.
+
+Fortunately, there are a growing number of methods that can dramatically
+ease this undertaking. Note that for many of these, you will probably
+need to install additional Catalyst-related modules (especially plugins)
+to do the things you want. As of version 5.70, Catalyst has split into
+two packages, L<Catalyst::Runtime>, which includes the core elements
+necessary to deploy a Catalyst application, and L<Catalyst::Devel>,
+which includes the Helpers and other things necessary or useful for
+developing Catalyst applications. In a purely deployment environment
+you can omit L<Catalyst::Devel>.
=over 4
running on your system. Just download the script from the link above
and type C<perl cat-install>. This script automates the process of
installing Catalyst itself and its dependencies, with bits of overriding
-so that the process does not require user interaction.
+so that the process does not require user interaction. C<cat-install>
+installs Catalyst and its dependencies using the L<CPAN> module, so that
+modules are installed the same way you would probably install them
+normally--it just makes it easier. This is a recommended solution for
+installation.
=item *
CPAN
-The traditional way to install Catalyst is directly from CPAN using
+The traditional way to install Catalyst is directly from CPAN using the
C<Task::Catalyst> bundle:
$ perl -MCPAN -e 'install Task::Catalyst'
=back
-B<NOTE:> Although all of the above methods can be used to
-install a base Catalyst system, only the VMWare image is
-likely to have all of the plugins and modules you need to use
-Catalyst properly, and to complete the tutorial. When you
-start the C<script/myapp_server.pl> development server, it
-will tell you about any modules that are missing. To add
-them, type something along the lines of the following
-(C<Catalyst::Model::DBIC::Schema> is used here as a
-representative example):
+B<NOTE:> Although all of the above methods can be used to install a base
+Catalyst system, only the VMWare image is likely to have all of the
+plugins and modules you need to use Catalyst properly. When you start
+the C<script/myapp_server.pl> development server, it will tell you about
+any modules that are missing. To add them, type something along the
+lines of the following (C<Catalyst::Model::DBIC::Schema> is used here as
+a representative example):
# perl -MCPAN -e 'install Catalyst::Model::DBIC::Schema'
...
projects / catagits/Catalyst-Runtime.git / commitdiff