Implement per object inflation hook in end

[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 b992e96..561508a 100644 (file)
--- a/lib/Catalyst/Controller/DBIC/API.pm
+++ b/lib/Catalyst/Controller/DBIC/API.pm
@@ -301,7 +301,7 @@ The goal of this method is to call ->search() on the current_result_set, HashRef
 
 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.
 
-If not all objects in the resultset are required then it's possible to pass conditions to the method as request parameters. You can use a JSON string as the 'search' parameter for maximum flexibility or use L</CGI::Expand> syntax. In the second case the request parameters are expanded into a structure and then used as the search condition.
+If not all objects in the resultset are required then it's possible to pass conditions to the method as request parameters. You can use a JSON string as the 'search' parameter for maximum flexibility or use L<CGI::Expand> syntax. In the second case the request parameters are expanded into a structure and then used as the search condition.
 
 For example, these request parameters:
 
@@ -715,7 +715,7 @@ sub end :Private
     {
         $DB::single = 1;
         my $returned_objects = [];
-        map {my %inflated = $_->[0]->get_inflated_columns; push(@$returned_objects, \%inflated) } $c->req->all_objects;
+        push(@$returned_objects, $self->each_object_inflate($c, $_)) for map { $_->[0] } $c->req->all_objects;
         $c->stash->{response}->{$self->data_root} = scalar(@$returned_objects) > 1 ? $returned_objects : $returned_objects->[0];
     }
 
@@ -723,12 +723,24 @@ sub end :Private
     $c->forward('serialize');
 }
 
-# from Catalyst::Action::Serialize
-sub serialize :ActionClass('Serialize') {
-    my ($self, $c) = @_;
+=method_protected each_object_inflate
+
+each_object_inflate executes during L</end> and allows hooking into the process of inflating the objects to return in the response. Receives, the context, and the object as arguments.
+
+This only executes if L</return_object> if set and if there are any objects to actually return.
+
+=cut
+
+sub each_object_inflate
+{
+    my ($self, $c, $object) = @_;
 
+    return { $object->get_inflated_columns };
 }
 
+# from Catalyst::Action::Serialize
+sub serialize :ActionClass('Serialize') { }
+
 =method_protected push_error
 
 push_error stores an error message into the stash to be later retrieved by L</end>. Accepts a Dict[message => Str] parameter that defines the error message.
@@ -923,7 +935,7 @@ For example if you wanted create to return the JSON for the newly created object
   BEGIN { extends 'MyApp::ControllerBase::DBIC::API::RPC' };
   ...
 
-It should be noted that the L</return_object> attribute will produce the above result for you, free of charge.
+It should be noted that the return_object attribute will produce the above result for you, free of charge.
 
 For REST the only difference besides the class names would be that create should be :Private rather than an endpoint.