Catalyst::Utils - The Catalyst Utils
See Catalyst.
Catalyst Utilities.
MyApp::Foo becomes myapp_foo
MyApp::Controller::Foo::Bar becomes MyApp My::App::Controller::Foo::Bar becomes My::App
MyApp::Controller::Foo::Bar becomes MyApp::Controller My::App::Controller::Foo::Bar becomes My::App::Controller
MyApp::Controller::Foo::Bar becomes Controller::Foo::Bar
Returns the environment name for class.
MyApp becomes MYAPP My::App becomes MY_APP
Returns the uri prefix for a class. If case is false the prefix is converted to lowercase.
My::App::Controller::Foo::Bar becomes foo/bar
Returns a tempdir for a class. If create is true it will try to create the path.
My::App becomes /tmp/my/app My::App::Controller::Foo::Bar becomes /tmp/my/app/c/foo/bar
Returns home directory for given class.
Returns a list of files which can be tested to check if you're inside a CPAN distribution which is not yet installed.
These are:
Returns a prefixed action.
MyApp::Controller::Foo::Bar, yada becomes foo/bar/yada
Returns an HTTP::Request object for a uri.
Loads the class unless it already has been loaded.
If $opts{ignore_loaded} is true always tries the require whether the package already exists or not. Only pass this if you're either (a) sure you know the file exists on disk or (b) have code to catch the file not found exception that will result if it doesn't.
Base code to recursively merge two hashes together with right-hand precedence.
Checks for and returns an environment value. For instance, if $key is 'home', then this method will check for and return the first value it finds, looking at $ENV{MYAPP_HOME} and $ENV{CATALYST_HOME}.
Try to guess terminal width to use with formatting of debug output
All you need to get this work, is:
1) Install Term::Size::Any, or
2) Export $COLUMNS from your shell.
(Warning to bash users: 'echo $COLUMNS' may be showing you the bash variable, not $ENV{COLUMNS}. 'export COLUMNS=$COLUMNS' and you should see that 'env' now lists COLUMNS.)
As last resort, default value of 80 chars will be used.
Method which adds the namespace for plugins and actions.
__PACKAGE__->setup(qw(MyPlugin)); # will load Catalyst::Plugin::MyPlugin
Internal application that converts a single middleware definition (see "psgi_middleware" in Catalyst) into an actual instance of middleware.
Given a $psgi reference, wrap all the "registered_middlewares" in Catalyst around it and return the wrapped version.
This exists to deal with the fact Catalyst registered middleware can be either an object with a wrap method or a coderef.
Utility functions to make it easier to work with PSGI applications under Catalyst
Localize $env under the current controller path prefix:
$env
package MyApp::Controller::User; use Catalyst::Utils; use base 'Catalyst::Controller'; sub name :Local { my ($self, $c) = @_; my $env = $c->Catalyst::Utils::env_at_path_prefix; }
Assuming you have a request like GET /user/name:
In the example case $env will have PATH_INFO of '/name' instead of '/user/name' and SCRIPT_NAME will now be '/user'.
Localize $env under the current action namespace.
package MyApp::Controller::User; use Catalyst::Utils; use base 'Catalyst::Controller'; sub name :Local { my ($self, $c) = @_; my $env = $c->Catalyst::Utils::env_at_action; }
In the example case $env will have PATH_INFO of '/' instead of '/user/name' and SCRIPT_NAME will now be '/user/name'.
Alternatively, assuming you have a request like GET /user/name/foo:
In this example case $env will have PATH_INFO of '/foo' instead of '/user/name/foo' and SCRIPT_NAME will now be '/user/name'.
This is probably a common case where you want to mount a PSGI application under an action but let the Args fall through to the PSGI app.
Localize $env under the current request URI:
package MyApp::Controller::User; use Catalyst::Utils; use base 'Catalyst::Controller'; sub name :Local Args(1) { my ($self, $c, $id) = @_; my $env = $c->Catalyst::Utils::env_at_request_uri }
Assuming you have a request like GET /user/name/hello:
In the example case $env will have PATH_INFO of '/' instead of '/user/name' and SCRIPT_NAME will now be '/user/name/hello'.
Catalyst Contributors, see Catalyst.pm
This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.
To install Catalyst::Runtime, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Catalyst::Runtime
CPAN shell
perl -MCPAN -e shell install Catalyst::Runtime
For more information on module installation, please visit the detailed CPAN module installation guide.