lib/Catalyst/Controller.pm

   1 package Catalyst::Controller;
   2
   3 use Moose;
   4 use Class::MOP;
   5 use Class::Load ':all';
   6 use String::RewritePrefix;
   7 use Moose::Util qw/find_meta/;
   8 use List::Util qw/first/;
   9 use List::MoreUtils qw/uniq/;
  10 use namespace::clean -except => 'meta';
  11
  12 BEGIN { extends qw/Catalyst::Component MooseX::MethodAttributes::Inheritable/; }
  13
  14 use MooseX::MethodAttributes;
  15 use Catalyst::Exception;
  16 use Catalyst::Utils;
  17
  18 with 'Catalyst::Component::ApplicationAttribute';
  19
  20 has path_prefix => (
  21     is        => 'rw',
  22     isa       => 'Str',
  23     init_arg  => 'path',
  24     predicate => 'has_path_prefix',
  25 );
  26
  27 has action_namespace => (
  28     is        => 'rw',
  29     isa       => 'Str',
  30     init_arg  => 'namespace',
  31     predicate => 'has_action_namespace',
  32 );
  33
  34 has actions => (
  35     accessor => '_controller_actions',
  36     isa      => 'HashRef',
  37     init_arg => undef,
  38 );
  39
  40 has _action_role_args => (
  41     traits     => [qw(Array)],
  42     isa        => 'ArrayRef[Str]',
  43     init_arg   => 'action_roles',
  44     default    => sub { [] },
  45     handles    => {
  46         _action_role_args => 'elements',
  47     },
  48 );
  49
  50 has _action_roles => (
  51     traits     => [qw(Array)],
  52     isa        => 'ArrayRef[RoleName]',
  53     init_arg   => undef,
  54     lazy       => 1,
  55     builder    => '_build__action_roles',
  56     handles    => {
  57         _action_roles => 'elements',
  58     },
  59 );
  60
  61 has action_args => (is => 'ro');
  62
  63 # ->config(actions => { '*' => ...
  64 has _all_actions_attributes => (
  65     is       => 'ro',
  66     isa      => 'HashRef',
  67     init_arg => undef,
  68     lazy     => 1,
  69     builder  => '_build__all_actions_attributes',
  70 );
  71
  72 sub BUILD {
  73     my ($self, $args) = @_;
  74     my $action  = delete $args->{action}  || {};
  75     my $actions = delete $args->{actions} || {};
  76     my $attr_value = $self->merge_config_hashes($actions, $action);
  77     $self->_controller_actions($attr_value);
  78
  79     # trigger lazy builder
  80     $self->_all_actions_attributes;
  81     $self->_action_roles;
  82 }
  83
  84 sub _build__action_roles {
  85     my $self = shift;
  86     my @roles = $self->_expand_role_shortname($self->_action_role_args);
  87     load_class($_) for @roles;
  88     return \@roles;
  89 }
  90
  91 sub _build__all_actions_attributes {
  92     my ($self) = @_;
  93     delete $self->_controller_actions->{'*'} || {};
  94 }
  95
  96 =head1 NAME
  97
  98 Catalyst::Controller - Catalyst Controller base class
  99
 100 =head1 SYNOPSIS
 101
 102   package MyApp::Controller::Search
 103   use base qw/Catalyst::Controller/;
 104
 105   sub foo : Local {
 106     my ($self,$c,@args) = @_;
 107     ...
 108   } # Dispatches to /search/foo
 109
 110 =head1 DESCRIPTION
 111
 112 Controllers are where the actions in the Catalyst framework
 113 reside. Each action is represented by a function with an attribute to
 114 identify what kind of action it is. See the L<Catalyst::Dispatcher>
 115 for more info about how Catalyst dispatches to actions.
 116
 117 =cut
 118
 119 #I think both of these could be attributes. doesn't really seem like they need
 120 #to ble class data. i think that attributes +default would work just fine
 121 __PACKAGE__->mk_classdata($_) for qw/_dispatch_steps _action_class _action_role_prefix/;
 122
 123 __PACKAGE__->_dispatch_steps( [qw/_BEGIN _AUTO _ACTION/] );
 124 __PACKAGE__->_action_class('Catalyst::Action');
 125 __PACKAGE__->_action_role_prefix([ 'Catalyst::ActionRole::' ]);
 126
 127
 128 sub _DISPATCH : Private {
 129     my ( $self, $c ) = @_;
 130
 131     foreach my $disp ( @{ $self->_dispatch_steps } ) {
 132         last unless $c->forward($disp);
 133     }
 134
 135     $c->forward('_END');
 136 }
 137
 138 sub _BEGIN : Private {
 139     my ( $self, $c ) = @_;
 140     my $begin = ( $c->get_actions( 'begin', $c->namespace ) )[-1];
 141     return 1 unless $begin;
 142     $begin->dispatch( $c );
 143     return !@{ $c->error };
 144 }
 145
 146 sub _AUTO : Private {
 147     my ( $self, $c ) = @_;
 148     my @auto = $c->get_actions( 'auto', $c->namespace );
 149     foreach my $auto (@auto) {
 150         $auto->dispatch( $c );
 151         return 0 unless $c->state;
 152     }
 153     return 1;
 154 }
 155
 156 sub _ACTION : Private {
 157     my ( $self, $c ) = @_;
 158     if (   ref $c->action
 159         && $c->action->can('execute')
 160         && defined $c->req->action )
 161     {
 162         $c->action->dispatch( $c );
 163     }
 164     return !@{ $c->error };
 165 }
 166
 167 sub _END : Private {
 168     my ( $self, $c ) = @_;
 169     my $end = ( $c->get_actions( 'end', $c->namespace ) )[-1];
 170     return 1 unless $end;
 171     $end->dispatch( $c );
 172     return !@{ $c->error };
 173 }
 174
 175 sub action_for {
 176     my ( $self, $name ) = @_;
 177     my $app = ($self->isa('Catalyst') ? $self : $self->_application);
 178     return $app->dispatcher->get_action($name, $self->action_namespace);
 179 }
 180
 181 #my opinion is that this whole sub really should be a builder method, not
 182 #something that happens on every call. Anyone else disagree?? -- groditi
 183 ## -- apparently this is all just waiting for app/ctx split
 184 around action_namespace => sub {
 185     my $orig = shift;
 186     my ( $self, $c ) = @_;
 187
 188     my $class = ref($self) || $self;
 189     my $appclass = ref($c) || $c;
 190     if( ref($self) ){
 191         return $self->$orig if $self->has_action_namespace;
 192     } else {
 193         return $class->config->{namespace} if exists $class->config->{namespace};
 194     }
 195
 196     my $case_s;
 197     if( $c ){
 198         $case_s = $appclass->config->{case_sensitive};
 199     } else {
 200         if ($self->isa('Catalyst')) {
 201             $case_s = $class->config->{case_sensitive};
 202         } else {
 203             if (ref $self) {
 204                 $case_s = ref($self->_application)->config->{case_sensitive};
 205             } else {
 206                 confess("Can't figure out case_sensitive setting");
 207             }
 208         }
 209     }
 210
 211     my $namespace = Catalyst::Utils::class2prefix($self->catalyst_component_name, $case_s) || '';
 212     $self->$orig($namespace) if ref($self);
 213     return $namespace;
 214 };
 215
 216 #Once again, this is probably better written as a builder method
 217 around path_prefix => sub {
 218     my $orig = shift;
 219     my $self = shift;
 220     if( ref($self) ){
 221       return $self->$orig if $self->has_path_prefix;
 222     } else {
 223       return $self->config->{path} if exists $self->config->{path};
 224     }
 225     my $namespace = $self->action_namespace(@_);
 226     $self->$orig($namespace) if ref($self);
 227     return $namespace;
 228 };
 229
 230 sub get_action_methods {
 231     my $self = shift;
 232     my $meta = find_meta($self) || confess("No metaclass setup for $self");
 233     confess(
 234         sprintf "Metaclass %s for %s cannot support register_actions.",
 235             ref $meta, $meta->name,
 236     ) unless $meta->can('get_nearest_methods_with_attributes');
 237     my @methods = $meta->get_nearest_methods_with_attributes;
 238
 239     # actions specified via config are also action_methods
 240     push(
 241         @methods,
 242         map {
 243             $meta->find_method_by_name($_)
 244                 || confess( sprintf 'Action "%s" is not available from controller %s',
 245                             $_, ref $self )
 246         } keys %{ $self->_controller_actions }
 247     ) if ( ref $self );
 248     return uniq @methods;
 249 }
 250
 251
 252 sub register_actions {
 253     my ( $self, $c ) = @_;
 254     $self->register_action_methods( $c, $self->get_action_methods );
 255 }
 256
 257 sub register_action_methods {
 258     my ( $self, $c, @methods ) = @_;
 259     my $class = $self->catalyst_component_name;
 260     #this is still not correct for some reason.
 261     my $namespace = $self->action_namespace($c);
 262
 263     # FIXME - fugly
 264     if (!blessed($self) && $self eq $c && scalar(@methods)) {
 265         my @really_bad_methods = grep { ! /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/ } map { $_->name } @methods;
 266         if (scalar(@really_bad_methods)) {
 267             $c->log->warn("Action methods (" . join(', ', @really_bad_methods) . ") found defined in your application class, $self. This is deprecated, please move them into a Root controller.");
 268         }
 269     }
 270
 271     foreach my $method (@methods) {
 272         my $name = $method->name;
 273         # Horrible hack! All method metaclasses should have an attributes
 274         # method, core Moose bug - see r13354.
 275         my $attributes = $method->can('attributes') ? $method->attributes : [];
 276         my $attrs = $self->_parse_attrs( $c, $name, @{ $attributes } );
 277         if ( $attrs->{Private} && ( keys %$attrs > 1 ) ) {
 278             $c->log->warn( 'Bad action definition "'
 279                   . join( ' ', @{ $attributes } )
 280                   . qq/" for "$class->$name"/ )
 281               if $c->debug;
 282             next;
 283         }
 284         my $reverse = $namespace ? "${namespace}/${name}" : $name;
 285         my $action = $self->create_action(
 286             name       => $name,
 287             code       => $method->body,
 288             reverse    => $reverse,
 289             namespace  => $namespace,
 290             class      => $class,
 291             attributes => $attrs,
 292         );
 293
 294         $c->dispatcher->register( $c, $action );
 295     }
 296 }
 297
 298 sub _apply_action_class_roles {
 299     my ($self, $class, @roles) = @_;
 300
 301     load_class($_) for @roles;
 302     my $meta = Moose::Meta::Class->initialize($class)->create_anon_class(
 303         superclasses => [$class],
 304         roles        => \@roles,
 305         cache        => 1,
 306     );
 307     $meta->add_method(meta => sub { $meta });
 308
 309     return $meta->name;
 310 }
 311
 312 sub action_class {
 313     my $self = shift;
 314     my %args = @_;
 315
 316     my $class = (exists $args{attributes}{ActionClass}
 317         ? $args{attributes}{ActionClass}[0]
 318         : $self->_action_class);
 319
 320     Class::MOP::load_class($class);
 321     return $class;
 322 }
 323
 324 sub create_action {
 325     my $self = shift;
 326     my %args = @_;
 327
 328     my $class = $self->action_class(%args);
 329
 330     load_class($class);
 331     Moose->init_meta(for_class => $class)
 332         unless Class::MOP::does_metaclass_exist($class);
 333
 334     unless ($args{name} =~ /^_(DISPATCH|BEGIN|AUTO|ACTION|END)$/) {
 335        my @roles = $self->gather_action_roles(%args);
 336        push @roles, $self->gather_default_action_roles(%args);
 337
 338        $class = $self->_apply_action_class_roles($class, @roles) if @roles;
 339     }
 340
 341     my $action_args = (
 342         ref($self)
 343             ? $self->action_args
 344             : $self->config->{action_args}
 345     );
 346
 347     my %extra_args = (
 348         %{ $action_args->{'*'}           || {} },
 349         %{ $action_args->{ $args{name} } || {} },
 350     );
 351
 352     return $class->new({ %extra_args, %args });
 353 }
 354
 355 sub gather_action_roles {
 356    my ($self, %args) = @_;
 357    return (
 358       (blessed $self ? $self->_action_roles : ()),
 359       @{ $args{attributes}->{Does} || [] },
 360    );
 361 }
 362
 363 sub gather_default_action_roles {
 364   my ($self, %args) = @_;
 365   my @roles = ();
 366   push @roles, 'Catalyst::ActionRole::HTTPMethods'
 367     if $args{attributes}->{Method};
 368   return @roles;
 369 }
 370
 371 sub _parse_attrs {
 372     my ( $self, $c, $name, @attrs ) = @_;
 373
 374     my %raw_attributes;
 375
 376     foreach my $attr (@attrs) {
 377
 378         # Parse out :Foo(bar) into Foo => bar etc (and arrayify)
 379
 380         if ( my ( $key, $value ) = ( $attr =~ /^(.*?)(?:\(\s*(.+?)\s*\))?$/ ) )
 381         {
 382
 383             if ( defined $value ) {
 384                 ( $value =~ s/^'(.*)'$/$1/ ) || ( $value =~ s/^"(.*)"/$1/ );
 385             }
 386             push( @{ $raw_attributes{$key} }, $value );
 387         }
 388     }
 389
 390     my ($actions_config, $all_actions_config);
 391     if( ref($self) ) {
 392         $actions_config = $self->_controller_actions;
 393         # No, you're not getting actions => { '*' => ... } with actions in MyApp.
 394         $all_actions_config = $self->_all_actions_attributes;
 395     } else {
 396         my $cfg = $self->config;
 397         $actions_config = $self->merge_config_hashes($cfg->{actions}, $cfg->{action});
 398         $all_actions_config = {};
 399     }
 400
 401     %raw_attributes = (
 402         %raw_attributes,
 403         # Note we deep copy array refs here to stop crapping on config
 404         # when attributes are parsed. RT#65463
 405         exists $actions_config->{$name} ? map { ref($_) eq 'ARRAY' ? [ @$_ ] : $_ } %{ $actions_config->{$name } } : (),
 406     );
 407
 408     # Private actions with additional attributes will raise a warning and then
 409     # be ignored. Adding '*' arguments to the default _DISPATCH / etc. methods,
 410     # which are Private, will prevent those from being registered. They should
 411     # probably be turned into :Actions instead, or we might want to otherwise
 412     # disambiguate between those built-in internal actions and user-level
 413     # Private ones.
 414     %raw_attributes = (%{ $all_actions_config }, %raw_attributes)
 415         unless $raw_attributes{Private};
 416
 417     my %final_attributes;
 418
 419     while (my ($key, $value) = each %raw_attributes){
 420         my $new_attrs = $self->_parse_attr($c, $name, $key => $value );
 421         push @{ $final_attributes{$_} }, @{ $new_attrs->{$_} } for keys %$new_attrs;
 422     }
 423
 424     return \%final_attributes;
 425 }
 426
 427 sub _parse_attr {
 428     my ($self, $c, $name, $key, $values) = @_;
 429
 430     my %final_attributes;
 431     foreach my $value (ref($values) eq 'ARRAY' ? @$values : $values) {
 432         my $meth = "_parse_${key}_attr";
 433         if ( my $code = $self->can($meth) ) {
 434             my %new_attrs = $self->$code( $c, $name, $value );
 435             while (my ($new_key, $value) = each %new_attrs){
 436                 my $new_attrs = $key eq $new_key ?
 437                     { $new_key => [$value] } :
 438                     $self->_parse_attr($c, $name, $new_key => $value );
 439                 push @{ $final_attributes{$_} }, @{ $new_attrs->{$_} } for keys %$new_attrs;
 440             }
 441         }
 442         else {
 443             push( @{ $final_attributes{$key} }, $value );
 444         }
 445     }
 446
 447     return \%final_attributes;
 448 }
 449
 450 sub _parse_Global_attr {
 451     my ( $self, $c, $name, $value ) = @_;
 452     # _parse_attr will call _parse_Path_attr for us
 453     return Path => "/$name";
 454 }
 455
 456 sub _parse_Absolute_attr { shift->_parse_Global_attr(@_); }
 457
 458 sub _parse_Local_attr {
 459     my ( $self, $c, $name, $value ) = @_;
 460     # _parse_attr will call _parse_Path_attr for us
 461     $name = join( '/', $self->path_prefix($c), $name);
 462     $name =~ s!^/!!;
 463     return (
 464         'Chained' => '/',
 465         'PathPart' => $name
 466     );
 467 }
 468
 469 sub _parse_Relative_attr { shift->_parse_Local_attr(@_); }
 470
 471 sub _parse_Path_attr {
 472     my ( $self, $c, $name, $value ) = @_;
 473     $value = '' if !defined $value;
 474     if ( $value =~ m!^/! ) {
 475     }
 476     elsif ( length $value ) {
 477         $value = join( '/', $self->path_prefix($c), $value )
 478     }
 479     else {
 480         $value = $self->path_prefix($c)
 481     }
 482     $value =~ s!^/!!;
 483     return (
 484         'Chained'  => '/',
 485         'PathPart' => $value
 486     );
 487 }
 488
 489 sub _parse_Chained_attr {
 490     my ($self, $c, $name, $value) = @_;
 491
 492     if (defined($value) && length($value)) {
 493         if ($value eq '.') {
 494             $value = '/'.$self->action_namespace($c);
 495         } elsif (my ($rel, $rest) = $value =~ /^((?:\.{2}\/)+)(.*)$/) {
 496             my @parts = split '/', $self->action_namespace($c);
 497             my @levels = split '/', $rel;
 498
 499             $value = '/'.join('/', @parts[0 .. $#parts - @levels], $rest);
 500         } elsif ($value !~ m/^\//) {
 501             my $action_ns = $self->action_namespace($c);
 502
 503             if ($action_ns) {
 504                 $value = '/'.join('/', $action_ns, $value);
 505             } else {
 506                 $value = '/'.$value; # special case namespace '' (root)
 507             }
 508         }
 509     } else {
 510         $value = '/'
 511     }
 512
 513     return Chained => $value;
 514 }
 515
 516 sub _parse_ChainedParent_attr {
 517     my ($self, $c, $name, $value) = @_;
 518     return $self->_parse_Chained_attr($c, $name, '../'.$name);
 519 }
 520
 521 sub _parse_PathPrefix_attr {
 522     my ( $self, $c ) = @_;
 523     return PathPart => $self->path_prefix($c);
 524 }
 525
 526 sub _parse_ActionClass_attr {
 527     my ( $self, $c, $name, $value ) = @_;
 528     my $appname = $self->_application;
 529     $value = Catalyst::Utils::resolve_namespace($appname . '::Action', $self->_action_class, $value);
 530     return ( 'ActionClass', $value );
 531 }
 532
 533 sub _parse_MyAction_attr {
 534     my ( $self, $c, $name, $value ) = @_;
 535
 536     my $appclass = Catalyst::Utils::class2appclass($self);
 537     $value = "+${appclass}::Action::${value}";
 538
 539     return ( 'ActionClass', $value );
 540 }
 541
 542 sub _parse_Does_attr {
 543     my ($self, $app, $name, $value) = @_;
 544     return Does => $self->_expand_role_shortname($value);
 545 }
 546
 547 sub _parse_GET_attr    { Method => 'GET'    }
 548 sub _parse_POST_attr   { Method => 'POST'   }
 549 sub _parse_PUT_attr    { Method => 'PUT'    }
 550 sub _parse_DELETE_attr { Method => 'DELETE' }
 551 sub _parse_OPTION_attr { Method => 'OPTION' }
 552 sub _parse_HEAD_attr   { Method => 'HEAD'   }
 553
 554 sub _expand_role_shortname {
 555     my ($self, @shortnames) = @_;
 556     my $app = $self->_application;
 557
 558     my $prefix = $self->can('_action_role_prefix') ? $self->_action_role_prefix : ['Catalyst::ActionRole::'];
 559     my @prefixes = (qq{${app}::ActionRole::}, @$prefix);
 560
 561     return String::RewritePrefix->rewrite(
 562         { ''  => sub {
 563             my $loaded = load_first_existing_class(
 564                 map { "$_$_[0]" } @prefixes
 565             );
 566             return first { $loaded =~ /^$_/ }
 567               sort { length $b <=> length $a } @prefixes;
 568           },
 569           '~' => $prefixes[0],
 570           '+' => '' },
 571         @shortnames,
 572     );
 573 }
 574
 575 __PACKAGE__->meta->make_immutable;
 576
 577 1;
 578
 579 __END__
 580
 581 =head1 CONFIGURATION
 582
 583 Like any other L<Catalyst::Component>, controllers have a config hash,
 584 accessible through $self->config from the controller actions.  Some
 585 settings are in use by the Catalyst framework:
 586
 587 =head2 namespace
 588
 589 This specifies the internal namespace the controller should be bound
 590 to. By default the controller is bound to the URI version of the
 591 controller name. For instance controller 'MyApp::Controller::Foo::Bar'
 592 will be bound to 'foo/bar'. The default Root controller is an example
 593 of setting namespace to '' (the null string).
 594
 595 =head2 path
 596
 597 Sets 'path_prefix', as described below.
 598
 599 =head2 action
 600
 601 Allows you to set the attributes that the dispatcher creates actions out of.
 602 This allows you to do 'rails style routes', or override some of the
 603 attribute definitions of actions composed from Roles.
 604 You can set arguments globally (for all actions of the controller) and
 605 specifically (for a single action).
 606
 607     __PACKAGE__->config(
 608         action => {
 609             '*' => { Chained => 'base', Args => 0  },
 610             base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
 611         },
 612      );
 613
 614 In the case above every sub in the package would be made into a Chain
 615 endpoint with a URI the same as the sub name for each sub, chained
 616 to the sub named C<base>. Ergo dispatch to C</example> would call the
 617 C<base> method, then the C<example> method.
 618
 619 =head2 action_args
 620
 621 Allows you to set constructor arguments on your actions. You can set arguments
 622 globally and specifically (as above).
 623 This is particularly useful when using C<ActionRole>s
 624 (L<Catalyst::Controller::ActionRole>) and custom C<ActionClass>es.
 625
 626     __PACKAGE__->config(
 627         action_args => {
 628             '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
 629             'specific_action' => { customarg => 'arg1' },
 630         },
 631      );
 632
 633 In the case above the action class associated with C<specific_action> would get
 634 passed the following arguments, in addition to the normal action constructor
 635 arguments, when it is instantiated:
 636
 637   (globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')
 638
 639 =head1 METHODS
 640
 641 =head2 BUILDARGS ($app, @args)
 642
 643 From L<Catalyst::Component::ApplicationAttribute>, stashes the application
 644 instance as $self->_application.
 645
 646 =head2 $self->action_for('name')
 647
 648 Returns the Catalyst::Action object (if any) for a given method name
 649 in this component.
 650
 651 =head2 $self->action_namespace($c)
 652
 653 Returns the private namespace for actions in this component. Defaults
 654 to a value from the controller name (for
 655 e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be
 656 overridden from the "namespace" config key.
 657
 658
 659 =head2 $self->path_prefix($c)
 660
 661 Returns the default path prefix for :PathPrefix, :Local and
 662 relative :Path actions in this component. Defaults to the action_namespace or
 663 can be overridden from the "path" config key.
 664
 665 =head2 $self->register_actions($c)
 666
 667 Finds all applicable actions for this component, creates
 668 Catalyst::Action objects (using $self->create_action) for them and
 669 registers them with $c->dispatcher.
 670
 671 =head2 $self->get_action_methods()
 672
 673 Returns a list of L<Moose::Meta::Method> objects, doing the
 674 L<MooseX::MethodAttributes::Role::Meta::Method> role, which are the set of
 675 action methods for this package.
 676
 677 =head2 $self->register_action_methods($c, @methods)
 678
 679 Creates action objects for a set of action methods using C< create_action >,
 680 and registers them with the dispatcher.
 681
 682 =head2 $self->action_class(%args)
 683
 684 Used when a controller is creating an action to determine the correct base
 685 action class to use.
 686
 687 =head2 $self->create_action(%args)
 688
 689 Called with a hash of data to be use for construction of a new
 690 Catalyst::Action (or appropriate sub/alternative class) object.
 691
 692 =head2 $self->gather_action_roles(\%action_args)
 693
 694 Gathers the list of roles to apply to an action with the given %action_args.
 695
 696 =head2 $self->gather_default_action_roles(\%action_args)
 697
 698 returns a list of action roles to be applied based on core, builtin rules.
 699 Currently only the L<Catalyst::ActionRole::HTTPMethods> role is applied
 700 this way.
 701
 702 =head2 $self->_application
 703
 704 =head2 $self->_app
 705
 706 Returns the application instance stored by C<new()>
 707
 708 =head1 ACTION SUBROUTINE ATTRIBUTES
 709
 710 Please see L<Catalyst::Manual::Intro> for more details
 711
 712 Think of action attributes as a sort of way to record metadata about an action,
 713 similar to how annotations work in other languages you might have heard of.
 714 Generally L<Catalyst> uses these to influence how the dispatcher sees your
 715 action and when it will run it in response to an incoming request.  They can
 716 also be used for other things.  Here's a summary, but you should refer to the
 717 liked manual page for additional help.
 718
 719 =head2 Global
 720
 721   sub homepage :Global { ... }
 722
 723 A global action defined in any controller always runs relative to your root.
 724 So the above is the same as:
 725
 726   sub myaction :Path("/homepage") { ... }
 727
 728 =head2 Absolute
 729
 730 Status: Deprecated alias to L</Global>.
 731
 732 =head2 Local
 733
 734 Alias to "Path("$action_name").  The following two actions are the same:
 735
 736   sub myaction :Local { ... }
 737   sub myaction :Path('myaction') { ... }
 738
 739 =head2 Relative
 740
 741 Status: Deprecated alias to L</Local>
 742
 743 =head2 Path
 744
 745 Handle various types of paths:
 746
 747   package MyApp::Controller::Baz {
 748
 749     ...
 750
 751     sub myaction1 :Path { ... }  # -> /baz
 752     sub myaction2 :Path('foo') { ... } # -> /baz/bar
 753     sub myaction2 :Path('/bar') { ... } # -> /bar
 754   }
 755
 756 This is a general toolbox for attaching your action to a give path.
 757
 758
 759 =head2 Regex
 760
 761 =head2 Regexp
 762
 763 B<Status: Deprecated.>  Use Chained methods or other techniques.
 764 If you really depend on this, install the standalone
 765 L<Catalyst::DispatchType::Regex> distribution.
 766
 767 A global way to match a give regular expression in the incoming request path.
 768
 769 =head2 LocalRegex
 770
 771 =head2 LocalRegexp
 772
 773 B<Status: Deprecated.>  Use Chained methods or other techniques.
 774 If you really depend on this, install the standalone
 775 L<Catalyst::DispatchType::Regex> distribution.
 776
 777 Like L</Regex> but scoped under the namespace of the containing controller
 778
 779 =head2 Chained
 780
 781 =head2 ChainedParent
 782
 783 =head2 PathPrefix
 784
 785 =head2 PathPart
 786
 787 =head2 CaptureArgs
 788
 789 Please see L<Catalyst::DispatchType::Chained>
 790
 791 =head2 ActionClass
 792
 793 Set the base class for the action, defaults to L</Catalyst::Action>.  It is now
 794 preferred to use L</Does>.
 795
 796 =head2 MyAction
 797
 798 Set the ActionClass using a custom Action in your project namespace.
 799
 800 The following is exactly the same:
 801
 802     sub foo_action1 : Local ActionClass('+MyApp::Action::Bar') { ... }
 803     sub foo_action2 : Local MyAction('Bar') { ... }
 804
 805 =head2 Does
 806
 807     package MyApp::Controller::Zoo;
 808
 809     sub foo  : Local Does('Moo')  { ... } # Catalyst::ActionRole::
 810     sub bar  : Local Does('~Moo') { ... } # MyApp::ActionRole::Moo
 811     sub baz  : Local Does('+MyApp::ActionRole::Moo') { ... }
 812
 813 =head2 GET
 814
 815 =head2 POST
 816
 817 =head2 PUT
 818
 819 =head2 DELETE
 820
 821 =head2 OPTION
 822
 823 =head2 HEAD
 824
 825 =head2 PATCH
 826
 827 =head2 Method('...')
 828
 829 Sets the give action path to match the specified HTTP method, or via one of the
 830 broadly accepted methods of overriding the 'true' method (see
 831 L<Catalyst::ActionRole::HTTPMethods>).
 832
 833 =head2 Args
 834
 835 When used with L</Path> indicates the number of arguments expected in
 836 the path.  However if no Args value is set, assumed to 'slurp' all
 837 remaining path pars under this namespace.
 838
 839 =head1 OPTIONAL METHODS
 840
 841 =head2 _parse_[$name]_attr
 842
 843 Allows you to customize parsing of subroutine attributes.
 844
 845     sub myaction1 :Path TwoArgs { ... }
 846
 847     sub _parse_TwoArgs_attr {
 848       my ( $self, $c, $name, $value ) = @_;
 849       # $self -> controller instance
 850       #
 851       return(Args => 2);
 852     }
 853
 854 Please note that this feature does not let you actually assign new functions
 855 to actions via subroutine attributes, but is really more for creating useful
 856 aliases to existing core and extended attributes, and transforms based on
 857 existing information (like from configuration).  Code for actually doing
 858 something meaningful with the subroutine attributes will be located in the
 859 L<Catalyst::Action> classes (or your subclasses), L<Catalyst::Dispatcher> and
 860 in subclasses of L<Catalyst::DispatchType>.  Remember these methods only get
 861 called basically once when the application is starting, not per request!
 862
 863 =head1 AUTHORS
 864
 865 Catalyst Contributors, see Catalyst.pm
 866
 867 =head1 COPYRIGHT
 868
 869 This library is free software. You can redistribute it and/or modify
 870 it under the same terms as Perl itself.
 871
 872 =cut