/ 
Catalyst-Runtime-5.90131
River stage three • 605 direct dependents • 679 total dependents
/ Catalyst::Controller

NAME

Catalyst::Controller - Catalyst Controller base class

SYNOPSIS

package MyApp::Controller::Search
use base qw/Catalyst::Controller/;

sub foo : Local {
  my ($self,$c,@args) = @_;
  ...
} # Dispatches to /search/foo

DESCRIPTION

Controllers are where the actions in the Catalyst framework reside. Each action is represented by a function with an attribute to identify what kind of action it is. See the Catalyst::Dispatcher for more info about how Catalyst dispatches to actions.

CONFIGURATION

Like any other Catalyst::Component, controllers have a config hash, accessible through $self->config from the controller actions. Some settings are in use by the Catalyst framework:

namespace

This specifies the internal namespace the controller should be bound to. By default the controller is bound to the URI version of the controller name. For instance controller 'MyApp::Controller::Foo::Bar' will be bound to 'foo/bar'. The default Root controller is an example of setting namespace to '' (the null string).

path

Sets 'path_prefix', as described below.

action

Allows you to set the attributes that the dispatcher creates actions out of. This allows you to do 'rails style routes', or override some of the attribute definitions of actions composed from Roles. You can set arguments globally (for all actions of the controller) and specifically (for a single action).

__PACKAGE__->config(
    action => {
        '*' => { Chained => 'base', Args => 0  },
        base => { Chained => '/', PathPart => '', CaptureArgs => 0 },
    },
 );

In the case above every sub in the package would be made into a Chain endpoint with a URI the same as the sub name for each sub, chained to the sub named base. Ergo dispatch to /example would call the base method, then the example method.

action_args

Allows you to set constructor arguments on your actions. You can set arguments globally and specifically (as above). This is particularly useful when using ActionRoles (Catalyst::Controller::ActionRole) and custom ActionClasses.

__PACKAGE__->config(
    action_args => {
        '*' => { globalarg1 => 'hello', globalarg2 => 'goodbye' },
        'specific_action' => { customarg => 'arg1' },
    },
 );

In the case above the action class associated with specific_action would get passed the following arguments, in addition to the normal action constructor arguments, when it is instantiated:

(globalarg1 => 'hello', globalarg2 => 'goodbye', customarg => 'arg1')

METHODS

BUILDARGS ($app, @args)

From Catalyst::Component::ApplicationAttribute, stashes the application instance as $self->_application.

$self->action_for($action_name)

Returns the Catalyst::Action object (if any) for a given action in this controller or relative to it. You may refer to actions in controllers nested under the current controllers namespace, or in controllers 'up' from the current controller namespace. For example:

package MyApp::Controller::One::Two;
use base 'Catalyst::Controller';

sub foo :Local {
  my ($self, $c) = @_;
  $self->action_for('foo'); # action 'foo' in Controller 'One::Two'
  $self->action_for('three/bar'); # action 'bar' in Controller 'One::Two::Three'
  $self->action_for('../boo'); # action 'boo' in Controller 'One'
}

This returns 'undef' if there is no action matching the requested action name (after any path normalization) so you should check for this as needed.

$self->action_namespace($c)

Returns the private namespace for actions in this component. Defaults to a value from the controller name (for e.g. MyApp::Controller::Foo::Bar becomes "foo/bar") or can be overridden from the "namespace" config key.

$self->path_prefix($c)

Returns the default path prefix for :PathPrefix, :Local and relative :Path actions in this component. Defaults to the action_namespace or can be overridden from the "path" config key.

$self->register_actions($c)

Finds all applicable actions for this component, creates Catalyst::Action objects (using $self->create_action) for them and registers them with $c->dispatcher.

$self->get_action_methods()

Returns a list of Moose::Meta::Method objects, doing the MooseX::MethodAttributes::Role::Meta::Method role, which are the set of action methods for this package.

$self->register_action_methods($c, @methods)

Creates action objects for a set of action methods using create_action , and registers them with the dispatcher.

$self->action_class(%args)

Used when a controller is creating an action to determine the correct base action class to use.

$self->create_action(%args)

Called with a hash of data to be use for construction of a new Catalyst::Action (or appropriate sub/alternative class) object.

$self->gather_action_roles(\%action_args)

Gathers the list of roles to apply to an action with the given %action_args.

$self->gather_default_action_roles(\%action_args)

returns a list of action roles to be applied based on core, builtin rules. Currently only the Catalyst::ActionRole::HTTPMethods role is applied this way.

$self->_application

$self->_app

Returns the application instance stored by new()

