lib/Catalyst/Manual/Tutorial/02_CatalystBasics.pod

   1 =head1 NAME
   2
   3 Catalyst::Manual::Tutorial::02_CatalystBasics - Catalyst Tutorial - Chapter 2: Catalyst Application Development Basics
   4
   5
   6 =head1 OVERVIEW
   7
   8 This is B<Chapter 2 of 10> for the Catalyst tutorial.
   9
  10 L<Tutorial Overview|Catalyst::Manual::Tutorial>
  11
  12 =over 4
  13
  14 =item 1
  15
  16 L<Introduction|Catalyst::Manual::Tutorial::01_Intro>
  17
  18 =item 2
  19
  20 B<02_Catalyst Basics>
  21
  22 =item 3
  23
  24 L<More Catalyst Basics|Catalyst::Manual::Tutorial::03_MoreCatalystBasics>
  25
  26 =item 4
  27
  28 L<Basic CRUD|Catalyst::Manual::Tutorial::04_BasicCRUD>
  29
  30 =item 5
  31
  32 L<Authentication|Catalyst::Manual::Tutorial::05_Authentication>
  33
  34 =item 6
  35
  36 L<Authorization|Catalyst::Manual::Tutorial::06_Authorization>
  37
  38 =item 7
  39
  40 L<Debugging|Catalyst::Manual::Tutorial::07_Debugging>
  41
  42 =item 8
  43
  44 L<Testing|Catalyst::Manual::Tutorial::08_Testing>
  45
  46 =item 9
  47
  48 L<Advanced CRUD|Catalyst::Manual::Tutorial::09_AdvancedCRUD>
  49
  50 =item 10
  51
  52 L<Appendices|Catalyst::Manual::Tutorial::10_Appendices>
  53
  54 =back
  55
  56
  57 =head1 DESCRIPTION
  58
  59 In this chapter of the tutorial, we will create a very basic Catalyst
  60 web application, demonstrating a number of powerful capabilities, such
  61 as:
  62
  63 =over 4
  64
  65 =item * Helper Scripts
  66
  67 Catalyst helper scripts that can be used to rapidly bootstrap the
  68 skeletal structure of an application.
  69
  70 =item * MVC
  71
  72 Model/View/Controller (MVC) provides an architecture that facilitates a
  73 clean "separation of control" between the different portions of your
  74 application. Given that many other documents cover this subject in
  75 detail, MVC will not be discussed in depth here (for an excellent
  76 introduction to MVC and general Catalyst concepts, please see
  77 L<Catalyst::Manual::About|Catalyst::Manual::About>). In short:
  78
  79 =over 4
  80
  81 =item * Model
  82
  83 The model usually represents a data store. In most applications, the
  84 model equates to the objects that are created from and saved to your SQL
  85 database.
  86
  87 =item * View
  88
  89 The view takes model objects and renders them into something for the end
  90 user to look at. Normally this involves a template-generation tool that
  91 creates HTML for the user's web browser, but it could easily be code
  92 that generates other forms such as PDF documents, e-mails, spreadsheets,
  93 or even "behind the scenes" formats such as XML and JSON.
  94
  95 =item * Controller
  96
  97 As suggested by its name, the controller takes user requests and routes
  98 them to the necessary model and view.
  99
 100 =back
 101
 102 =item * ORM
 103
 104 The use of Object-Relational Mapping (ORM) technology for database
 105 access. Specifically, ORM provides an automated and standardized means
 106 to persist and restore objects to/from a relational database and will
 107 automatically create our Catalyst model for use with a database.
 108
 109 =back
 110
 111 You can checkout the source code for this example from the catalyst
 112 subversion repository as per the instructions in
 113 L<Catalyst::Manual::Tutorial::01_Intro|Catalyst::Manual::Tutorial::01_Intro>.
 114
 115
 116 =head1 CREATE A CATALYST PROJECT
 117
 118 Catalyst provides a number of helper scripts that can be used to
 119 quickly flesh out the basic structure of your application. All
 120 Catalyst projects begin with the C<catalyst.pl> helper (see
 121 L<Catalyst::Helper|Catalyst::Helper> for more information on helpers).
 122 Also note that as of Catalyst 5.7000, you will not have the helper
 123 scripts unless you install both L<Catalyst::Runtime|Catalyst::Runtime>
 124 and L<Catalyst::Devel|Catalyst::Devel>.
 125
 126 In this first chapter of the tutorial, use the Catalyst C<catalyst.pl>
 127 script to initialize the framework for an application called C<Hello>:
 128
 129     $ catalyst.pl Hello
 130     created "Hello"
 131     created "Hello/script"
 132     created "Hello/lib"
 133     created "Hello/root"
 134     ...
 135     created "Hello/script/hello_create.pl"
 136     Change to application directory and Run "perl Makefile.PL" to make sure your install is complete
 137     $ cd Hello
 138
 139 Note: If you are using Strawberry Perl on Win32, drop the ".pl"
 140 from the end of the "catalyst.pl" command and simply use
 141 "catalyst Hello".
 142
 143 The C<catalyst.pl> helper script will display the names of the
 144 directories and files it creates:
 145
 146     Changes               # Record of application changes
 147     lib                   # Lib directory for your app's Perl modules
 148         Hello             # Application main code directory
 149             Controller    # Directory for Controller modules
 150             Model         # Directory for Models
 151             View          # Directory for Views
 152         Hello.pm          # Base application module
 153     Makefile.PL           # Makefile to build application
 154     hello.conf            # Application configuration file
 155     README                # README file
 156     root                  # Equiv of htdocs, dir for templates, css, javascript
 157         favicon.ico
 158         static            # Directory for static files
 159             images        # Directory for image files used in welcome screen
 160     script                # Directory for Perl scripts
 161         hello_cgi.pl      # To run your app as a cgi (not recommended)
 162         hello_create.pl   # To create models, views, controllers
 163         hello_fastcgi.pl  # To run app as a fastcgi program
 164         hello_server.pl   # The normal development server
 165         hello_test.pl     # Test your app from the command line
 166     t                     # Directory for tests
 167         01app.t           # Test scaffold
 168         02pod.t
 169         03podcoverage.t
 170
 171
 172 Catalyst will "auto-discover" modules in the Controller, Model, and
 173 View directories. When you use the hello_create.pl script it will
 174 create Perl module scaffolds in those directories, plus test files in
 175 the "t" directory. The default location for templates is in the "root"
 176 directory. The scripts in the script directory will always start with
 177 the lowercased version of your application name. If your app is
 178 MaiTai, then the create script would be "maitai_create.pl".
 179
 180 Though it's too early for any significant celebration, we already have
 181 a functioning application. We can use the Catalyst supplied script to
 182 start up a development server and view the default Catalyst page in
 183 your browser. All scripts in the script directory should be run from
 184 the base directory of your application, so change to the Hello
 185 directory.
 186
 187 Run the following command to start up the built-in development web
 188 server (make sure you didn't forget the "C<cd Hello>" from the
 189 previous step):
 190
 191 B<Note>: the -r enables reloading on code changes so you don't have to stop and
 192 start the server when you update code. see perldoc script/hello_server.pl for
 193 more useful options.
 194
 195     $ script/hello_server.pl -r
 196     [debug] Debug messages enabled
 197     [debug] Statistics enabled
 198     [debug] Loaded plugins:
 199     .----------------------------------------------------------------------------.
 200     | Catalyst::Plugin::ConfigLoader  0.27                                       |
 201     '----------------------------------------------------------------------------'
 202
 203     [debug] Loaded dispatcher "Catalyst::Dispatcher"
 204     [debug] Loaded engine "Catalyst::Engine::HTTP"
 205     [debug] Found home "/home/me/Hello"
 206     [debug] Loaded Config "/home/me/Hello/hello.conf"
 207     [debug] Loaded components:
 208     .-----------------------------------------------------------------+----------.
 209     | Class                                                           | Type     |
 210     +-----------------------------------------------------------------+----------+
 211     | Hello::Controller::Root                                         | instance |
 212     '-----------------------------------------------------------------+----------'
 213
 214     [debug] Loaded Private actions:
 215     .----------------------+--------------------------------------+--------------.
 216     | Private              | Class                                | Method       |
 217     +----------------------+--------------------------------------+--------------+
 218     | /default             | Hello::Controller::Root              | default      |
 219     | /end                 | Hello::Controller::Root              | end          |
 220     | /index               | Hello::Controller::Root              | index        |
 221     '----------------------+--------------------------------------+--------------'
 222
 223     [debug] Loaded Path actions:
 224     .-------------------------------------+--------------------------------------.
 225     | Path                                | Private                              |
 226     +-------------------------------------+--------------------------------------+
 227     | /                                   | /index                               |
 228     | /                                   | /default                             |
 229     '-------------------------------------+--------------------------------------'
 230
 231     [info] Hello powered by Catalyst 5.80018
 232     You can connect to your server at http://debian:3000
 233
 234 Point your web browser to L<http://localhost:3000> (substituting a
 235 different hostname or IP address as appropriate) and you should be
 236 greeted by the Catalyst welcome screen (if you get some other welcome
 237 screen or an "Index" screen, you probably forgot to specify port 3000
 238 in your URL).  Information similar to the following should be appended
 239 to the logging output of the development server:
 240
 241     [info] *** Request 1 (0.001/s) [23194] [Sat Jan 16 11:09:18 2010] ***
 242     [debug] "GET" request for "/" from "127.0.0.1"
 243     [debug] Path is "/"
 244     [info] Request took 0.004851s (206.143/s)
 245     .------------------------------------------------------------+-----------.
 246     | Action                                                     | Time      |
 247     +------------------------------------------------------------+-----------+
 248     | /index                                                     | 0.000395s |
 249     | /end                                                       | 0.000425s |
 250     '------------------------------------------------------------+-----------'
 251
 252 B<Note>: Press Ctrl-C to break out of the development server if necessary.
 253
 254
 255 =head1 HELLO WORLD
 256
 257 =head2 The Simplest Way
 258
 259 The Root.pm controller is a place to put global actions that usually
 260 execute on the root URL. Open the C<lib/Hello/Controller/Root.pm> file in
 261 your editor. You will see the "index" subroutine, which is
 262 responsible for displaying the welcome screen that you just saw in
 263 your browser. Later on you'll want to change that to something more
 264 reasonable, such as a "404" message or a redirect, but for now just
 265 leave it alone.
 266
 267     sub index :Path :Args(0) {
 268         my ( $self, $c ) = @_;
 269
 270         # Hello World
 271         $c->response->body( $c->welcome_message );
 272     }
 273
 274 The "C<$c>" here refers to the Catalyst context, which is used to
 275 access the Catalyst application. In addition to many other things,
 276 the Catalyst context provides access to "response" and "request"
 277 objects. (See L<Catalyst|Catalyst>,
 278 L<Catalyst::Response|Catalyst::Response>, and
 279 L<Catalyst::Request|Catalyst::Request>)
 280
 281 C<$c-E<gt>response-E<gt>body> sets the HTTP response (see
 282 L<Catalyst::Response|Catalyst::Response>), while C<$c-E<gt>welcome_message>
 283 is a special method that returns the welcome message that you saw in
 284 your browser.
 285
 286 The ":Path :Args(0)" after the method name are attributes which
 287 determine which URLs will be dispatched to this method. (You might see
 288 ":Private" if you are using an older version of Catalyst, but using
 289 that with 'default' or 'index' is currently deprecated.  If so, you
 290 should also probably upgrade before continuing the tutorial.)
 291
 292 Some MVC frameworks handle dispatching in a central place. Catalyst,
 293 by policy, prefers to handle URL dispatching with attributes on
 294 controller methods. There is a lot of flexibility in specifying which
 295 URLs to match.  This particular method will match all URLs, because it
 296 doesn't specify the path (nothing comes after "Path"), but will only
 297 accept a URL without any args because of the ":Args(0)".
 298
 299 The default is to map URLs to controller names, and because of the way
 300 that Perl handles namespaces through package names, it is simple to
 301 create hierarchical structures in Catalyst. This means that you can
 302 create controllers with deeply nested actions in a clean and logical
 303 way. For example, the URL C<http://hello.com/admin/articles/create>
 304 maps to the package C<Hello::Controller::Admin::Articles>, and the
 305 C<create> method.
 306
 307 Add the following subroutine to your C<lib/Hello/Controller/Root.pm>
 308 file:
 309
 310     sub hello :Global {
 311         my ( $self, $c ) = @_;
 312
 313         $c->response->body("Hello, World!");
 314     }
 315
 316 B<TIP>: See Appendix 1 for tips on removing the leading spaces when
 317 cutting and pasting example code from POD-based documents.
 318
 319 Here you're sending your own string to the webpage.
 320
 321 Save the file, start the server (stop and restart it if it's still
 322 running), and go to L<http://localhost:3000/hello> to
 323 see "Hello, World!"  Also notice that a new action is listed under
 324 "Loaded Private actions" in the development server debug output.
 325
 326
 327 =head2 Hello, World! Using a View and a Template
 328
 329 In the Catalyst world a "View" itself is not a page of XHTML or a
 330 template designed to present a page to a browser. Rather, it is the
 331 module that determines the I<type> of view -- HTML, pdf, XML, etc. For
 332 the thing that generates the I<content> of that view (such as the a
 333 Toolkit Template template file), the actual templates go under the
 334 "root" directory.
 335
 336 To create a TT view, run:
 337
 338     $ script/hello_create.pl view TT TT
 339
 340 This creates the C<lib/Hello/View/TT.pm> module, which is a subclass of
 341 C<Catalyst::View::TT>.
 342
 343 =over 4
 344
 345 =item *
 346
 347 The "view" keyword tells the create script that you are creating a view.
 348
 349 =item *
 350
 351 The first "TT" tells the script to name the View module "TT.pm", which is a
 352 commonly used name for TT views.  (You can name it anything you want, such as
 353 "HTML.pm".)
 354
 355 =item *
 356
 357 The final "TT" tells Catalyst the I<type> of the view, with "TT"
 358 indicating that you want to a Template Toolkit view.
 359
 360 =back
 361
 362 If you look at C<lib/Hello/View/TT.pm> you will find that it only
 363 contains a config statement to set the TT extension to ".tt".
 364
 365 Now that the TT.pm "View" exists, Catalyst will autodiscover it and be
 366 able to use it to display the view templates using the "process"
 367 method that it inherits from the C<Catalyst::View::TT class>.
 368
 369 Template Toolkit is a very full featured template facility, with
 370 excellent documentation at L<http://template-toolkit.org/>,
 371 but since this is not a TT tutorial, we'll stick to only basic TT
 372 usage here (and explore some of the more common TT features in later
 373 chapters of the tutorial).
 374
 375 Create a C<root/hello.tt> template file (put it in the C<root> under
 376 the C<Hello> directory that is the base of your application). Here is
 377 a simple sample:
 378
 379     <p>
 380         This is a TT view template, called '[% template.name %]'.
 381     </p>
 382
 383 [% and %] are markers for the TT parts of the template. Inside you can
 384 access Perl variables and classes, and use TT directives. In this
 385 case, we're using a special TT variable that defines the name of the
 386 template file (C<hello.tt>).  The rest of the template is normal HTML.
 387
 388 Change the hello method in C<lib/Hello/Controller/Root.pm> to the
 389 following:
 390
 391     sub hello :Global {
 392         my ( $self, $c ) = @_;
 393
 394         $c->stash->{template} = 'hello.tt';
 395     }
 396
 397 This time, instead of doing C<$c-E<gt>response-E<gt>body()>, you are
 398 setting the value of the "template" hash key in the Catalyst "stash",
 399 an area for putting information to share with other parts of your
 400 application. The "template" key determines which template will be
 401 displayed at the end of the request cycle. Catalyst controllers have a
 402 default "end" action for all methods which causes the first (or
 403 default) view to be rendered (unless there's a C<$c-E<gt>response-
 404 E<gt>body()> statement). So your template will be magically displayed
 405 at the end of your method.
 406
 407 After saving the file, restart the development server, and look at
 408 L<http://localhost:3000/hello> again. You should
 409 see the template that you just made.
 410
 411
 412 =head1 CREATE A SIMPLE CONTROLLER AND AN ACTION
 413
 414 Create a controller named "Site" by executing the create script:
 415
 416     $ script/hello_create.pl controller Site
 417
 418 This will create a C<lib/Hello/Controller/Site.pm> file (and a test
 419 file). Bring Site.pm up in your editor, and you can see that there's
 420 not much there.
 421
 422 In C<lib/Hello/Controller/Site.pm>, add the following method:
 423
 424     sub test :Local {
 425         my ( $self, $c ) = @_;
 426
 427         $c->stash->{username} = "John";
 428         $c->stash->{template} = 'site/test.tt';
 429     }
 430
 431 Notice the "Local" attribute on the C<test> method. This will cause
 432 the C<test> action (now that we have assigned an "action type" to the
 433 method it appears as a "controller action" to Catalyst) to be executed
 434 on the "controller/method" URL, or, in this case, "site/test".  We
 435 will see additional information on controller actions throughout the
 436 rest of the tutorial, but if you are curious take a look at
 437 L<Catalyst::Manual::Intro/Actions>.
 438
 439 It's not actually necessary to set the template value as we do here.
 440 By default TT will attempt to render a template that follows the
 441 naming pattern "controller/method.tt", and we're following that
 442 pattern here. However, in other situations you will need to specify
 443 the template (such as if you've "forwarded" to the method, or if it
 444 doesn't follow the default naming convention).
 445
 446 We've also put the variable "username" into the stash, for use in the
 447 template.
 448
 449 Make a subdirectory "site" in the "root" directory. Copy the hello.tt
 450 file into the directory as C<root/site/test.tt>, or create a new
 451 template file at that location. Include a line like:
 452
 453     <p>Hello, [% username %]!</p>
 454
 455 Bring up or restart the server.  Notice in the server output that
 456 C</site/test> is listed in the Loaded Path actions. Go to
 457 L<http://localhost:3000/site/test> in your browser.
 458
 459 You should see your test.tt file displayed, including the name "John"
 460 that you set in the controller.
 461
 462
 463 =head1 AUTHORS
 464
 465 Gerda Shank, C<gerda.shank@gmail.com>
 466 Kennedy Clark, C<hkclark@gmail.com>
 467
 468 Please report any errors, issues or suggestions to the author.  The
 469 most recent version of the Catalyst Tutorial can be found at
 470 L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.80/trunk/lib/Catalyst/Manual/Tutorial/>.
 471
 472 Copyright 2006-2008, Kennedy Clark & Gerda Shank, under Creative Commons License
 473 (L<http://creativecommons.org/licenses/by-sa/3.0/us/>).