Commit | Line | Data |
fc7ec1d9 |
1 | package Catalyst; |
2 | |
3 | use strict; |
ac733264 |
4 | use base 'Catalyst::Base'; |
fc7ec1d9 |
5 | use UNIVERSAL::require; |
6 | use Catalyst::Log; |
7 | |
ac733264 |
8 | __PACKAGE__->mk_classdata($_) for qw/engine log/; |
fc7ec1d9 |
9 | |
87e67021 |
10 | our $VERSION = '5.00'; |
fc7ec1d9 |
11 | our @ISA; |
12 | |
13 | =head1 NAME |
14 | |
15 | Catalyst - The Elegant MVC Web Application Framework |
16 | |
17 | =head1 SYNOPSIS |
18 | |
19 | # use the helper to start a new application |
91864987 |
20 | catalyst.pl MyApp |
fc7ec1d9 |
21 | cd MyApp |
22 | |
23 | # add models, views, controllers |
d01df17d |
24 | script/create.pl model Something |
25 | script/create.pl view Stuff |
26 | script/create.pl controller Yada |
fc7ec1d9 |
27 | |
28 | # built in testserver |
d01df17d |
29 | script/server.pl |
fc7ec1d9 |
30 | |
31 | # command line interface |
d01df17d |
32 | script/test.pl /yada |
fc7ec1d9 |
33 | |
34 | |
fc7ec1d9 |
35 | use Catalyst; |
36 | |
37 | use Catalyst qw/My::Module My::OtherModule/; |
38 | |
39 | use Catalyst '-Debug'; |
40 | |
41 | use Catalyst qw/-Debug -Engine=CGI/; |
42 | |
5a8ed4fe |
43 | sub default : Private { $_[1]->res->output('Hello') } ); |
44 | |
e3dc9d78 |
45 | sub index : Path('/index.html') { |
5a8ed4fe |
46 | my ( $self, $c ) = @_; |
47 | $c->res->output('Hello'); |
48 | $c->forward('_foo'); |
49 | } |
50 | |
51 | sub product : Regex('/^product[_]*(\d*).html$/') { |
52 | my ( $self, $c ) = @_; |
53 | $c->stash->{template} = 'product.tt'; |
54 | $c->stash->{product} = $c->req->snippets->[0]; |
55 | } |
fc7ec1d9 |
56 | |
3803e98f |
57 | See also L<Catalyst::Manual::Intro> |
58 | |
fc7ec1d9 |
59 | =head1 DESCRIPTION |
60 | |
61 | Catalyst is based upon L<Maypole>, which you should consider for smaller |
62 | projects. |
63 | |
64 | The key concept of Catalyst is DRY (Don't Repeat Yourself). |
65 | |
66 | See L<Catalyst::Manual> for more documentation. |
67 | |
23f9d934 |
68 | Catalyst plugins can be loaded by naming them as arguments to the "use Catalyst" statement. |
1985c30b |
69 | Omit the C<Catalyst::Plugin::> prefix from the plugin name, |
23f9d934 |
70 | so C<Catalyst::Plugin::My::Module> becomes C<My::Module>. |
fc7ec1d9 |
71 | |
72 | use Catalyst 'My::Module'; |
73 | |
23f9d934 |
74 | Special flags like -Debug and -Engine can also be specifed as arguments when |
75 | Catalyst is loaded: |
fc7ec1d9 |
76 | |
77 | use Catalyst qw/-Debug My::Module/; |
78 | |
23f9d934 |
79 | The position of plugins and flags in the chain is important, because they are |
80 | loaded in exactly the order that they appear. |
fc7ec1d9 |
81 | |
23f9d934 |
82 | The following flags are supported: |
83 | |
84 | =over 4 |
85 | |
86 | =item -Debug |
87 | |
88 | enables debug output, i.e.: |
fc7ec1d9 |
89 | |
90 | use Catalyst '-Debug'; |
91 | |
23f9d934 |
92 | this is equivalent to: |
fc7ec1d9 |
93 | |
94 | use Catalyst; |
95 | sub debug { 1 } |
96 | |
23f9d934 |
97 | =item -Engine |
fc7ec1d9 |
98 | |
99 | Force Catalyst to use a specific engine. |
23f9d934 |
100 | Omit the C<Catalyst::Engine::> prefix of the engine name, i.e.: |
fc7ec1d9 |
101 | |
102 | use Catalyst '-Engine=CGI'; |
103 | |
23f9d934 |
104 | =back |
fc7ec1d9 |
105 | |
23f9d934 |
106 | =head1 METHODS |
107 | |
108 | =over 4 |
109 | |
110 | =item debug |
fc7ec1d9 |
111 | |
112 | Overload to enable debug messages. |
113 | |
114 | =cut |
115 | |
116 | sub debug { 0 } |
117 | |
23f9d934 |
118 | =item config |
fc7ec1d9 |
119 | |
120 | Returns a hashref containing your applications settings. |
121 | |
122 | =cut |
123 | |
fc7ec1d9 |
124 | sub import { |
125 | my ( $self, @options ) = @_; |
126 | my $caller = caller(0); |
127 | |
22402712 |
128 | unless ( $caller->isa($self) ) { |
fc7ec1d9 |
129 | no strict 'refs'; |
22402712 |
130 | push @{"$caller\::ISA"}, $self; |
1c99e125 |
131 | } |
132 | |
d96e14c2 |
133 | if ( $caller->engine ) { |
ac733264 |
134 | return; # Catalyst is allready initialized |
d96e14c2 |
135 | } |
136 | |
32620e3e |
137 | unless ( $caller->log ) { |
138 | $caller->log( Catalyst::Log->new ); |
fc7ec1d9 |
139 | } |
fc7ec1d9 |
140 | |
1985c30b |
141 | if ( $ENV{CATALYST_DEBUG} || $ENV{ uc($caller) . '_DEBUG' } ) { |
142 | no strict 'refs'; |
143 | *{"$caller\::debug"} = sub { 1 }; |
144 | $caller->log->debug('Debug messages enabled'); |
145 | } |
146 | |
fc7ec1d9 |
147 | # Options |
ac733264 |
148 | my $engine = |
149 | $ENV{MOD_PERL} |
1985c30b |
150 | ? 'Catalyst::Engine::Apache' |
151 | : 'Catalyst::Engine::CGI'; |
152 | |
fc7ec1d9 |
153 | foreach (@options) { |
154 | if (/^\-Debug$/) { |
1985c30b |
155 | next if $caller->debug; |
fc7ec1d9 |
156 | no strict 'refs'; |
1c99e125 |
157 | *{"$caller\::debug"} = sub { 1 }; |
fc7ec1d9 |
158 | $caller->log->debug('Debug messages enabled'); |
159 | } |
160 | elsif (/^-Engine=(.*)$/) { $engine = "Catalyst::Engine::$1" } |
161 | elsif (/^-.*$/) { $caller->log->error(qq/Unknown flag "$_"/) } |
162 | else { |
163 | my $plugin = "Catalyst::Plugin::$_"; |
164 | |
165 | # Plugin caller should be our application class |
166 | eval "package $caller; require $plugin"; |
167 | if ($@) { |
168 | $caller->log->error(qq/Couldn't load plugin "$plugin", "$@"/); |
169 | } |
170 | else { |
171 | $caller->log->debug(qq/Loaded plugin "$plugin"/) |
172 | if $caller->debug; |
502619e5 |
173 | no strict 'refs'; |
174 | push @{"$caller\::ISA"}, $plugin; |
fc7ec1d9 |
175 | } |
176 | } |
177 | } |
178 | |
179 | # Engine |
180 | $engine = "Catalyst::Engine::$ENV{CATALYST_ENGINE}" |
181 | if $ENV{CATALYST_ENGINE}; |
d96e14c2 |
182 | |
fc7ec1d9 |
183 | $engine->require; |
184 | die qq/Couldn't load engine "$engine", "$@"/ if $@; |
502619e5 |
185 | { |
186 | no strict 'refs'; |
970cc51d |
187 | push @{"$caller\::ISA"}, $engine; |
502619e5 |
188 | } |
70cb38f0 |
189 | $caller->engine($engine); |
fc7ec1d9 |
190 | $caller->log->debug(qq/Loaded engine "$engine"/) if $caller->debug; |
191 | } |
192 | |
70cb38f0 |
193 | =item $c->engine |
194 | |
195 | Contains the engine class. |
196 | |
145074c2 |
197 | =item $c->log |
198 | |
199 | Contains the logging object. Unless it is already set Catalyst sets this up with a |
200 | C<Catalyst::Log> object. To use your own log class: |
201 | |
202 | $c->log( MyLogger->new ); |
203 | $c->log->info("now logging with my own logger!"); |
204 | |
205 | Your log class should implement the methods described in the C<Catalyst::Log> |
206 | man page. |
207 | |
208 | |
23f9d934 |
209 | =back |
210 | |
3cb1db8c |
211 | =head1 SUPPORT |
212 | |
213 | IRC: |
214 | |
215 | Join #catalyst on irc.perl.org. |
216 | |
217 | Mailing-Lists: |
218 | |
219 | http://lists.rawmode.org/mailman/listinfo/catalyst |
220 | http://lists.rawmode.org/mailman/listinfo/catalyst-dev |
1985c30b |
221 | |
fc7ec1d9 |
222 | =head1 SEE ALSO |
223 | |
224 | L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>, |
225 | L<Catalyst::Response>, L<Catalyst::Engine> |
226 | |
227 | =head1 AUTHOR |
228 | |
229 | Sebastian Riedel, C<sri@oook.de> |
230 | |
231 | =head1 THANK YOU |
232 | |
bc024080 |
233 | Andrew Ford, Andrew Ruthven, Christian Hansen, Christopher Hicks, |
b0b7c5e0 |
234 | Dan Sully, Danijel Milicevic, David Naughton, Gary Ashton Jones, |
235 | Jesse Sheidlower, Johan Lindstrom, Marcus Ramberg, Tatsuhiko Miyagawa |
236 | and all the others who've helped. |
fc7ec1d9 |
237 | |
238 | =head1 LICENSE |
239 | |
240 | This library is free software . You can redistribute it and/or modify it under |
241 | the same terms as perl itself. |
242 | |
243 | =cut |
244 | |
245 | 1; |