ACTION SUBROUTINE ATTRIBUTES

Please see Catalyst::Manual::Intro for more details

Think of action attributes as a sort of way to record metadata about an action, similar to how annotations work in other languages you might have heard of. Generally Catalyst uses these to influence how the dispatcher sees your action and when it will run it in response to an incoming request. They can also be used for other things. Here's a summary, but you should refer to the linked manual page for additional help.

Global

sub homepage :Global { ... }

A global action defined in any controller always runs relative to your root. So the above is the same as:

sub myaction :Path("/homepage") { ... }

Absolute

Status: Deprecated alias to "Global".

Local

Alias to "Path("$action_name"). The following two actions are the same:

sub myaction :Local { ... }
sub myaction :Path('myaction') { ... }

Relative

Status: Deprecated alias to "Local"

Path

Handle various types of paths:

package MyApp::Controller::Baz {

  ...

  sub myaction1 :Path { ... }  # -> /baz
  sub myaction2 :Path('foo') { ... } # -> /baz/foo
  sub myaction2 :Path('/bar') { ... } # -> /bar
}

This is a general toolbox for attaching your action to a given path.

Regex

Regexp

Status: Deprecated. Use Chained methods or other techniques. If you really depend on this, install the standalone Catalyst::DispatchType::Regex distribution.

A global way to match a give regular expression in the incoming request path.

LocalRegex

LocalRegexp

Status: Deprecated. Use Chained methods or other techniques. If you really depend on this, install the standalone Catalyst::DispatchType::Regex distribution.

Like "Regex" but scoped under the namespace of the containing controller

Chained

ChainedParent

PathPrefix

PathPart

CaptureArgs

Allowed values for CaptureArgs is a single integer (CaptureArgs(2), meaning two allowed) or you can declare a Moose, MooseX::Types or Type::Tiny named constraint such as CaptureArgs(Int,Str) would require two args with the first being a Integer and the second a string. You may declare your own custom type constraints and import them into the controller namespace:

package MyApp::Controller::Root;

use Moose;
use MooseX::MethodAttributes;
use MyApp::Types qw/Int/;

extends 'Catalyst::Controller';

sub chain_base :Chained(/) CaptureArgs(1) { }

  sub any_priority_chain :Chained(chain_base) PathPart('') Args(1) { }

  sub int_priority_chain :Chained(chain_base) PathPart('') Args(Int) { }

See Catalyst::RouteMatching for more.

Please see Catalyst::DispatchType::Chained for more.

ActionClass

Set the base class for the action, defaults to "Catalyst::Action". It is now preferred to use "Does".

MyAction

Set the ActionClass using a custom Action in your project namespace.

The following is exactly the same:

sub foo_action1 : Local ActionClass('+MyApp::Action::Bar') { ... }
sub foo_action2 : Local MyAction('Bar') { ... }

Does

package MyApp::Controller::Zoo;

sub foo  : Local Does('Buzz')  { ... } # Catalyst::ActionRole::
sub bar  : Local Does('~Buzz') { ... } # MyApp::ActionRole::Buzz
sub baz  : Local Does('+MyApp::ActionRole::Buzz') { ... }

GET

POST

PUT

DELETE

OPTION

PATCH

Method('...')

Sets the give action path to match the specified HTTP method, or via one of the broadly accepted methods of overriding the 'true' method (see Catalyst::ActionRole::HTTPMethods).

Args

When used with "Path" indicates the number of arguments expected in the path. However if no Args value is set, assumed to 'slurp' all remaining path pars under this namespace.

Allowed values for Args is a single integer (Args(2), meaning two allowed) or you can declare a Moose, MooseX::Types or Type::Tiny named constraint such as Args(Int,Str) would require two args with the first being a Integer and the second a string. You may declare your own custom type constraints and import them into the controller namespace:

package MyApp::Controller::Root;

use Moose;
use MooseX::MethodAttributes;
use MyApp::Types qw/Tuple Int Str StrMatch UserId/;

extends 'Catalyst::Controller';

sub user :Local Args(UserId) {
  my ($self, $c, $int) = @_;
}

sub an_int :Local Args(Int) {
  my ($self, $c, $int) = @_;
}

sub many_ints :Local Args(ArrayRef[Int]) {
  my ($self, $c, @ints) = @_;
}

sub match :Local Args(StrMatch[qr{\d\d-\d\d-\d\d}]) {
  my ($self, $c, $int) = @_;
}

