From: mkanat%bugzilla.org <>
Date: Wed, 18 Nov 2009 07:17:51 +0000 (+0000)
Subject: Bug 525426: Hook: object-before_set
X-Git-Tag: bugzilla-3.5.2~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b47f92d8421d4c81e6cda17296a63c5f4139d816;p=thirdparty%2Fbugzilla.git

Bug 525426: Hook: object-before_set
Patch by Max Kanat-Alexander <mkanat@bugzilla.org> r=dkl, a=mkanat
---

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index b98fc95d75..b35a338d6b 100644
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -620,6 +620,32 @@ A hashref. The set of named parameters passed to C<create>.
 
 =back
 
+=head2 object-before_set
+
+Called during L<Bugzilla::Object/set>, before any actual work is done.
+You can use this to perform actions before a value is changed for
+specific fields on certain types of objects.
+
+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 being updated in the object.
+
+=item C<value> 
+
+The value being set on the object.
+
+=back
+
 =head2 object-end_of_create_validators
 
 Called at the end of L<Bugzilla::Object/run_create_validators>. You can
diff --git a/Bugzilla/Object.pm b/Bugzilla/Object.pm
index 08b60af28c..0630a78d49 100644
--- a/Bugzilla/Object.pm
+++ b/Bugzilla/Object.pm
@@ -279,6 +279,10 @@ sub set {
                             superclass => __PACKAGE__,
                             function   => 'Bugzilla::Object->set' });
 
+    Bugzilla::Hook::process('object-before_set',
+                            { object => $self, field => $field,
+                              value => $value });
+
     my %validators = (%{$self->VALIDATORS}, %{$self->UPDATE_VALIDATORS});
     if (exists $validators{$field}) {
         my $validator = $validators{$field};
diff --git a/extensions/example/code/object-before_set.pl b/extensions/example/code/object-before_set.pl
new file mode 100644
index 0000000000..43007efdb5
--- /dev/null
+++ b/extensions/example/code/object-before_set.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, $field, $value) = @$args{qw(object field value)};
+
+# Note that this is a made-up class, for this example.
+if ($object->isa('Bugzilla::ExampleObject')) {
+    warn "The field $field is changing from " . $object->{$field} 
+         . " to $value!";
+}
+
+