X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FIntro.pod;h=794a8ef98bd039deae3e587a4481948a70bfed4f;hp=28646636380e4204824b495344dc26a217c7cc6f;hb=70101578f37ea270f0dfe170b6bab8373aaf69d9;hpb=e8556dab015903c85f3a413224a12493d95a7934 diff --git a/lib/Catalyst/Manual/Intro.pod b/lib/Catalyst/Manual/Intro.pod index 2864663..794a8ef 100644 --- a/lib/Catalyst/Manual/Intro.pod +++ b/lib/Catalyst/Manual/Intro.pod @@ -23,7 +23,7 @@ possible to do things in a different way. Other web frameworks are I simpler to use, but achieve this by locking the programmer into a single set of tools. Catalyst's emphasis on flexibility means that you have to think more to use it. We view this as a feature. For -example, this leads to Catalyst being more suited to system integration +example, this leads to Catalyst being better suited to system integration tasks than other web frameworks. =head3 MVC @@ -53,7 +53,7 @@ L, L... =item * B Control the whole request phase, check parameters, dispatch actions, flow -control. Catalyst itself! +control. This is the meat of where Catalyst works. =back @@ -104,7 +104,7 @@ example: Now http://localhost:3000/hello prints "Hello World!". -Note that actions with the C< :Global > attribute are equivalent to +Note that actions with the C< :Local > attribute are equivalent to using a C<:Path('action_name') > attribute, so our action could be equivalently: @@ -124,6 +124,12 @@ if you end up using it). =back +=item * PSGI Support + +Starting with Catalyst version 5.9 Catalyst ships with L integration +for even more powerful and flexible testing and deployment options. See +L for details. + =head3 Simplicity The best part is that Catalyst implements all this flexibility in a very @@ -357,7 +363,7 @@ Now we can create a DBIC::Schema model for this database. script/myapp_create.pl model MyModel DBIC::Schema MySchema create=static 'dbi:SQLite:/tmp/myapp.db' -L can automaticall load table layouts and +L can automatically load table layouts and relationships, and convert them into a static schema definition C, which you can edit later. @@ -759,7 +765,7 @@ will look at the URL it is processing, and the actions that it has found, and automatically call the actions it finds that match the circumstances of the request. -The URL (for example http://localhost.3000/foo/bar) consists of two +The URL (for example http://localhost:3000/foo/bar) consists of two parts, the base, describing how to connect to the server (http://localhost:3000/ in this example) and the path, which the server uses to decide what to return (foo/bar). Please note that the @@ -784,7 +790,7 @@ of Catalyst component class names. =item * B -Note that __PACKAGE__->config->{namespace} can be used to override the +Note that I<< __PACKAGE__->config->(namespace => ... ) >> can be used to override the current namespace when matching. So: package MyApp::Controller::Example; @@ -792,7 +798,7 @@ current namespace when matching. So: would normally use 'example' as its namespace for matching, but if this is specially overridden with - __PACKAGE__->config->{namespace}='thing'; + __PACKAGE__->config( namespace => 'thing' ); it matches using the namespace 'thing' instead. @@ -804,25 +810,29 @@ application (e.g. http://localhost:3000/ ): package MyApp::Controller::Root; use base 'Catalyst::Controller'; + # Sets the actions in this controller to be registered with no prefix # so they function identically to actions created in MyApp.pm - __PACKAGE__->config->{namespace} = ''; + + __PACKAGE__->config( namespace => ''); + sub default : Path { my ( $self, $context ) = @_; $context->response->status(404); $context->response->body('404 not found'); } + 1; The code - __PACKAGE__->config->{namespace} = ''; + __PACKAGE__->config( namespace => '' ); makes the controller act as if its namespace is empty. As you'll see -below, an empty namespace makes many of the URL-matching attributes, -such as :Path, :Local and :Global matches, match at the start of the -URL path. +below, an empty namespace makes many of the URL-matching attributes, such +as :Path and :Local match at the start of the URL path (i.e. the +application root). =back @@ -847,22 +857,33 @@ of the path is passed as arguments. Matches any URL beginning with> http://localhost:3000/my/controller/foo. The namespace and subroutine name together determine the path. -=item * Namespace-level (C<:Global>) +=item * Root-level (C<:Global>) package MyApp::Controller::Foo; - sub foo : Global { } -Matches http://localhost:3000/foo - that is, the action is mapped -directly to the controller namespace, ignoring the function name. + sub bar : Global { + my ($self, $c) = @_; + $c->res->body( + $c->res->body('sub bar in Controller::Foo triggered on a request for ' + . $c->req->uri)); + } -C<:Global> is equivalent C<:Local> one level higher in -the namespace. +1; - package MyApp::Controller::Root; - __PACKAGE__->config->{namespace}=''; - sub foo : Local { } +Matches http://localhost:3000/foo - that is, the action is mapped +directly to the method name, ignoring the controller namespace. + +C<:Global> always matches from the application root: it is simply +shorthandfor C<:Path('/methodname')>. C<:Local> is shorthand for +C<:Path('methodname')>, which takes the controller namespace as described +above. -Use whichever makes the most sense for your application. +Usage of the C handler is rare in all but very old Catalyst +applications (e.g. before Catalyst 5.7). The use cases where C +used to make sense are now largely replaced by the C dispatch +type, or by empty C declarations on an controller action. C +is still included in Catalyst for backwards compatibility, although +legitimate use-cases for it may still exist. =item * Changing handler behaviour: eating arguments (C<:Args>) @@ -887,7 +908,9 @@ C<:Args(0)> means that no arguments are taken. Thus, the URL and path must match precisely. No :Args at all means that B of arguments are taken. Thus, any -URL that B the controller's path will match. +URL that B the controller's path will match. Obviously, this means +you cannot chain from an action that does not specify args, as the next action +in the chain will be swallowed as an arg to the first! =item * Literal match (C<:Path>) @@ -1096,7 +1119,7 @@ turn. sub auto : Private { } C, however, doesn't override like this: providing they exist, -C, C and +C, C and C would be called in turn. Here are some examples of the order in which the various built-ins