If you choose not to use imported type constraints (like Type::Tiny, or <MooseX::Types> you may use Moose 'stringy' types however just like when you use these types in your declared attributes you must quote them:

sub my_moose_type :Local Args('Int') { ... }

If you use 'reference' type constraints (such as ArrayRef[Int]) that have an unknown number of allowed matches, we set this the same way "Args" is. Please keep in mind that actions with an undetermined number of args match at lower precedence than those with a fixed number. You may use reference types such as Tuple from Types::Standard that allows you to fix the number of allowed args. For example Args(Tuple[Int,Int]) would be determined to be two args (or really the same as Args(Int,Int).) You may find this useful for creating custom subtypes with complex matching rules that you wish to reuse over many actions.

See Catalyst::RouteMatching for more.

Note: It is highly recommended to use Type::Tiny for your type constraints over other options. Type::Tiny exposed a better meta data interface which allows us to do more and better types of introspection driving tests and debugging.

Consumes('...')

Matches the current action against the content-type of the request. Typically this is used when the request is a POST or PUT and you want to restrict the submitted content type. For example, you might have an HTML for that either returns classic url encoded form data, or JSON when Javascript is enabled. In this case you may wish to match either incoming type to one of two different actions, for properly processing.

Examples:

sub is_json       : Chained('start') Consumes('application/json') { ... }
sub is_urlencoded : Chained('start') Consumes('application/x-www-form-urlencoded') { ... }
sub is_multipart  : Chained('start') Consumes('multipart/form-data') { ... }

To reduce boilerplate, we include the following content type shortcuts:

Examples

sub is_json       : Chained('start') Consume(JSON) { ... }
sub is_urlencoded : Chained('start') Consumes(UrlEncoded) { ... }
sub is_multipart  : Chained('start') Consumes(Multipart) { ... }

You may specify more than one match:

sub is_more_than_one
  : Chained('start')
  : Consumes('application/x-www-form-urlencoded')
  : Consumes('multipart/form-data')

sub is_more_than_one
  : Chained('start')
  : Consumes(UrlEncoded)
  : Consumes(Multipart)

Since it is a common case the shortcut HTMLForm matches both 'application/x-www-form-urlencoded' and 'multipart/form-data'. Here's the full list of available shortcuts:

JSON => 'application/json',
JS => 'application/javascript',
PERL => 'application/perl',
HTML => 'text/html',
XML => 'text/XML',
Plain => 'text/plain',
UrlEncoded => 'application/x-www-form-urlencoded',
Multipart => 'multipart/form-data',
HTMLForm => ['application/x-www-form-urlencoded','multipart/form-data'],

Please keep in mind that when dispatching, Catalyst will match the first most relevant case, so if you use the Consumes attribute, you should place your most accurate matches early in the Chain, and your 'catchall' actions last.

See Catalyst::ActionRole::ConsumesContent for more.

Scheme(...)

Allows you to specify a URI scheme for the action or action chain. For example you can required that a given path be https or that it is a websocket endpoint ws or wss. For an action chain you may currently only have one defined Scheme.

package MyApp::Controller::Root;

use base 'Catalyst::Controller';

sub is_http :Path(scheme) Scheme(http) Args(0) {
  my ($self, $c) = @_;
  $c->response->body("is_http");
}

sub is_https :Path(scheme) Scheme(https) Args(0)  {
  my ($self, $c) = @_;
  $c->response->body("is_https");
}

In the above example http://localhost/root/scheme would match the first action (is_http) but https://localhost/root/scheme would match the second.

As an added benefit, if an action or action chain defines a Scheme, when using $c->uri_for the scheme of the generated URL will use what you define in the action or action chain (the current behavior is to set the scheme based on the current incoming request). This makes it easier to use uri_for on websites where some paths are secure and others are not. You may also use this to other schemes like websockets.

See Catalyst::ActionRole::Scheme for more.

OPTIONAL METHODS

_parse_[$name]_attr

Allows you to customize parsing of subroutine attributes.

sub myaction1 :Path TwoArgs { ... }

sub _parse_TwoArgs_attr {
  my ( $self, $c, $name, $value ) = @_;
  # $self -> controller instance
  #
  return(Args => 2);
}

Please note that this feature does not let you actually assign new functions to actions via subroutine attributes, but is really more for creating useful aliases to existing core and extended attributes, and transforms based on existing information (like from configuration). Code for actually doing something meaningful with the subroutine attributes will be located in the Catalyst::Action classes (or your subclasses), Catalyst::Dispatcher and in subclasses of Catalyst::DispatchType. Remember these methods only get called basically once when the application is starting, not per request!

AUTHORS

Catalyst Contributors, see Catalyst.pm

COPYRIGHT

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.