=head2 Enable debug status in the environment
Normally you enable the debugging info by adding the C<-Debug> flag to
-your C<use Catalyst> statement. However, you can also enable it using
-environment variable, so you can (for example) get debug info without
-modifying your application scripts. Just set C<CATALYST_DEBUG> or
-C<E<lt>MYAPPE<gt>_DEBUG> to a true value.
+your C<use Catalyst> statement (or C<__PACKAGE__->setup(qw/-Debug/)
+). However, you can also enable it using environment variable, so you
+can (for example) get debug info without modifying your application
+scripts. Just set C<CATALYST_DEBUG> or C<E<lt>MYAPPE<gt>_DEBUG> to a
+true value.
=head2 Sessions
=head3 EXAMPLE
- use Catalyst qw/
- Session
- Session::Store::FastMmap
- Session::State::Cookie
- /;
+ use parent qw/Catalyst/;
+ __PACKAGE__->setup( qw/
+ Session
+ Session::Store::FastMmap
+ Session::State::Cookie
+ /;)
## Write data into the session
application class. This can be hard-coded, or brought in from a
separate configuration file.
-=head3 Using YAML
+=head3 Using Config::General
-YAML is a method for creating flexible and readable configuration
-files. It's a great way to keep your Catalyst application
-configuration in one easy-to-understand location.
+L<Config::General|Config::General> is a method for creating flexible
+and readable configuration files. It's a great way to keep your
+Catalyst application configuration in one easy-to-understand location.
-In your application class (e.g. C<lib/MyApp.pm>):
+Now create C<myapp.conf> in your application home:
- use YAML;
- # application setup
- __PACKAGE__->config( YAML::LoadFile(__PACKAGE__->config->{'home'} . '/myapp.yml') );
- __PACKAGE__->setup;
-
-Now create C<myapp.yml> in your application home:
-
- --- #YAML:1.0
- # DO NOT USE TABS FOR INDENTATION OR label/value SEPARATION!!!
- name: MyApp
+ name MyApp
# session; perldoc Catalyst::Plugin::Session::FastMmap
- session:
- expires: '3600'
- rewrite: '0'
- storage: '/tmp/myapp.session'
+ <Session>
+ expires 3600
+ rewrite 0
+ storage /tmp/myapp.session
+ </Session>
# emails; perldoc Catalyst::Plugin::Email
# this passes options as an array :(
- email:
- - SMTP
- - localhost
+ Mail SMTP
+ Mail localhost
This is equivalent to:
# configure email sending
__PACKAGE__->config->{email} = [qw/SMTP localhost/];
-See also L<YAML>.
+See also L<Config::General|Config::General>.
=head1 Skipping your VCS's directories
The L<Catalyst::Plugin::Authorization::Roles> plugin is required when
implementing roles:
- use Catalyst qw/
- Authentication
- Authentication::Credential::Password
- Authentication::Store::Htpasswd
- Authorization::Roles
- /;
+ use parent qw/Catalyst/;
+ __PACKAGE__->setup (qw/
+ Authentication
+ Authentication::Credential::Password
+ Authentication::Store::Htpasswd
+ Authorization::Roles
+ /);
Roles are implemented automatically when using
L<Catalyst::Authentication::Store::Htpasswd>:
=head3 EXAMPLE
- use Catalyst qw/Authentication
- Authentication::Credential::Password
- Authentication::Store::Htpasswd
- Authorization::Roles/;
+ use parent qw/Catalyst/;
+ __PACKAGE__->setup( qw/Authentication
+ Authentication::Credential::Password
+ Authentication::Store::Htpasswd
+ Authorization::Roles/);
__PACKAGE__->config->{authentication}{htpasswd} = "passwdfile";
The Authorization::Roles plugin let's us perform role based access
control checks. Let's load it:
- use Catalyst qw/
+ use parent qw/Catalyst/;
+ __PACKAGE__->setup(qw/
Authentication # yadda yadda
Authorization::Roles
- /;
+ /);
And now our action should look like this:
See L<Catalyst::Model::DBIC::Schema>.
+=head2 Create accessors to preload static data once per server instance
+
+When you have data that you want to load just once from the model at
+server load instead of for each request, use mk_group_accessors to
+create accessors and tie them to resultsets in your package that
+inherits from DBIx::Class::Schema
+
+ package My::Schema;
+ use base qw/DBIx::Class::Schema/;
+ __PACKAGE__->register_class('RESULTSOURCEMONIKER',
+ 'My::Schema::RESULTSOURCE');
+ __PACKAGE__->mk_group_accessors('simple' =>
+ qw(ACCESSORNAME1 ACCESSORNAME2 ACCESSORNAMEn));
+
+ sub connection {
+ my ($self, @rest) = @_;
+ $self->next::method(@rest);
+ # $self is now a live My::Schema object, complete with DB connection
+
+ $self->ACCESSORNAME1([ $self->resultset('RESULTSOURCEMONIKER')->all ]);
+ $self->ACCESSORNAME2([ $self->resultset('RESULTSOURCEMONIKER')->search({ COLUMN => { '<' => '30' } })->all ]);
+ $self->ACCESSORNAMEn([ $self->resultset('RESULTSOURCEMONIKER')->find(1) ]);
+ }
+
+ 1;
+
+and now in the controller, you can now access any of these without a
+per-request fetch:
+
+ $c->stash->{something} = $c->model('My::Schema')->schema->ACCESSORNAMEn;
+
+
=head2 XMLRPC
Unlike SOAP, XMLRPC is a very simple (and imo elegant) web-services
3. Add the XMLRPC plugin to MyApp.pm
- use Catalyst qw/-Debug Static::Simple XMLRPC/;
+ __PACKAGE__->setup( qw/-Debug Static::Simple XMLRPC/);
4. Add an API controller
5. Add a XMLRPC redispatch method and an add method with Remote
attribute to lib/MyApp/Controller/API.pm
- sub default : Private {
+ sub default :Path {
my ( $self, $c ) = @_;
$c->xmlrpc;
}
to find out where it was the user was trying to go, you can look in
the request object using C<< $c->req->path >>.
- sub default : Private { .. }
+ sub default :Path { .. }
works for all unknown URLs, in this controller namespace, or every one
if put directly into MyApp.pm.
actions are defined, then index will be used instead of default and
Path.
- sub index : Private { .. }
+ sub index :Path :Args(0) { .. }
becomes
Using the plugin is as simple as setting your use line in MyApp.pm to include:
- use Catalyst qw/Static::Simple/;
+ __PACKAGE__->setup( qw/Static::Simple/);
and already files will be served.
In your main application class (MyApp.pm), load the plugin:
- use Catalyst qw/-Debug FormValidator Static OtherPlugin/;
+ __PACKAGE__->setup( qw/-Debug FormValidator Static OtherPlugin/);
You will also need to make sure your end method does I<not> forward
static content to the view, perhaps like this:
Cache::FastMmap, Cache::FileCache, and Cache::Memcached. These can be
used to cache the result of slow operations.
-This very page you're viewing makes use of the FileCache plugin to cache the
+The Catalyst Advent Calendar uses the FileCache plugin to cache the
rendered XHTML version of the source POD document. This is an ideal
-application for a cache because the source document changes infrequently but
-may be viewed many times.
+application for a cache because the source document changes
+infrequently but may be viewed many times.
- use Catalyst qw/Cache::FileCache/;
+ __PACKAGE__->setup( qw/Cache::FileCache/);
...
We can add the PageCache plugin to speed things up.
- use Catalyst qw/Cache::FileCache PageCache/;
+ __PACKAGE__->setup( qw/Cache::FileCache PageCache/);
sub front_page : Path ('/') {
my ( $self, $c ) = @_;
projects / catagits/Catalyst-Manual.git / blobdiff