Attachment 296301 Details for Bug 427885 – Bugzilla::WebService::Bug::get_activity()

[patch] Bugzilla::WebService::Bug::get_activity()

patch.diff (text/plain), 3.41 KB, created by Noura El hawary on 2008-02-29 04:04:20 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Noura El hawary

Created: 2008-02-29 04:04:20 UTC

Size: 3.41 KB

patch

obsolete

>Index: Bug.pm
>===================================================================
>RCS file: /cvs/qa/rh_bugzilla_3/Bugzilla/WebService/Bug.pm,v
>retrieving revision 1.5
>retrieving revision 1.6
>diff -u -r1.5 -r1.6
>--- Bug.pm      12 Feb 2008 19:45:14 -0000      1.5
>+++ Bug.pm      29 Feb 2008 04:01:24 -0000      1.6
>@@ -111,6 +111,38 @@
>     return { bugs => \@return };
> }
> 
>+# this is a function that gets bug activity for list of bug ids 
>+# it can be called as the following:
>+# $call = $rpc->call( 'Bug.get_activity', { ids => [1,2] });
>+sub get_activity {
>+    my ($self, $params) = @_;    
>+
>+    my @ids = ref($params->{ids}) ? @{$params->{ids}} : ($params->{ids});
>+    @ids || ThrowCodeError('param_required', { param => 'ids' });
>+
>+    my @return;
>+    foreach my $bug_id (@ids) {
>+        my %item;
>+        ValidateBugID($bug_id);
>+        $item{id} = $bug_id;
>+
>+        ( $item{operations}, $item{incomplete_data} ) = Bugzilla::Bug::GetBugActivity($bug_id);    
>+
>+        my $bug = new Bugzilla::Bug($bug_id);
>+        if (Bugzilla->params->{'usebugaliases'}) {
>+            $item{alias} = type('string')->value($bug->alias);
>+        }
>+        else {
>+            # For API reasons, we always want the value to appear, we just
>+            # don't want it to have a value if aliases are turned off.
>+            $item{alias} = undef;
>+        }
>+
>+        push(@return, \%item);
>+    }
>+
>+    return { bugs => \@return };  
>+} 
> 
> sub create {
>     my ($self, $params) = @_;
>@@ -367,7 +399,84 @@
> 
> =back
> 
>+=item C<get_activity> B<EXPERIMENTAL>
>+
>+=over
>+
>+=item B<Description>
>+
>+Gets activity about particular bugs in the database.
>+
>+=item B<Params>
>+
>+=over
>+
>+=item C<ids>
>+
>+An array of numbers and strings, or single value that is a number
>+or a string.
>+
>+If an element in the array or the single value is entirely numeric, 
>+it represents a bug_id from the Bugzilla database to fetch. If it 
>+contains any non-numeric characters, it is considered to be a bug 
>+alias instead, and the bug with that alias will be loaded. 
>+
>+Note that it's possible for aliases to be disabled in Bugzilla, in which
>+case you will be told that you have specified an invalid bug_id if you
>+try to specify an alias. (It will be error 100.)
>+
>+=back
>+
>+=item B<Returns>
>+
>+A hash containing a single element, C<bugs>. This is an array of hashes. 
>+Each hash contains the following items:
>+
>+=over
>+
>+=item id
>+
>+C<int> The numeric bug_id of this bug.
>+
>+=item alias
>+
>+C<string> The alias of this bug. If there is no alias or aliases are 
>+disabled in this Bugzilla, this will be an empty string.
>+
>+=item operations
>+
>+C<array> An array of hashes with each hash containing C<when>, which is a 
>+string that holds the date the bug activity/change happened, C<who> which is
>+a string that holds the login name for the person who performed the change,
>+and C<changes> which is an array of hashes that holds the change details.
>+
>+=item incomplete_data
>+
>+C<boolean> Is set to 1 to indicate that there is an old Bugzilla data 
>+corruption bug, otherwise 0.
>+
>+=back
>+
>+=item B<Errors>
>+
>+=over
> 
>+=item 100 (Invalid Bug Alias)
>+
>+If you specified an alias and either: (a) the Bugzilla you're querying
>+doesn't support aliases or (b) there is no bug with that alias.
>+
>+=item 101 (Invalid Bug ID)
>+
>+The bug_id you specified doesn't exist in the database.
>+
>+=item 102 (Access Denied)
>+
>+You do not have access to the bug_id you specified.
>+
>+=back
>+
>+=back
> 
> =item C<create> B<EXPERIMENTAL>

Actions: View | Diff

Attachments on bug 427885: 291686 | 296019 | 296199 | 296301