X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Manual.git;a=blobdiff_plain;f=lib%2FCatalyst%2FManual%2FTutorial%2FCatalystBasics.pod;h=13209c0cd5f49f1b423661dc6c85ab9889827259;hp=c1e1b91ba9e1e91def9c9485d9d531f8d6eae408;hb=779cf508642c2883ea3b86ce46fe6db230069ef7;hpb=3533daff0314522f79dff9c618da087568f1378c diff --git a/lib/Catalyst/Manual/Tutorial/CatalystBasics.pod b/lib/Catalyst/Manual/Tutorial/CatalystBasics.pod index c1e1b91..13209c0 100644 --- a/lib/Catalyst/Manual/Tutorial/CatalystBasics.pod +++ b/lib/Catalyst/Manual/Tutorial/CatalystBasics.pod @@ -73,7 +73,7 @@ clean "separation of control" between the different portions of your application. Given that many other documents cover this subject in detail, MVC will not be discussed in depth here (for an excellent introduction to MVC and general Catalyst concepts, please see -L. In short: +L. In short: =over 4 @@ -108,7 +108,7 @@ to persist and restore objects to/from a relational database. You can checkout the source code for this example from the catalyst subversion repository as per the instructions in -L +L =head1 CREATE A CATALYST PROJECT @@ -145,7 +145,7 @@ directories and files it creates: View # Directory for Views Hello.pm # Base application module Makefile.PL # Makefile to build application - hello.yml # Application configuration file + hello.conf # Application configuration file README # README file root # Equiv of htdocs, dir for templates, css, javascript favicon.ico @@ -192,7 +192,7 @@ server: [debug] Loaded dispatcher "Catalyst::Dispatcher" [debug] Loaded engine "Catalyst::Engine::HTTP" [debug] Found home "/home/me/Hello" - [debug] Loaded Config "/home/me/Hello/hello.yml" + [debug] Loaded Config "/home/me/Hello/hello.conf" [debug] Loaded components: .-----------------------------------------------------------------+----------. | Class | Type | @@ -242,22 +242,25 @@ responsible for displaying the welcome screen that you just saw in your browser. Later on you'll want to change that to something more reasonable, such as a "404" message but for now just leave it alone. - sub default : Path : Args { + sub default :Path :Args { my ( $self, $c ) = @_; - + $c->response->body( $c->welcome_message ); } The "C<$c>" here refers to the Catalyst context, which is used to access the Catalyst application. In addition to many other things, the Catalyst context provides access to "response" and "request" -objects. (See L, L, and L) +objects. (See L, +L, and +L) -C<$c->response->body> sets the HTTP response (see -L), while C<$c->welcome_message> is a special method -that returns the welcome message that you saw in your browser. +C<$c-Eresponse-Ebody> sets the HTTP response (see +L), while C<$c-Ewelcome_message> +is a special method that returns the welcome message that you saw in +your browser. -The ": Path : Args" after the method name are attributes which determine +The ":Path :Args" after the method name are attributes which determine which URLs will be dispatched to this method. (Depending on your version of Catalyst, it used to say "Private" but using that with default is currently deprecated.) @@ -280,17 +283,19 @@ to the package C, and the C method. -Add the following subroutine to your Root.pm file: +Add the following subroutine to your C +file: sub hello : Global { my ( $self, $c ) = @_; + $c->response->body("Hello, World!"); } Here you're sending your own string to the webpage. Save the file, start the server (stop and restart it if it's still -up), and go to L to +up), and go to L to see "Hello, World!" =head2 Hello, World! Using a View and a Template @@ -318,9 +323,9 @@ Now that the TT.pm "View" exists, Catalyst will autodiscover it and be able to use it to display the view templates, using the "process" method that it inherits from the C. -Template Toolkit is a rather complicated template facility, with -excellent docs at -L, +Template Toolkit is a very full featured template facility, with +excellent documentation at +L, but since this is not a TT tutorial, we'll stick to only basic TT usage here (and explore some of the more common TT features in later parts of the tutorial). @@ -331,30 +336,31 @@ a simple sample: [% META title = 'Hello, World!' %]

- This is a TT view template, located in the root directory. + This is a TT view template, located in the 'root/' directory.

[% and %] are markers for the TT parts of the template. Inside you can access Perl variables and classes, and use TT directives. The rest of -the template is normal HTML. Change the hello method in Root.pm to the -following: +the template is normal HTML. Change the hello method in +C to the following: sub hello : Global { my ( $self, $c ) = @_; + $c->stash->{template} = 'hello.tt'; } -This time, instead of doing C<$c->response->body()>, you are setting +This time, instead of doing C<$c-Eresponse->body()>, you are setting the value of the "template" hash key in the Catalyst "stash", an area for putting information to share with other parts of your application. The "template" key determines which template will be displayed at the end of the method. Catalyst controllers have a default "end" action for all methods which causes the first (or default) view to be -rendered (unless there's a C<$c->response->body()> statement). So your +rendered (unless there's a C<$c-Eresponse->body()> statement). So your template will be magically displayed at the end of your method. After saving the file, restart the development server, and look at -L again. You should +L again. You should see the template that you just made. @@ -369,10 +375,11 @@ file). Bring Site.pm up in your editor, and you can see that there's not much there. Most people probably don't bother to use the create script to make controllers after they're used to using Catalyst. -In Site.pm, add the following method: +In C, add the following method: sub test : Local { my ( $self, $c ) = @_; + $c->stash->{username} = "John"; $c->stash->{template} = 'site/test.tt'; } @@ -389,14 +396,14 @@ naming convention). We've also put the variable "name" into the stash, for use in the template. Make a subdirectory "site" in the "root" directory. Copy the hello.tt -file into the directory as root/site/test.tt, or create a new template -file at that location. Include a line like: +file into the directory as C, or create a new +template file at that location. Include a line like: -

Hello, [% username %]!

+

Hello, [% username %]!

Bring up or restart the server. Notice in the server output that C is listed in the Loaded Path actions. Go to -L +L You should see your test.tt file displayed, including the name "John" that you set in the controller. @@ -411,5 +418,5 @@ Please report any errors, issues or suggestions to the author. The most recent version of the Catalyst Tutorial can be found at L. -Copyright 2006, Kennedy Clark & Gerda Shank, under Creative Commons License +Copyright 2006-2008, Kennedy Clark & Gerda Shank, under Creative Commons License (L).