From: Max Kanat-Alexander <mkanat@bugzilla.org>
Date: Fri, 2 Apr 2010 05:42:42 +0000 (-0700)
Subject: Bug 556695: New Hook: object_end_of_set
X-Git-Tag: bugzilla-3.7.1~138
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2a444f9d50535445a84367a9833bd87a07752d0a;p=thirdparty%2Fbugzilla.git

Bug 556695: New Hook: object_end_of_set
r=mkanat, a=mkanat (module owner)
---

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index af73814cea..556fda894e 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -784,6 +784,34 @@ validated by the C<VALIDATORS> specified for the object.
 
 =back
 
+
+=head2 object_end_of_set
+
+Called during L<Bugzilla::Object/set>, after all the code of the function
+has completed (so the value has been validated and the field has been set
+to the new value). You can use this to perform actions after a value is
+changed for specific fields on certain types of objects.
+
+The new value is not specifically passed to this hook because you can
+get it as C<< $object->{$field} >>.
+
+Params:
+
+=over
+
+=item C<object>
+
+The object that C<set> 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<field>
+
+The name of the field that was updated in the object.
+
+=back
+
+
 =head2 object_end_of_set_all
 
 This happens at the end of L<Bugzilla::Object/set_all>. This is a
diff --git a/Bugzilla/Object.pm b/Bugzilla/Object.pm
index a54cf7caa4..e50be1fbf9 100644
--- a/Bugzilla/Object.pm
+++ b/Bugzilla/Object.pm
@@ -306,6 +306,9 @@ sub set {
     }
 
     $self->{$field} = $value;
+
+    Bugzilla::Hook::process('object_end_of_set',
+                            { object => $self, field => $field });
 }
 
 sub set_all {
diff --git a/extensions/Example/Extension.pm b/extensions/Example/Extension.pm
index 398ddbd565..52ac66231f 100644
--- a/extensions/Example/Extension.pm
+++ b/extensions/Example/Extension.pm
@@ -386,6 +386,17 @@ sub object_end_of_create_validators {
     
 }
 
+sub object_end_of_set {
+    my ($self, $args) = @_;
+
+    my ($object, $field) = @$args{qw(object field)};
+
+    # Note that this is a made-up class, for this example.
+    if ($object->isa('Bugzilla::ExampleObject')) {
+        warn "The field $field has changed to " . $object->{$field};
+    }
+}
+
 sub object_end_of_set_all {
     my ($self, $args) = @_;