Explicit exception clarifying that $rsrc->from() is not a setter

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / ResultSource / View.pm

diff --git a/lib/DBIx/Class/ResultSource/View.pm b/lib/DBIx/Class/ResultSource/View.pm
index cb20f2c..846bcf6 100644 (file)
--- a/lib/DBIx/Class/ResultSource/View.pm
+++ b/lib/DBIx/Class/ResultSource/View.pm
@@ -16,7 +16,7 @@ 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/;
 
@@ -63,20 +63,20 @@ 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 ='?'"
+      "SELECT cdid, artist, title FROM cd WHERE year = ?"
   );
 
 and ensuring you have is_virtual set to true:
@@ -85,12 +85,12 @@ and ensuring you have is_virtual set to true:
 
 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
 
@@ -106,7 +106,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
@@ -129,14 +129,14 @@ database-based view.
 An SQL query for your view. Will not be translated across database
 syntaxes.
 
-=head2 deploy_depends_on 
+=head2 deploy_depends_on
 
   __PACKAGE__->result_source_instance->deploy_depends_on(
-      "MyDB::Schema::Result::Year","MyDB::Schema::Result::CD"
+      ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"]
       );
 
-Specify the result classes or other views that comprise this view.
-Pass this method an array reference.
+Specify the views (and only the views) that this view depends on.
+Pass this an array reference of fully qualified result classes.
 
 =head1 OVERRIDDEN METHODS
 
@@ -148,39 +148,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 OTHER METHODS
+
+=head2 new
+
+The constructor.
+
+=cut
+
 sub new {
     my ( $self, @args ) = @_;
     my $new = $self->next::method(@args);
-    $new->{deploy_depends_on}
-        = { map { $_->result_source_instance->name => 1 } @{ $new->{deploy_depends_on}||[] } }
-        unless ref $new->{deploy_depends_on} eq 'HASH';
+    $new->{deploy_depends_on} =
+      { map { $_ => 1 }
+          @{ $new->{deploy_depends_on} || [] } }
+      unless ref $new->{deploy_depends_on} eq 'HASH';
     return $new;
 }
 
-1;
-
-=head1 AUTHORS
+=head1 FURTHER QUESTIONS?
 
-Matt S. Trout <mst@shadowcatsystems.co.uk>
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-With Contributions from:
+=head1 COPYRIGHT AND LICENSE
 
-Guillermo Roditi E<lt>groditi@cpan.orgE<gt>
-
-Jess Robinson <castaway@desert-island.me.uk>
-
-Wallace Reis <wreis@cpan.org>
-
-Amiri Barksdale <amiri@metalabel.com>
-
-=head1 LICENSE
-
-You may distribute this code under the same terms as Perl itself.
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
 
 =cut
 
+1;