Bug 528062: Hook: Object-end_of_update

Patch by Max Kanat-Alexander <mkanat@bugzilla.org> (module owner) a=mkanat

3 files changed, 64 insertions, 0 deletions

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index 8a9e95eac..b922559b5 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -693,6 +693,32 @@ A hashref. The set of named parameters passed to C<set_all>.
 
 =back
 
+=head2 object-end_of_update
+
+Called during L<Bugzilla::Object/update>, after changes are made
+to the database, but while still inside a transaction.
+
+Params:
+
+=over
+
+=item C<object>
+
+The object that C<update> was called on. You will probably want to
+do something like C<< if ($object->isa('Some::Class')) >> in your code to
+limit your changes to only certain subclasses of Bugzilla::Object.
+
+=item C<old_object>
+
+The object as it was before it was updated.
+
+=item C<changes>
+
+The fields that have been changed, in the same format that
+L<Bugzilla::Object/update> returns.
+
+=back
+
 =head2 page-before_template
 
 This is a simple way to add your own pages to Bugzilla. This hooks C<page.cgi>,
diff --git a/Bugzilla/Object.pm b/Bugzilla/Object.pm
index 05c05f886..cb6543c37 100644
--- a/Bugzilla/Object.pm
+++ b/Bugzilla/Object.pm
@@ -348,6 +348,10 @@ sub update {
     $dbh->do("UPDATE $table SET $columns WHERE $id_field = ?", undef, 
              @values, $self->id) if @values;
 
+    Bugzilla::Hook('object-end_of_update',
+                   { object => $self, old_object => $old_self,
+                     changes => \%changes });
+
     $dbh->bz_commit_transaction();
 
     if (wantarray) {
diff --git a/extensions/example/code/object-end_of_update.pl b/extensions/example/code/object-end_of_update.pl
new file mode 100644
index 000000000..72773cf60
--- /dev/null
+++ b/extensions/example/code/object-end_of_update.pl
@@ -0,0 +1,34 @@
+# -*- Mode: perl; indent-tabs-mode: nil -*-
+#
+# The contents of this file are subject to the Mozilla Public
+# License Version 1.1 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS
+# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# rights and limitations under the License.
+#
+# The Original Code is the Bugzilla Example Plugin.
+#
+# The Initial Developer of the Original Code is ITA Software
+# Portions created by the Initial Developer are Copyright (C) 2009 
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s): 
+#   Max Kanat-Alexander <mkanat@bugzilla.org>
+
+use strict;
+use warnings;
+
+my $args = Bugzilla->hook_args;
+my ($object, $old_object, $changes) = @$args{qw(object old_object changes)};
+
+# Note that this is a made-up class, for this example.
+if ($object->isa('Bugzilla::ExampleObject')) {
+    if (defined $changes->{'name'}) {
+        my ($old, $new) = @{ $changes->{'name'} };
+        print "The name field changed from $old to $new!";
+    }
+}