Philip Crow > Bigtop > Bigtop::Backend::Model::GantryCDBI

Download:
Bigtop-0.38.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source  

NAME ^

[% package_name %] - model for [% table_name %] table (stub part)

DESCRIPTION ^

This model inherits from [% base_class || base_class_default %] and uses its generated helper [% gen_package_name %].

It was generated by Bigtop, but is NOT subject to regeneration.

NAME ^

[% gen_package_name %] - model for [% table_name %] table (generated part)

DESCRIPTION ^

This model mixes into [% package_name %], because Class::DBI bindings don't really allow a choice. It was generated by Bigtop, and IS subject to regeneration.

METHODS ^

You may use all normal Class::DBI::Sweet methods and the ones listed here:

get_foreign_display_fields
get_foreign_tables
foreign_display

NAME ^

Bigtop::Backend::Model::GantryCDBI - Bigtop backend generating Class::DBI::Sweet models

SYNOPSIS ^

If your bigtop file looks like this:

    config {
        base_dir `/home/user`;
        ...
        Model GantryCDBI {}
    }
    app Name {...}

and there are tables in the app block, when you type:

    bigtop your.bigtop Model

or bigtop your.bigtop all

this module will make model modules which are subclasses of Gantry::Utils::CDBI (which inherits from Class::DBI::Sweet in a mod_perl safe way).

All modules will live in the lib subdirectory of the app's build directory. See Bigtop::Init::Std for an explanation of how base_dir and the build directory are related.

DESCRIPTION ^

This is a Bigtop backend which generates data model modules which are subclasses of Gantry::Utils::CDBI.

KEYWORDS ^

This module does not register any keywords. See Bigtop::Model for a list of keywords models understand.

The default for the model_base_class keyword is Gantry::Utils::CDBI.

METHODS ^

To keep podcoverage tests happy.

backend_block_keywords

Tells tentmaker that I understand these config section backend block keywords:

    no_gen
    model_base_class
    template
what_do_you_make

Tells tentmaker what this module makes. Summary: Class::DBI models.

gen_Model

Called by Bigtop::Parser to get me to do my thing.

setup_template

Called by Bigtop::Parser so the user can substitute an alternate template for the hard coded one here.

AUTHOR ^

Phil Crow <crow.phil@gmail.com>

COPYRIGHT and LICENSE ^

Copyright (C) 2005 by Phil Crow

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: