Added possibility to tweak resultset class after searching

[catagits/Catalyst-Controller-DBIC-API.git] / lib / Catalyst / Controller / DBIC / API.pm

diff --git a/lib/Catalyst/Controller/DBIC/API.pm b/lib/Catalyst/Controller/DBIC/API.pm
index 0331ad9..2753a74 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API.pm
+++ b/lib/Catalyst/Controller/DBIC/API.pm
@@ -30,6 +30,7 @@ __PACKAGE__->config();
   __PACKAGE__->config
     ( action => { setup => { PathPart => 'artist', Chained => '/api/rpc/rpc_base' } }, # define parent chain action and partpath
       class            => 'MyAppDB::Artist',
+      result_class     => 'MyAppDB::ResultSet::Artist',
       create_requires  => ['name', 'age'],
       create_allows    => ['nickname'],
       update_allows    => ['name', 'age', 'nickname'],
@@ -180,7 +181,9 @@ generate_rs is used by inflate_request to generate the resultset stored in the c
 
 sub generate_rs
 {
-    my ($self, $c) = @_;
+    #my ($self, $c) = @_;
+    my ($self) = @_;
+
     return $self->stored_result_source->resultset;
 }
 
@@ -329,7 +332,7 @@ sub object_lookup
 
 list's steps are broken up into three distinct methods: L</list_munge_parameters>, L</list_perform_search>, and L</list_format_output>.
 
-The goal of this method is to call ->search() on the current_result_set, HashRefInflator the result, and return it in $c->stash->{response}->{$self->data_root}. Please see the individual methods for more details on what actual processing takes place.
+The goal of this method is to call ->search() on the current_result_set, change resultset class of the result (if needed), and return it in $c->stash->{response}->{$self->data_root}. Please see the individual methods for more details on what actual processing takes place.
 
 If the L</select> config param is defined then the hashes will contain only those columns, otherwise all columns in the object will be returned. L</select> of course supports the function/procedure calling semantics that L<DBIx::Class::ResultSet/select>. In order to have proper column names in the result, provide arguments in L</as> (which also follows L<DBIx::Class::ResultSet/as> semantics. Similarly L</count>, L</page>, L</grouped_by> and L</ordered_by> affect the maximum number of rows returned as well as the ordering and grouping. Note that if select, count, ordered_by or grouped_by request parameters are present then these will override the values set on the class with select becoming bound by the select_exposes attribute.
 
@@ -424,7 +427,7 @@ sub list_format_output
     my ($self, $c) = @_;
 
     my $rs = $c->req->current_result_set->search;
-    $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
+    $rs->result_class($self->result_class) if $self->result_class;
 
     try
     {
@@ -461,7 +464,8 @@ row_format_output is called each row of the inflated output generated from the s
 
 sub row_format_output
 {
-    my ($self, $c, $row) = @_;
+    #my ($self, $c, $row) = @_;
+    my ($self, undef, $row) = @_;
     return $row; # passthrough by default
 }
 
@@ -791,7 +795,8 @@ insert_object_from_params sets the columns for the object, then calls ->insert
 
 sub insert_object_from_params
 {
-    my ($self, $c, $object, $params) = @_;
+    #my ($self, $c, $object, $params) = @_;
+    my ($self, undef, $object, $params) = @_;
 
     my %rels;
     while (my ($k, $v) = each %{ $params }) {
@@ -831,7 +836,8 @@ Performs the actual ->delete on the object
 
 sub delete_object
 {
-    my ($self, $c, $object) = @_;
+    #my ($self, $c, $object) = @_;
+    my ($self, undef, $object) = @_;
 
     $object->delete;
 }
@@ -887,7 +893,8 @@ This only executes if L</return_object> if set and if there are any objects to a
 
 sub each_object_inflate
 {
-    my ($self, $c, $object) = @_;
+    #my ($self, $c, $object) = @_;
+    my ($self, undef, $object) = @_;
 
     return { $object->get_columns };
 }
@@ -910,7 +917,14 @@ push_error stores an error message into the stash to be later retrieved by L</en
 sub push_error
 {
     my ( $self, $c, $params ) = @_;
-    push( @{$c->stash->{_dbic_crud_errors}}, $params->{message} || 'unknown error' );
+    my $error = 'unknown error';
+    if (exists $params->{message}) {
+        $error = $params->{message};
+        # remove newline from die "error message\n" which is required to not
+        # have the filename and line number in the error text
+        $error =~ s/\n$//;
+    }
+    push( @{$c->stash->{_dbic_crud_errors}}, $error);
 }
 
 =method_protected get_errors
@@ -968,6 +982,10 @@ Below are explanations for various configuration parameters. Please see L<Cataly
 
 Whatever you would pass to $c->model to get a resultset for this class. MyAppDB::Track for example.
 
+=head3 resultset_class
+
+Desired resultset class after accessing your model. MyAppDB::ResultSet::Track for example. By default, it's DBIx::Class::ResultClass::HashRefInflator. Set to empty string to leave resultset class without change.
+
 =head3 data_root
 
 By default, the response data is serialized into $c->stash->{response}->{$self->data_root} and data_root defaults to 'list' to preserve backwards compatibility. This is now configuable to meet the needs of the consuming client.