/ 
FabForce-DBDesigner4-DBIC-0.02
River stage zero No dependents
/ FabForce::DBDesigner4::DBIC

NAME

FabForce::DBDesigner4::DBIC - create DBIC scheme for DBDesigner4 xml file

VERSION

Version 0.02

SYNOPSIS

use FabForce::DBDesigner4::DBIC;

my $foo = FabForce::DBDesigner4::DBIC->new();
$foo->output_path( $some_path );
$foo->namespace( 'MyApp::DB' );
$foo->create_scheme( $xml_document );

METHODS

new

creates a new object of FabForce::DBDesigner4::DBIC. You can pass some parameters to new (all parameters are optional)

my $foo = FabForce::DBDesigner4::DBIC->new(
  output_path => '/path/to/dir',
  input_file  => '/path/to/dbdesigner.file',
  namespace   => 'MyApp::Database',
);

output_path

sets / gets the output path for the scheme

$foo->output_path( '/any/directory' );
print $foo->output_path;

input_file

sets / gets the name of the DBDesigner file (XML format)

$foo->input_file( 'dbdesigner.xml' );
print $foo->input_file;

create_scheme

creates all the files that are needed to work with DBIx::Class scheme:

The main module that loads all classes and one class per table. If you haven't specified an input file, the module will croak.

You can specify the input file either with input_file or as an parameter for create_scheme

$foo->input_file( 'dbdesigner.xml' );
$foo->create_scheme;

# or

$foo->create_scheme( 'dbdesigner.xml' );

namespace

sets / gets the name of the namespace. If you set the namespace to 'Test' and you have a table named 'MyTable', the main module is named 'Test::DBIC_Scheme' and the class for 'MyTable' is named 'Test::DBIC_Scheme::MyTable'

$foo->namespace( 'MyApp::DB' );

AUTHOR

Renee Baecker, <module at renee-baecker.de>

BUGS

Please report any bugs or feature requests to bug-fabforce-dbdesigner4-dbic at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FabForce::DBDesigner4::DBIC. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc FabForce::DBDesigner4::DBIC

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2007 Renee Baecker, all rights reserved.

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