=head1 NAME
-Catalyst::Manual::Tutorial - Getting started with Catalyst
+Catalyst::Manual::Tutorial - Catalyst Tutorial: Overview
+
+
=head1 DESCRIPTION
-This document aims to get you up and running with Catalyst.
+The Catalyst framework is a flexible and comprehensive environment for quickly building high-functionality web applications. This tutorial is design to provide a rapid introduction to its basics and most commonly used features while focusing on real-world best practices.
+
+The tutorial is broken down into the following sections:
+
+=over 4
+
+=item *
+
+L<Introduction|Catalyst::Manual::Tutorial01_Intro>
+
+=item *
+
+L<Catalyst Basics|Catalyst::Manual::Tutorial02_CatalystBasics>
+
+=item *
+
+L<CRUD|Catalyst::Manual::Tutorial03_BasicCRUD>
+
+=item *
+
+L<Authentication|Catalyst::Manual::Tutorial04_Authentication>
+
+=item *
+
+L<Authorization|Catalyst::Manual::Tutorial05_Authorization>
+
+=item *
+
+L<Debugging|Catalyst::Manual::Tutorial06_Debugging>
+
+=item *
+
+L<Testing|Catalyst::Manual::Tutorial07_Testing>
+
+=item *
+
+L<CRUD|Catalyst::Manual::Tutorial08_AdvancedCRUD>
+
+=item *
+
+L<Appendicies|Catalyst::Manual::Tutorial09_Appendicies>
+
+=back
+
+
+Full source code is available for each section via the main Catalyst Subversion repository at L<http://dev.catalyst.perl.org/repos/Catalyst/trunk/examples/>. See the end of each section for the specifics on retrieving code for that section.
+
+A tarball of the final application is available at C<to_be_compled_in_final_version>.
+
+
+
+=head1 Detailed Table Of Contents
+
+=head2 Part 1: Introduction
+
+=over 4
+
+=item *
+
+VERSIONS AND CONVENTIONS USED IN THIS TUTORIAL
+
+=item *
+
+CATALYST INSTALLATION
+
+=item *
+
+DATABASES
+
+=item *
+
+WHERE TO GET WORKING CODE
+
+=back
+
+
+
+=head2 Part 2: Catalyst Application Development Basics
+
+=over 4
+
+=item *
+
+CREATE A CATALYST PROJECT
+
+=item *
+
+CREATE A SQLITE DATABASE
+
+=item *
+
+EDIT THE LIST OF CATALYST PLUGINS
+
+=item *
+
+DATABASE ACCESS WITH DBIx::Class
+
+=over 4
+
+=item *
+
+Create a DBIC Schema File
+
+=item *
+
+Create the DBIC ``Result Source'' Files
+
+=item *
+
+Use Catalyst::Model::DBIC::Schema To Load The Model Class
+
+=back
+
+=item *
+
+CREATE A CATALYST CONTROLLER
+
+=item *
+
+CATALYST VIEWS
+
+=over 4
+
+=item *
+
+Create a Catalyst View Using TTSITE
+
+=item *
+
+Globally Customize Every View
+
+=item *
+
+Create a TT Template Page
+
+=back
+
+=item *
+
+RUN THE APPLICATION
+
+=back
+
+
+
+=head2 Part 3: Basic CRUD
+
+=over 4
+
+=item *
+
+FORMLESS SUBMISSION
+
+=over 4
+
+=item *
+
+Include a Create Action in the Books Controller
+
+=item *
+
+Include a Template for the url_create Action:
+
+=item *
+
+Try the url_create Feature
+
+=back
+
+=item *
+
+MANUALLY BUILDING A CREATE FORM
+
+=over 4
+
+=item *
+
+Add Method to Display The Form
+
+=item *
+
+Add a Template for the Form
+
+=item *
+
+Add Method to Process Form Values and Update Database
+
+=item *
+
+Test Out The Form
+
+=back
+
+=item *
+
+A SIMPLE DELETE FEATURE
+
+=over 4
+
+=item *
+
+Include a Delete Link in the List
+
+=item *
+
+Add a Delete Action to the Controller
+
+=item *
+
+Try the Delete Feature
+
+=back
+
+=back
+
+
+
+=head2 Part 4: Authentication
+
+=over 4
+
+=item *
+
+BASIC AUTHENTICATION
+
+=over 4
+
+=item *
+
+Add Users and Roles to the Database
+
+=item *
+
+Add User and Role Information to Dbic Schema
+
+=item *
+
+Create New ``Result Source Objects''
+
+=item *
+
+Sanity-Check Reload of Development Server
+
+=item *
+
+Include Authentication and Session Plugins
+
+=item *
+
+Configure Authentication
+
+=item *
+
+Add Login and Logout Controllers
+
+=item *
+
+Add a Login Form TT Template Page
+
+=item *
+
+Add Valid User Check
+
+=item *
+
+Displaying Content Only to Authenticated Users
+
+=item *
+
+Try Out Authentication
+
+=back
+
+=item *
+
+USING PASSWORD HASHES
+
+=over 4
+
+=item *
+
+Get a SHA-1 Hash for the Password
+
+=item *
+
+Switch to SHA-1 Password Hashes in the Database
+
+=item *
+
+Enable SHA-1 Hash Passwords in Catalyst::Plugin::Authentication::Store::DBIC
+
+=item *
+
+Try Out the Hashed Passwords
+
+=back
+
+=back
+
+
+
+=head2 Part 5: Authorization
+
+=over 4
+
+=item *
+
+BASIC AUTHORIZATION
+
+=over 4
+
+=item *
+
+Update Plugins to Include Support Authorization
+
+=item *
+
+Add Config Information for Authorization
+
+=item *
+
+Add Role-Specific Logic to the ``Book List'' Template
+
+=item *
+
+Limit Books::add to admin Users
+
+=item *
+
+Try Out Authentication And Authorization
+
+=back
+
+=item *
+
+ENABLE ACL-BASED AUTHORIZATION
+
+=over 4
+
+=item *
+
+Add the Catalyst::Plugin::Authorization::ACL Plugin
+
+=item *
+
+Add ACL Rules to the Application Class
+
+=item *
+
+Add a Method to Handle Access Violations
+
+=back
+
+=back
+
+
+=head2 Part 6: Debugging
+
+=over 4
+
+=item *
+
+LOG STATEMENTS
+
+=item *
+
+RUNNING CATALYST UNDER THE PERL DEBUGGER
+
+=back
+
+
+
+=head2 Part 7: Testing
+
+=over 4
+
+=item *
+
+RUNNING THE "CANNED" CATALYST TESTS
+
+=item *
+
+RUNNING A SINGLE TEST
+
+=item *
+
+ADDING YOUR OWN TEST SCRIPT
+
+=item *
+
+SUPPORTING BOTH PRODUCTION AND TEST DATABASES
+
+=back
+
+
+
+=head2 Part 8: Advanced CRUD
+
+=over 4
+
+=item *
+
+HTML::WIDGET FORM CREATION
+
+=over 4
+
+=item *
+
+Add the HTML::Widget Plugin
-NOTE: THIS DOCUMENT IS STILL VERY MUCH AT AN ALPHA STAGE.
-
-Please send comments, corrections and suggestions for improvements to
-A.Ford@ford-mason.co.uk
+=item *
+Add a Form Creation Helper Method
-=head2 Installation
+=item *
-The first step is to install Catalyst, and the simplest way to do this is to
-install the Catalyst bundle from CPAN:
+Add Actions to Display and Save the Form
- $ perl -MCPAN -e 'install Bundle::Catalyst'
+=item *
-This will retrieve Catalyst and a number of useful extensions and install them
-for you.
+Update the CSS
+=item *
-=head2 Setting up your application
+Create a Template Page To Display The Form
-Catalyst includes a helper script, C<catalyst.pl>, that will set up a skeleton
-application for you:
+=item *
- $ catalyst.pl My::App
- created "My-App"
- created "My-App/script"
- created "My-App/lib"
- created "My-App/root"
- created "My-App/t"
- created "My-App/t/m"
- created "My-App/t/v"
- created "My-App/t/c"
- created "My-App/lib/My/App"
- created "My-App/lib/My/App/M"
- created "My-App/lib/My/App/V"
- created "My-App/lib/My/App/C"
- created "My-App/lib/My/App.pm"
- created "My-App/Makefile.PL"
- created "My-App/README"
- created "My-App/Changes"
- created "My-App/t/01app.t"
- created "My-App/t/02podcoverage.t"
- created "My-App/script/cgi.pl"
- created "My-App/script/nph-cgi.pl"
- created "My-App/script/fcgi.pl"
- created "My-App/script/server.pl"
- created "My-App/script/test.pl"
- created "My-App/script/create.pl"
+Add Links for Create and Update via HTML::Widget
-This creates the directory structure shown.
+=item *
+Test The <HTML::Widget> Create Form
+=back
-=head2 Testing out the sample application
+=item *
-You can test out your new application by running the server script that
-catalyst provides:
+HTML::WIDGET VALIDATION AND FILTERING
- $ cd My-App
- $ script/server.pl
- [Sun Mar 20 12:31:18 2005] [catalyst] [debug] Debug messages enabled
- [Sun Mar 20 12:31:18 2005] [catalyst] [debug] Loaded engine "Catalyst::Engine::CGI"
- [Sun Mar 20 12:31:18 2005] [catalyst] [debug] Initialized components ""
- [Sun Mar 20 12:31:18 2005] [catalyst] [info] My::App powered by Catalyst 4.26
- [Sun Mar 20 12:31:18 2005] [catalyst] [debug] "My::App" defined "!default" as "CODE(0x83fd570)"
- You can connect to your server at http://localhost:3000
+=over 4
-The server is now waiting for you to make requests of it. Try using telnet to
-manually make a simple GET request of the server (when telnet responds with
-"Escape character is '^]'.", type "GET / HTTP/1.0" and hit return twice):
+=item *
- $ telnet localhost 3000
- Trying 127.0.0.1...
- Connected to localhost.
- Escape character is '^]'.
- GET / HTTP/1.0
-
- HTTP/1.0 200
- Server: Catalyst/4.26
- Status: 200
- Date: Sun, 20 Mar 2005 12:31:55 GMT
- X-catalyst: 4.26
- Content-length: 40
- Content-Type: text/html; charset=ISO-8859-1
+Add Constraints and Filters to the Widget Creation Method
- Congratulations, My::App is on Catalyst!
- Connection closed by foreign host.
- $
+=item *
-More trace messages will appear in the original terminal window:
+Rebuild the Form Submission Method to Include Validation
- [Sun Mar 20 12:31:55 2005] [catalyst] [debug] ********************************
- [Sun Mar 20 12:31:55 2005] [catalyst] [debug] * Request 1 (0.027/s) [9818]
- [Sun Mar 20 12:31:55 2005] [catalyst] [debug] ********************************
- [Sun Mar 20 12:31:55 2005] [catalyst] [debug] "GET" request for ""
- [Sun Mar 20 12:31:55 2005] [catalyst] [debug] Using default action
- [Sun Mar 20 12:31:55 2005] [catalyst] [info] Processing "!default" took 0.000033s
- [Sun Mar 20 12:31:55 2005] [catalyst] [info] Request took 0.051399s (19.456/s)
+=item *
-The server will continue running until you interrupt it.
+Try Out the Form
-The application can also be tested from the command line using the generated
-helper script, C<script/test.pl>.
+=back
+=item *
-=head2 Getting your application invoked
+Enable DBIx::Class::HTMLWidget Support
-Catalyst applications are intended to be run from mod_perl, but can also be
-run as CGI scripts. Running under mod_perl gives better performance, but for
-development purposes you may want to run your application as a CGI script,
-especially as each changes to your application code take effect under CGI
-without having to restart the web server.
+=over 4
-To run from mod_perl you need to add something like this to your Apache
-configuration file:
+=item *
- <Location /myapp>
- SetHandler perl-script
- PerlHandler MyApp
- </Location>
+Add DBIx::Class::HTMLWidget to DBIC Model
-To run as a CGI script you need a wrapper script like:
+=item *
- #!/usr/bin/perl -w
+Use populate_from_widget in hw_create_do
- use strict;
- use lib '/path/to/MyApp/lib';
- use MyApp;
+=back
- MyApp->run;
+=back
-Catalyst outputs a complete HTTP response, which is not what is expected of a
-CGI script. You need to configure the script as a so-called "Non-parsed
-Headers" script for it to function properly. To do this in Apache just name
-the script starting with C<nph->.
+=head2 Part 9: Appendices
+=over 4
-=head2 Extending the generated code
+=item *
-The generated application code looks like this:
+APPENDIX 1: CUT AND PASTE FOR POD-BASED EXAMPLES
- package My::App;
+=over 4
- use strict;
- use Catalyst qw/-Debug/;
+=item *
- our $VERSION = '0.01';
+"Un-indenting" with Vi/Vim
- My::App->config(
- name => 'My::App',
- root => '/home/andrew/My-App/root',
- );
+=item *
- My::App->action(
- '!default' => sub {
- my ( $self, $c ) = @_;
- $c->res->output('Congratulations, My::App is on Catalyst!');
- },
- );
+"Un-indenting" with Emacs
- 1;
+=back
+=item *
-You can start extending the application by adding new actions:
+APPENDIX 2: USING MYSQL AND POSTGRESQL
- My::App->action(
- 'test1' => sub {
- my ( $self, $c ) = @_;
- $c->res->output('In a new test action #1');
- },
- 'test1' => sub {
- my ( $self, $c ) = @_;
- $c->res->output('In a new test action #1');
- },
- '!default' => sub {
- my ( $self, $c ) = @_;
- $c->res->output('Congratulations, My::App is on Catalyst!');
- },
- );
+=over 4
+=item *
+MySQL
+=item *
-=head1 AUTHOR
+PostgreSQL
-Andrew Ford, C<A.Ford@ford-mason.co.uk>
+=back
-=head1 COPYRIGHT
+=back
-This program is free software, you can redistribute it and/or modify it under
-the same terms as Perl itself.
projects / catagits/Catalyst-Runtime.git / blobdiff