diff options
| -rw-r--r-- | Bugzilla/Hook.pm | 20 | ||||
| -rw-r--r-- | Bugzilla/Object.pm | 6 | ||||
| -rw-r--r-- | extensions/example/code/object-before_create.pl | 33 |
3 files changed, 59 insertions, 0 deletions
diff --git a/Bugzilla/Hook.pm b/Bugzilla/Hook.pm index 69fa2f654..324576594 100644 --- a/Bugzilla/Hook.pm +++ b/Bugzilla/Hook.pm @@ -585,6 +585,26 @@ Params: =back +=head2 object-before_create + +This happens at the beginning of L<Bugzilla::Object/create>. + +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 before C<create> for only certain classes. + +=item C<params> + +A hashref. The set of named parameters passed to C<create>. + +=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 b04593f89..d99c17a63 100644 --- a/Bugzilla/Object.pm +++ b/Bugzilla/Object.pm @@ -24,6 +24,7 @@ use strict; package Bugzilla::Object; use Bugzilla::Constants; +use Bugzilla::Hook; use Bugzilla::Util; use Bugzilla::Error; @@ -399,6 +400,11 @@ sub _check_field { sub check_required_create_fields { my ($class, $params) = @_; + # This hook happens here so that even subclasses that don't call + # SUPER::create are still affected by the hook. + Bugzilla::Hook::process('object-before_create', { class => $class, + params => $params }); + foreach my $field ($class->REQUIRED_CREATE_FIELDS) { ThrowCodeError('param_required', { function => "${class}->create", param => $field }) diff --git a/extensions/example/code/object-before_create.pl b/extensions/example/code/object-before_create.pl new file mode 100644 index 000000000..5961b6186 --- /dev/null +++ b/extensions/example/code/object-before_create.pl @@ -0,0 +1,33 @@ +# -*- 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')) { + warn "About to create an ExampleObject!"; + warn "Got the following parameters: " . join(', ', keys(%$params)); +} |