fix example class name in documentation

[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 4410563..652ba3c 100644 (file)
--- a/lib/DBIx/Class/ResultSource/View.pm
+++ b/lib/DBIx/Class/ResultSource/View.pm
@@ -3,12 +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 deploy_depends_on) );
+__PACKAGE__->mk_group_accessors( rsrc_instance_specific_attribute => qw(
+  is_virtual view_definition deploy_depends_on
+));
 
 =head1 NAME
 
@@ -16,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(
@@ -51,6 +50,11 @@ A view has a L</view_definition>, which contains a SQL query. The query can
 only have parameters if L</is_virtual> is set to true. It may contain JOINs,
 sub selects and any other SQL your database supports.
 
+For virtual views the column names returned by the view definition SQL
+must match the names in
+L<add_columns|DBIx::Class::ResultSource/add_columns>, while for
+non-vritual views the order must match.
+
 View definition SQL is deployed to your database on
 L<DBIx::Class::Schema/deploy> unless you set L</is_virtual> to true.
 
@@ -63,34 +67,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
-above, you can then:
+Having created the MyApp::Schema::Result::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
 
@@ -106,7 +110,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
@@ -115,24 +119,24 @@ 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.
 
-=head2 deploy_depends_on 
+=head2 deploy_depends_on
 
-  __PACKAGE__->result_source_instance->deploy_depends_on(
-      ["MyDB::Schema::Result::Year","MyDB::Schema::Result::CD"]
+  __PACKAGE__->result_source->deploy_depends_on(
+      ["MyApp::Schema::Result::Year","MyApp::Schema::Result::CD"]
       );
 
 Specify the views (and only the views) that this view depends on.
@@ -148,9 +152,11 @@ 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
@@ -171,15 +177,17 @@ sub new {
     return $new;
 }
 
-1;
-
-=head1 AUTHORS
+=head1 FURTHER QUESTIONS?
 
-See L<DBIx::Class/CONTRIBUTORS>.
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=head1 LICENSE
+=head1 COPYRIGHT AND 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;