X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource%2FView.pm;h=818295ec2eeb9a0db7dbe7ef647a21822370be04;hb=e5c6382908ee65577e53c0771629384d70959a3d;hp=e14bc7f12bb8227539a9d75f7d54a4921aedc715;hpb=6ebf5cbb4dff9f173f41d5f31f2169f899dee492;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource/View.pm b/lib/DBIx/Class/ResultSource/View.pm index e14bc7f..818295e 100644 --- a/lib/DBIx/Class/ResultSource/View.pm +++ b/lib/DBIx/Class/ResultSource/View.pm @@ -3,13 +3,11 @@ package DBIx::Class::ResultSource::View; use strict; use warnings; -use DBIx::Class::ResultSet; +use base 'DBIx::Class::ResultSource'; -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/ResultSource/); -__PACKAGE__->mk_group_accessors( - 'simple' => qw(is_virtual view_definition depends_on) -); +__PACKAGE__->mk_group_accessors( rsrc_instance_specific_attribute => qw( + is_virtual view_definition deploy_depends_on +)); =head1 NAME @@ -17,15 +15,15 @@ DBIx::Class::ResultSource::View - ResultSource object representing a view =head1 SYNOPSIS - package MyDB::Schema::Result::Year2000CDs; + package MyApp::Schema::Result::Year2000CDs; use base qw/DBIx::Class::Core/; __PACKAGE__->table_class('DBIx::Class::ResultSource::View'); __PACKAGE__->table('year2000cds'); - __PACKAGE__->result_source_instance->is_virtual(1); - __PACKAGE__->result_source_instance->view_definition( + __PACKAGE__->result_source->is_virtual(1); + __PACKAGE__->result_source->view_definition( "SELECT cdid, artist, title FROM cd WHERE year ='2000'" ); __PACKAGE__->add_columns( @@ -64,34 +62,34 @@ case replaces the view name in a FROM clause in a subselect. =head1 EXAMPLES -Having created the MyDB::Schema::Year2000CDs schema as shown in the SYNOPSIS +Having created the MyApp::Schema::Year2000CDs schema as shown in the SYNOPSIS above, you can then: - $2000_cds = $schema->resultset('Year2000CDs') - ->search() - ->all(); - $count = $schema->resultset('Year2000CDs') - ->search() - ->count(); + $y2000_cds = $schema->resultset('Year2000CDs') + ->search() + ->all(); + $count = $schema->resultset('Year2000CDs') + ->search() + ->count(); If you modified the schema to include a placeholder - __PACKAGE__->result_source_instance->view_definition( - "SELECT cdid, artist, title FROM cd WHERE year ='?'" + __PACKAGE__->result_source->view_definition( + "SELECT cdid, artist, title FROM cd WHERE year = ?" ); and ensuring you have is_virtual set to true: - __PACKAGE__->result_source_instance->is_virtual(1); + __PACKAGE__->result_source->is_virtual(1); You could now say: - $2001_cds = $schema->resultset('Year2000CDs') - ->search({}, { bind => [2001] }) - ->all(); - $count = $schema->resultset('Year2000CDs') - ->search({}, { bind => [2001] }) - ->count(); + $y2001_cds = $schema->resultset('Year2000CDs') + ->search({}, { bind => [2001] }) + ->all(); + $count = $schema->resultset('Year2000CDs') + ->search({}, { bind => [2001] }) + ->count(); =head1 SQL EXAMPLES @@ -107,7 +105,7 @@ You could now say: $schema->resultset('Year2000CDs')->all(); - SELECT cdid, artist, title FROM + SELECT cdid, artist, title FROM (SELECT cdid, artist, title FROM cd WHERE year ='2000') me =back @@ -116,34 +114,30 @@ You could now say: =head2 is_virtual - __PACKAGE__->result_source_instance->is_virtual(1); + __PACKAGE__->result_source->is_virtual(1); Set to true for a virtual view, false or unset for a real database-based view. =head2 view_definition - __PACKAGE__->result_source_instance->view_definition( + __PACKAGE__->result_source->view_definition( "SELECT cdid, artist, title FROM cd WHERE year ='2000'" ); An SQL query for your view. Will not be translated across database syntaxes. -=head1 OVERRIDDEN METHODS - -=head2 new +=head2 deploy_depends_on -The constructor. This is a private method, as only other DBIC modules -should call this. See L. + __PACKAGE__->result_source->deploy_depends_on( + ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"] + ); -=cut +Specify the views (and only the views) that this view depends on. +Pass this an array reference of fully qualified result classes. -sub new { - my $new = shift->next::method(@_); - $new->{depends_on} = { %{$new->{depends_on}||{}} }; - return $new; -} +=head1 OVERRIDDEN METHODS =head2 from @@ -153,39 +147,42 @@ or the SQL as a subselect if this is a virtual view. =cut sub from { - my $self = shift; - return \"(${\$self->view_definition})" if $self->is_virtual; - return $self->name; + $_[0]->throw_exception('from() is not a setter method') if @_ > 1; + $_[0]->is_virtual + ? \( '(' . $_[0]->view_definition .')' ) + : $_[0]->name + ; } -=head1 PRIVATE METHODS - -=head2 depends_on +=head1 OTHER METHODS -An internal method for the construction of a hashref of the view's -superclasses, e.g., the sources that comprise it. +=head2 new -See L. +The constructor. =cut -1; - -=head1 AUTHORS - -Matt S. Trout - -With Contributions from: - -Guillermo Roditi Egroditi@cpan.orgE +sub new { + my ( $self, @args ) = @_; + my $new = $self->next::method(@args); + $new->{deploy_depends_on} = + { map { $_ => 1 } + @{ $new->{deploy_depends_on} || [] } } + unless ref $new->{deploy_depends_on} eq 'HASH'; + return $new; +} -Jess Robinson +=head1 FURTHER QUESTIONS? -Wallace Reis +Check the list of L. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -You may distribute this code under the same terms as Perl itself. +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut +1;