Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Bigtop::Backend::ModelUsernContributedgPer::Backend::Model::GantryDBIxClass(3)

NAME
       [% app_name %]::Model - schema class for	[% app_name +%]

SYNOPSIS
       In your base module:

	   use [% app_name %]::Model;
	   sub schema_base_class { return '[% app_name %]::Model'; }
	   use Gantry::Plugins::DBIxClassConn qw( get_schema );

       [%- FOREACH table_model IN table_models -%]
	   use [% app_name %]::Model::[% table_model %]	qw( $[%	table_model |
       upper %]	);

       [%- END -%]

DESCRIPTION
       This module was generated by Bigtop.  But, feel free to edit it.	 You
       might even want to update these docs.

       get_db_options
	   The generated version sets AutoCommit to 1, this assumes that you
	   will	do all transaction work	via the	DBIx::Class API.

DEPENDENCIES
	   Gantry::Utils::DBIxClass
	   [% app_name %]::GENModel

AUTHOR
       [% FOREACH author IN authors %] [% author.0 %][%	IF author.1 %],	<[%
       author.1	%]>[% END %]

       [% END %]

COPYRIGHT AND LICENSE
       Copyright (C) [%	year %]	[% copyright_holder %]

       [% IF license_text %] [%	ELSE %]	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.  [% END %]

NAME
       [% app_name %]::GENModel	- regenerating schema for [% app_name %]

SYNOPSIS
       In your base schema:

	   use base 'DBIx::Class::Schema';
	   use [% app_name %]::GENModel;

DESCRIPTION
       This module was generated by Bigtop (and	IS subject to regeneration).

DEPENDENCIES
	   Gantry::Utils::DBIxClass

AUTHOR
       [% FOREACH author IN authors %] [% author.0 %][%	IF author.1 %],	<[%
       author.1	%]>[% END %]

       [% END %]

COPYRIGHT AND LICENSE
       Copyright (C) [%	year %]	[% copyright_holder %]

       [% IF license_text %] [%	ELSE %]	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.  [% END %]

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

DESCRIPTION
       This model inherits from	its generated helper, which inherits from [%
       base_class || base_class_default	%].  It	was generated by Bigtop, but
       is NOT subject to regeneration.

METHODS	(mixed in from [% gen_package_name %])
       You may use all normal [% base_class || base_class_default %] methods
       and the ones listed here:

       get_foreign_display_fields
       get_foreign_tables
       foreign_display
       table_name [% FOREACH option_field IN option_fields %]
       [% option_field.name %]_display [% END %]

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

DESCRIPTION
       This model inherits from	[% base_class || base_class_default %].	 It
       was generated by	Bigtop,	and IS subject to regeneration.

METHODS
       You may use all normal [% base_class || base_class_default %] methods
       and the ones listed here:

       get_foreign_display_fields
       get_foreign_tables
       foreign_display
       table_name [% FOREACH extra_method IN extra_methods %]
       [% extra_method +%] [% END %]

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

DESCRIPTION
       This model inherits from	its generated helper, which inherits from
       Gantry::Utils::DBIxClass.  It was generated by Bigtop, but is NOT
       subject to regeneration.

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

DESCRIPTION
       This model inherits from	Gantry::Utils::DBIxClass.  It was generated by
       Bigtop, and IS subject to regeneration.

METHODS
       You may use all normal Gantry::Utils::DBIxClass methods and the ones
       listed here:

       get_foreign_display_fields
       get_foreign_tables
       foreign_display
       table_name [% FOREACH extra_method IN extra_methods %]
       [% extra_method +%] [% END %]

NAME
       Bigtop::Backend::Model::GantryDBIxClass - Bigtop	backend	generating
       DBIx::Class models

SYNOPSIS
       If your bigtop file looks like this:

	   config {
	       base_dir	`/home/user`;
	       ...
	       Model GantryDBIxClass {}
	   }
	   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::DBIxClass	(which inherits	from DBIx::Class).

       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::DBIxClass.

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::DBIxClass.

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: DBIx::Class
	   models and schema.

       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.

perl v5.24.1			  20Bigtop::Backend::Model::GantryDBIxClass(3)

NAME | SYNOPSIS | DESCRIPTION | DEPENDENCIES | AUTHOR | COPYRIGHT AND LICENSE | NAME | SYNOPSIS | DESCRIPTION | DEPENDENCIES | AUTHOR | COPYRIGHT AND LICENSE | NAME | DESCRIPTION | METHODS (mixed in from [% gen_package_name %]) | NAME | DESCRIPTION | METHODS | NAME | DESCRIPTION | NAME | DESCRIPTION | METHODS | NAME | SYNOPSIS | DESCRIPTION | KEYWORDS | METHODS | AUTHOR | COPYRIGHT and LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Bigtop::Backend::Model::GantryDBIxClass&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help