X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=d1568f13cc4d34eadb71eff550215fd7d0bce0e6;hb=2b01b53cf7f8b98568f13a99e18257f78d7fa858;hp=669f8bf9835568ef78728b11a296c76a9ac9d7a4;hpb=01ba879fae4d3ac2babde66ec6d45b822ba412f8;p=catagits%2FCatalyst-Runtime.git diff --git a/README b/README index 669f8bf..d1568f1 100644 --- a/README +++ b/README @@ -100,6 +100,11 @@ METHODS config Returns a hashref containing your applications settings. + $c->controller($name) + Get a Catalyst::Controller instance by name. + + $c->controller('Foo')->do_stuff; + debug Overload to enable debug messages. @@ -121,6 +126,11 @@ METHODS $c->forward(qw/MyApp::Model::CDBI::Foo do_stuff/); $c->forward('MyApp::View::TT'); + $c->model($name) + Get a Catalyst::Model instance by name. + + $c->model('Foo')->do_stuff; + $c->namespace Accessor to the namespace of the current action @@ -209,6 +219,11 @@ METHODS $c->stash( { moose => 'majestic', qux => 0 } ); $c->stash( bar => 1, gorch => 2 ); + $c->view($name) + Get a Catalyst::View instance by name. + + $c->view('Foo')->do_stuff; + $c->welcome_message Returns the Catalyst welcome HTML page. @@ -222,6 +237,9 @@ INTERNAL METHODS $c->components Contains the components. + $c->context_class($class) + Contains the context class. + $c->counter Returns a hashref containing coderefs and execution counts. (Needed for deep recursion detection) @@ -232,6 +250,16 @@ INTERNAL METHODS $c->dispatch Dispatch request to actions. + $c->dispatcher_class($class) + Contains the dispatcher class. + + dump_these + Returns a list of 2-element array references (name, structure) pairs + that will be dumped on the error page in debug mode. + + $c->engine_class($class) + Contains the engine class. + $c->execute($class, $coderef) Execute a coderef in given class and catch exceptions. Errors are available via $c->error. @@ -260,9 +288,13 @@ INTERNAL METHODS $c->finalize_uploads Finalize uploads. Cleans up any temporary files. - $c->get_action( $action, $namespace, $inherit ) + $c->get_action( $action, $namespace ) Get an action in a given namespace. + $c->get_actions( $action, $namespace ) + Get all actions of a given name in a namespace and all base + namespaces. + handle_request( $class, @arguments ) Handles the request. @@ -312,6 +344,12 @@ INTERNAL METHODS $c->prepare_write Prepare the output for writing. + $c->request_class($class) + Contains the request class. + + $c->response_class($class) + Contains the response class. + $c->read( [$maxlength] ) Read a chunk of data from the request body. This method is designed to be used in a while loop, reading $maxlength bytes on every call. @@ -337,6 +375,9 @@ INTERNAL METHODS $c->setup_home $c->setup_log $c->setup_plugins + $c->stack + Contains the stack. + $c->write( $data ) Writes $data to the output stream. When using this method directly, you will need to manually set the Content-Length header to the @@ -346,6 +387,15 @@ INTERNAL METHODS Returns the Catalyst version number. mostly useful for powered by messages in template systems. +INTERNAL ACTIONS + Catalyst uses internal actions like "_DISPATCH", "_BEGIN", "_AUTO" + "_ACTION" and "_END", these are by default not shown in the private + action table. + + But you can deactivate this with a config parameter. + + MyApp->config->{show_internal_actions} = 1; + CASE SENSITIVITY By default Catalyst is not case sensitive, so "MyApp::C::FOO::Bar" becomes "/foo/bar". @@ -443,6 +493,8 @@ CREDITS Autrijus Tang + Brian Cassidy + Christian Hansen Christopher Hicks @@ -475,6 +527,10 @@ CREDITS Robert Sedlacek + Sam Vilain + + Sascha Kiefer + Tatsuhiko Miyagawa Ulf Edvinsson