lib/Catalyst/Component.pm

   1 package Catalyst::Component;
   2
   3 use strict;
   4 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
   5 use NEXT;
   6
   7 __PACKAGE__->mk_classdata($_) for qw/_config/;
   8
   9 =head1 NAME
  10
  11 Catalyst::Component - Catalyst Component Base Class
  12
  13 =head1 SYNOPSIS
  14
  15     # lib/MyApp/Model/Something.pm
  16     package MyApp::Model::Something;
  17
  18     use base 'Catalyst::Component';
  19
  20     __PACKAGE__->config( foo => 'bar' );
  21
  22     sub test {
  23         my $self = shift;
  24         return $self->{foo};
  25     }
  26
  27     sub forward_to_me {
  28         my ( $self, $c ) = @_;
  29         $c->response->output( $self->{foo} );
  30     }
  31
  32     1;
  33
  34     # Methods can be a request step
  35     $c->forward(qw/MyApp::Model::Something forward_to_me/);
  36
  37     # Or just methods
  38     print $c->comp('MyApp::Model::Something')->test;
  39
  40     print $c->comp('MyApp::Model::Something')->{foo};
  41
  42 =head1 DESCRIPTION
  43
  44 This is the universal base class for Catalyst components
  45 (Model/View/Controller).
  46
  47 It provides you with a generic new() for instantiation through Catalyst's
  48 component loader with config() support and a process() method placeholder.
  49
  50 =head1 METHODS
  51
  52 =head2 new($c)
  53
  54 =cut
  55
  56 sub new {
  57     my ( $self, $c ) = @_;
  58
  59     # Temporary fix, some components does not pass context to constructor
  60     my $arguments = ( ref( $_[-1] ) eq 'HASH' ) ? $_[-1] : {};
  61
  62     return $self->NEXT::new( { %{ $self->config }, %{$arguments} } );
  63 }
  64
  65 # remember to leave blank lines between the consecutive =head2's
  66 # otherwise the pod tools don't recognize the subsequent =head2s
  67
  68 =head2 $c->config
  69
  70 =head2 $c->config($hashref)
  71
  72 =head2 $c->config($key, $value, ...)
  73
  74 =cut
  75
  76 sub config {
  77     my $self = shift;
  78     $self->_config( {} ) unless $self->_config;
  79     if (@_) {
  80         my $config = @_ > 1 ? {@_} : $_[0];
  81         while ( my ( $key, $val ) = each %$config ) {
  82             $self->_config->{$key} = $val;
  83         }
  84     }
  85     return $self->_config;
  86 }
  87
  88 =head2 $c->process()
  89
  90 =cut
  91
  92 sub process {
  93
  94     Catalyst::Exception->throw( message => ( ref $_[0] || $_[0] )
  95           . " did not override Catalyst::Component::process" );
  96 }
  97
  98 =head1 SEE ALSO
  99
 100 L<Catalyst>, L<Catalyst::Model>, L<Catalyst::View>, L<Catalyst::Controller>.
 101
 102 =head1 AUTHOR
 103
 104 Sebastian Riedel, C<sri@cpan.org>
 105 Marcus Ramberg, C<mramberg@cpan.org>
 106 Matt S Trout, C<mst@shadowcatsystems.co.uk>
 107
 108 =head1 COPYRIGHT
 109
 110 This program is free software, you can redistribute it and/or modify it under
 111 the same terms as Perl itself.
 112
 113 =cut
 114
 115 1;