Bug 524007: New Hook: object-end_of_create_validators

Patch by Max Kanat-Alexander <mkanat@bugzilla.org> r=dkl, a=mkanat

diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm
index 324576594d1d10b65cc03109dfe0a4a867066c2e..b1feea1383933da9577c3a27f2012cf668f8b302 100644 (file)
--- a/Bugzilla/Hook.pm
+++ b/Bugzilla/Hook.pm
@@ -605,6 +605,31 @@ A hashref. The set of named parameters passed to C<create>.
 
 =back
 
+=head2 object-end_of_create_validators
+
+Called at the end of L<Bugzilla::Object/run_create_validators>. You can
+use this to run additional validation when creating an object.
+
+If a subclass has overridden C<run_create_validators>, then this usually
+happens I<before> the subclass does its custom validation.
+
+Params:
+
+=over
+
+=item C<class>
+
+The name of the class that C<create> was called on. You can check this 
+like C<< if ($class->isa('Some::Class')) >> in your code, to perform specific
+tasks for only certain classes.
+
+=item C<params>
+
+A hashref. The set of named parameters passed to C<create>, modified and
+validated by the C<VALIDATORS> specified for the object.
+
+=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 d99c17a63eb39d299b42fd3f5c5a7229aa8faf7a..08b60af28cce6191613357835ff2ec3573e34115 100644 (file)
--- a/Bugzilla/Object.pm
+++ b/Bugzilla/Object.pm
@@ -435,6 +435,9 @@ sub run_create_validators {
         $field_values{$field} = $value;
     }
 
+    Bugzilla::Hook::process('object-end_of_create_validators',
+                            { class => $class, params => \%field_values });
+
     return \%field_values;
 }
 

diff --git a/extensions/example/code/object-end_of_create_validators.pl b/extensions/example/code/object-end_of_create_validators.pl
new file mode 100644 (file)
index 0000000..42ed6f7
--- /dev/null
+++ b/extensions/example/code/object-end_of_create_validators.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;
+use Bugzilla;
+
+my $args = Bugzilla->hook_args;
+my $class = $args->{'class'};
+my $params = $args->{'params'};
+
+# Note that this is a made-up class, for this example.
+if ($class->isa('Bugzilla::ExampleObject')) {
+    # Always set example_field to 1, even if the validators said otherwise.
+    $params->{example_field} = 1;
+}
+