Marcus Ramberg > Catalyst-Helper-1.0_01 > Catalyst::Helper

Download:
Catalyst-Helper-1.0_01.tar.gz

Dependencies

Annotate this POD

Module Version: 1.0_01   Source  

NAME ^

Catalyst::Helper - Bootstrap a Catalyst application

SYNOPSIS ^

See Catalyst::Manual::Intro

DESCRIPTION ^

Bootstrap a Catalyst application. Autogenerates scripts

METHODS

get_file

Slurp file from DATA.

mk_app

Create the main application skeleton.

mk_component

This method is called by create.pl to make new components for your application.

mk_dir

Surprisingly, this function makes a directory.

mk_file

writes content to a file.

next_test

render_file

Render and create a file from a template in DATA using Template Toolkit.

HELPERS ^

Helpers are classes that provide two methods.

    * mk_compclass - creates the Component class
    * mk_comptest  - creates the Component test

So when you call bin/create view MyView TT, create would try to execute Catalyst::Helper::View::TT->mk_compclass and Catalyst::Helper::View::TT->mk_comptest.

See Catalyst::Helper::View::TT and Catalyst::Helper::Model::DBIC for examples.

All helper classes should be under one of the following namespaces.

    Catalyst::Helper::Model::
    Catalyst::Helper::View::
    Catalyst::Helper::Controller::

NOTE ^

The helpers will read author name from /etc/passwd by default. To override, please export the AUTHOR variable.

SEE ALSO ^

Catalyst::Manual, Catalyst::Test, Catalyst::Request, Catalyst::Response, Catalyst

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.

NAME ^

[% name %] - Catalyst based application

SYNOPSIS ^

    script/[% appprefix %]_server.pl

DESCRIPTION ^

Catalyst based application.

SEE ALSO ^

"[% rootname %]", Catalyst

AUTHOR ^

[% author %]

LICENSE ^

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

NAME ^

[% rootname %] - Root Controller for this Catalyst based application

SYNOPSIS ^

See "[% name %]".

DESCRIPTION ^

Root Controller for this Catalyst based application.

METHODS ^

default

AUTHOR ^

[% author %]

LICENSE ^

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

NAME ^

[% appprefix %]_cgi.pl - Catalyst CGI

SYNOPSIS ^

See Catalyst::Manual

DESCRIPTION ^

Run a Catalyst application as cgi.

AUTHOR ^

Sebastian Riedel, sri@oook.de

COPYRIGHT ^

Copyright 2004 Sebastian Riedel. All rights reserved.

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

NAME ^

[% appprefix %]_fastcgi.pl - Catalyst FastCGI

SYNOPSIS ^

[% appprefix %]_fastcgi.pl [options]

 Options:
   -? -help      display this help and exits
   -l -listen    Socket path to listen on
                 (defaults to standard input)
                 can be HOST:PORT, :PORT or a
                 filesystem path
   -n -nproc     specify number of processes to keep
                 to serve requests (defaults to 1,
                 requires -listen)
   -p -pidfile   specify filename for pid file
                 (requires -listen)
   -d -daemon    daemonize (requires -listen)
   -M -manager   specify alternate process manager
                 (FCGI::ProcManager sub-class)
                 or empty string to disable

DESCRIPTION ^

Run a Catalyst application as fastcgi.

AUTHOR ^

Sebastian Riedel, sri@oook.de

COPYRIGHT ^

Copyright 2004 Sebastian Riedel. All rights reserved.

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

NAME ^

[% appprefix %]_server.pl - Catalyst Testserver

SYNOPSIS ^

[% appprefix %]_server.pl [options]

 Options:
   -d -debug          force debug mode
   -f -fork           handle each request in a new process
                      (defaults to false)
   -? -help           display this help and exits
      -host           host (defaults to all)
   -p -port           port (defaults to 3000)
   -k -keepalive      enable keep-alive connections
   -r -restart        restart when files got modified
                      (defaults to false)
   -rd -restartdelay  delay between file checks
   -rr -restartregex  regex match files that trigger
                      a restart when modified
                      (defaults to '\.yml$|\.yaml$|\.pm$')

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

DESCRIPTION ^

Run a Catalyst Testserver for this application.

AUTHOR ^

Sebastian Riedel, sri@oook.de

COPYRIGHT ^

Copyright 2004 Sebastian Riedel. All rights reserved.

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

NAME ^

[% appprefix %]_test.pl - Catalyst Test

SYNOPSIS ^

[% appprefix %]_test.pl [options] uri

 Options:
   -help    display this help and exits

 Examples:
   [% appprefix %]_test.pl http://localhost/some_action
   [% appprefix %]_test.pl /some_action

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

DESCRIPTION ^

Run a Catalyst action from the command line.

AUTHOR ^

Sebastian Riedel, sri@oook.de

COPYRIGHT ^

Copyright 2004 Sebastian Riedel. All rights reserved.

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

NAME ^

[% appprefix %]_create.pl - Create a new Catalyst Component

SYNOPSIS ^

[% appprefix %]_create.pl [options] model|view|controller name [helper] [options]

 Options:
   -force        don't create a .new file where a file to be created exists
   -mechanize    use Test::WWW::Mechanize::Catalyst for tests if available
   -help         display this help and exits

 Examples:
   [% appprefix %]_create.pl controller My::Controller
   [% appprefix %]_create.pl -mechanize controller My::Controller
   [% appprefix %]_create.pl view My::View
   [% appprefix %]_create.pl view MyView TT
   [% appprefix %]_create.pl view TT TT
   [% appprefix %]_create.pl model My::Model
   [% appprefix %]_create.pl model SomeDB DBIC::SchemaLoader dbi:SQLite:/tmp/my.db
   [% appprefix %]_create.pl model AnotherDB DBIC::SchemaLoader dbi:Pg:dbname=foo root 4321
   [% appprefix %]_create.pl action Test

 See also:
   perldoc Catalyst::Manual
   perldoc Catalyst::Manual::Intro

DESCRIPTION ^

Create a new Catalyst Component.

Existing component files are not overwritten. If any of the component files to be created already exist the file will be written with a '.new' suffix. This behavior can be suppressed with the -force option.

AUTHOR ^

Sebastian Riedel, sri@oook.de

COPYRIGHT ^

Copyright 2004 Sebastian Riedel. All rights reserved.

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

NAME ^

[% class %] - [% app %] [% name %] [% long_type %]

SYNOPSIS ^

See "[% app %]"

DESCRIPTION ^

[% app %] [% name %] [% long_type %]. [% IF long_type == 'Controller' %] =head1 METHODS

AUTHOR ^

[%author%]

LICENSE ^

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

syntax highlighting: