X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=d1568f13cc4d34eadb71eff550215fd7d0bce0e6;hb=910410b87a021ff29369bcda4de8ce1013d87f17;hp=8ead33a142518aa1df20639e435ee196f4659533;hpb=fbcc39ad23f2bbecf5d84c9ba581e6af86fcd460;p=catagits%2FCatalyst-Runtime.git diff --git a/README b/README index 8ead33a..d1568f1 100644 --- a/README +++ b/README @@ -52,7 +52,7 @@ DESCRIPTION use Catalyst 'My::Module'; - Special flags like -Debug and -Engine can also be specifed as arguments + Special flags like -Debug and -Engine can also be specified as arguments when Catalyst is loaded: use Catalyst qw/-Debug My::Module/; @@ -88,6 +88,9 @@ DESCRIPTION Specify log level. METHODS + $c->action + Accessor for the current action + $c->comp($name) $c->component($name) Get a component object by name. @@ -97,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. @@ -118,15 +126,32 @@ 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 + + $c->path_to(@path) + Merges @path with $c->config->{home} and returns a Path::Class + object. + + For example: + + $c->path_to( 'db', 'sqlite.db' ); + $c->setup Setup. $c->setup; - $c->uri_for($path) + $c->uri_for($path,[@args]) Merges path with $c->request->base for absolute uri's and with $c->request->match for relative uri's, then returns a normalized URI - object. + object. If any args are passed, they are added at the end of the + path. $c->error $c->error($error, ...) @@ -139,6 +164,10 @@ METHODS $c->error('Something bad happened'); + Clean errors. + + $c->error(0); + $c->engine Contains the engine instance. Stringifies to the class. @@ -178,9 +207,26 @@ METHODS $c->stash Returns a hashref containing all your data. - $c->stash->{foo} ||= 'yada'; print $c->stash->{foo}; + Keys may be set in the stash by assigning to the hash reference, or + by passing either a single hash reference or a list of key/value + pairs as arguments. + + For example: + + $c->stash->{foo} ||= 'yada'; + $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. + INTERNAL METHODS $c->benchmark($coderef) Takes a coderef with arguments and returns elapsed time as float. @@ -191,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) @@ -201,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. @@ -229,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. @@ -245,6 +308,9 @@ INTERNAL METHODS $c->prepare_body Prepare message body. + $c->prepare_body_chunk( $chunk ) + Prepare a chunk of data before sending it to HTTP::Body. + $c->prepare_body_parameters Prepare body parameters. @@ -278,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. @@ -303,11 +375,27 @@ 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 length of your output data, if known. + version + 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". @@ -393,6 +481,10 @@ CREDITS Andy Wardley + Andreas Marienborg + + Andrew Bramble + Andrew Ford Andrew Ruthven @@ -401,6 +493,8 @@ CREDITS Autrijus Tang + Brian Cassidy + Christian Hansen Christopher Hicks @@ -433,14 +527,20 @@ CREDITS Robert Sedlacek + Sam Vilain + + Sascha Kiefer + Tatsuhiko Miyagawa Ulf Edvinsson + Yuval Kogman + AUTHOR Sebastian Riedel, "sri@oook.de" LICENSE - This library is free software . You can redistribute it and/or modify it - under the same terms as perl itself. + This library is free software, you can redistribute it and/or modify it + under the same terms as Perl itself.