package Catalyst::Model::DBIC::Schema;
use strict;
-use base qw/Catalyst::Base Class::Accessor::Fast Class::Data::Accessor/;
+use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
use NEXT;
use UNIVERSAL::require;
use Carp;
-our $VERSION = '0.01';
+our $VERSION = '0.07';
-__PACKAGE__->mk_classdata('composed_schema');
+__PACKAGE__->mk_classaccessor('composed_schema');
__PACKAGE__->mk_accessors('schema');
=head1 NAME
# ->schema To access schema methods:
$c->model('Foo')->schema->source(...);
- # Shortcut to the schema resultset monikers for ->search et al:
- $c->model('Foo::Bar')->search(...);
- # is the same as $c->model('Foo')->schema->resultset('Bar')->search(...);
+ # certain ->schema methods (source, resultset, class) have shortcuts
+ $c->model('Foo')->source(...);
+ $c->model('Foo')->resultset(...);
+ $c->model('Foo')->class(...);
+
+ # For resultsets, there's an even quicker shortcut:
+ $c->model('Foo::Bar')
+ # is the same as $c->model('Foo')->resultset('Bar')
# To get the composed schema for making new connections:
my $newconn = $c->model('Foo')->composed_schema->connect(...);
# or, if your schema works on different storage drivers:
my $newconn = $c->model('Foo')->composed_schema->clone();
$newconn->storage_type('::LDAP');
- $newconn->connect(...);
+ $newconn->connection(...);
# and again, a convenience shortcut
my $newconn = $c->model('Foo')->clone();
$newconn->storage_type('::LDAP');
- $newconn->connect(...);
+ $newconn->connection(...);
=head1 DESCRIPTION
-This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
+NOTE: This is the first public release, there's probably a higher than
+average chance of random bugs and shortcomings: you've been warned.
+
+This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
+the documentation for L<Catalyst::Helper::Model::DBIC::Schema> and
+L<Catalyst::Helper::Model::DBIC::SchemaLoader> for information
+on generating these Models via Helper scripts. The latter of the two
+will also generated a L<DBIx::Class::Schema::Loader>-based Schema class
+for you.
=head1 CONFIG PARAMETERS
This is the classname of your L<DBIx::Class::Schema> Schema. It needs
to be findable in C<@INC>, but it does not need to be underneath
-C<Catalyst::Model::>.
+C<Catalyst::Model::>. This parameter is required.
=item connect_info
in L<DBIx::Class> at the time of this writing, the 4 parameters are your
dsn, username, password, and connect options hashref.
+This is not required if C<schema_class> already has connection information
+defined in itself (which would be the case for a Schema defined by
+L<DBIx::Class::Schema::Loader>, for instance).
+
=item storage_type
Allows the use of a different C<storage_type> than what is set in your
=item new
Instantiates the Model based on the above-documented ->config parameters.
+The only required parameter is C<schema_class>. C<connect_info> is
+required in the case that C<schema_class> does not already have connection
+information defined for it.
=item schema
Accessor which returns the connected schema being used by the this model.
+There are already direct shortcuts on the model class itself for
+schema->resultset, schema->source, and schema->class.
=item composed_schema
Accessor which returns the composed schema, which has no connection info,
which was used in constructing the C<schema> above. Useful for creating
-new connections based on the same schema/model.
+new connections based on the same schema/model. There are direct shortcuts
+from the model object for composed_schema->clone and composed_schema->connect
=item clone
Shortcut for ->composed_schema->connect
+=item source
+
+Shortcut for ->schema->source
+
+=item class
+
+Shortcut for ->schema->class
+
+=item resultset
+
+Shortcut for ->schema->resultset
+
=back
=cut
sub new {
- my ( $self, $c ) = @_;
- $self = $self->NEXT::new($c);
+ my $self = shift->NEXT::new(@_);
my $class = ref($self);
my $model_name = $class;
$model_name =~ s/^[\w:]+::(?:Model|M):://;
- foreach (qw/ connect_info schema_class /) {
- croak "->config->{$_} must be defined for this model"
- unless $self->{$_};
- }
+ croak "->config->{schema_class} must be defined for this model"
+ unless $self->{schema_class};
my $schema_class = $self->{schema_class};
$schema_class->require
or croak "Cannot load schema class '$schema_class': $@";
+ if( !$self->{connect_info} ) {
+ if($schema_class->storage && $schema_class->storage->connect_info) {
+ $self->{connect_info} = $schema_class->storage->connect_info;
+ }
+ else {
+ croak "Either ->config->{connect_info} must be defined for $class"
+ . " or $schema_class must have connect info defined on it";
+ }
+ }
+
$self->composed_schema($schema_class->compose_namespace($class));
$self->schema($self->composed_schema->clone);
$self->schema->storage_type($self->{storage_type}) if $self->{storage_type};
- $self->schema->connect(@{$self->{connect_info}});
+ $self->schema->connection(@{$self->{connect_info}});
no strict 'refs';
foreach my $moniker ($self->schema->sources) {
- *{"${class}::${moniker}::ACCEPT_CONTEXT"} = sub {
+ my $classname = "${class}::$moniker";
+ $classname->require;
+ if($@ && $@ !~ /^Can't locate /) {
+ croak "Failed to load external class definition"
+ . "for '$classname': $@";
+ }
+
+ *{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
- shift->model($model_name)->schema->resultset($moniker);
+ shift->model($model_name)->resultset($moniker);
}
}
return $self;
}
-# convenience method
sub clone { shift->composed_schema->clone(@_); }
-# convenience method
sub connect { shift->composed_schema->connect(@_); }
=head1 SEE ALSO
-L<Catalyst>, L<DBIx::Class>, L<DBIx::Class::Schema>,
-L<DBIx::Class::Schema::Loader>
+General Catalyst Stuff:
+
+L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
+L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
+
+Stuff related to DBIC and this Model style:
+
+L<DBIx::Class>, L<DBIx::Class::Schema>,
+L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
+L<Catalyst::Helper::Model::DBIC::SchemaLoader>
=head1 AUTHOR
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff