From: mkanat%bugzilla.org <>
Date: Wed, 1 Nov 2006 07:25:05 +0000 (+0000)
Subject: Bug 356816: Make the webservice able to list products
X-Git-Tag: bugzilla-2.23.4~242
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d8370a5af3b242cedee3db8566dbfa13d7ca59d7;p=thirdparty%2Fbugzilla.git

Bug 356816: Make the webservice able to list products
Patch By Mads Bondo Dydensborg <mbd@dbc.dk> r=mkanat, a=myk
---

diff --git a/Bugzilla/WebService/Product.pm b/Bugzilla/WebService/Product.pm
index b56abb588e..ee02143c13 100755
--- a/Bugzilla/WebService/Product.pm
+++ b/Bugzilla/WebService/Product.pm
@@ -13,12 +13,32 @@
 # The Original Code is the Bugzilla Bug Tracking System.
 #
 # Contributor(s): Marc Schumann <wurblzap@gmail.com>
+#                 Mads Bondo Dydensborg <mbd@dbc.dk>
 
 package Bugzilla::WebService::Product;
 
 use strict;
 use base qw(Bugzilla::WebService);
 use Bugzilla::Product;
+use Bugzilla::User;
+
+# Get the ids of the products the user can search
+sub get_selectable_products {
+    return {ids => [map {$_->id} @{Bugzilla->user->get_selectable_products}]}; 
+}
+
+# Get the ids of the products the user can enter bugs against
+sub get_enterable_products {
+    return {ids => [map {$_->id} @{Bugzilla->user->get_enterable_products}]}; 
+}
+
+# Get the union of the products the user can search and enter bugs against.
+sub get_accessible_products {
+    my %union = ();
+    map $union{ $_->id } = 1, @{Bugzilla->user->get_selectable_products};
+    map $union{ $_->id } = 1, @{Bugzilla->user->get_enterable_products};
+    return { ids => [keys %union] };
+}
 
 sub get_product {
     my $self = shift;
@@ -34,3 +54,55 @@ sub get_product {
 }
 
 1;
+
+__END__
+
+=head1 NAME
+
+Bugzilla::Webservice::User - The Product API
+
+=head1 DESCRIPTION
+
+This part of the Bugzilla API allows you to list the available Products and
+get information about them.
+
+=head1 METHODS
+
+See L<Bugzilla::WebService> for a description of what B<STABLE>, B<UNSTABLE>,
+and B<EXPERIMENTAL> mean, and for more information about error codes.
+
+=head2 List Products
+
+=over
+
+=item C<get_selectable_products> B<UNSTABLE>
+
+Description: Returns a list of the ids of the products the user can search on.
+
+Params:     none
+
+Returns:    A hash containing one item, C<ids>, that contains an array
+            of product ids.
+
+=item C<get_enterable_products> B<UNSTABLE>
+
+Description: Returns a list of the ids of the products the user can enter bugs
+             against.
+
+Params:     none
+
+Returns:    A hash containing one item, C<ids>, that contains an array
+            of product ids.
+
+=item C<get_accessible_products> B<UNSTABLE>
+
+Description: Returns a list of the ids of the products the user can search or 
+             enter bugs against.
+
+Params:     none
+
+Returns:    A hash containing one item, C<ids>, that contains an array
+            of product ids.
+
+=back
+