1BZ::Client::ClassificatUisoenr(3C)ontributed Perl DocumeBnZt:a:tCiloinent::Classification(3)
2
3
4

NAME

6       BZ::Client::Classification - Client side representation of
7       Classifications in Bugzilla
8

VERSION

10       version 4.4002
11

SYNOPSIS

13       This class provides methods for accessing Classification information in
14       the Bugzilla server.
15
16         my $client = BZ::Client->new( url      => $url,
17                                       user     => $user,
18                                       password => $password );
19
20         my $classifications = BZ::Client::Classification->get( $client, \%params );
21

CLASS METHODS

23       This section lists the class methods, which are available in this
24       module.
25
26   get
27        $classifications = BZ::Client::Classification->get( $client, \%params );
28
29       Returns a hash containing information about a set of classifications.
30
31       History
32
33       Added in Bugzilla 4.4.
34
35       Marked experiemental as of Bugzilla 5.0.
36
37       Parameters
38
39       In addition to the parameters below, this method also accepts the
40       standard "include_fields" in BZ::Client::Bug and "exclude_fields" in
41       BZ::Client::Bug arguments.
42
43       You could get classifications info by supplying their names and/or ids.
44       So, this method accepts the following parameters:
45
46       ids An array of classification ids.
47
48       names
49           An array of classification names.
50
51       Returns
52
53       An array of hashes as the corresponding value. Each element of the
54       array represents a classification that the user is authorized to see
55       and has the following keys:
56
57       id  id (int) The id of the classification.
58
59       name
60           name (string) The name of the classification.
61
62       description
63           description (string) The description of the classificaion.
64
65       sort_key
66           sort_key (int) The value which determines the order the
67           classification is sorted.
68
69       products
70           An array of hashes. The array contains the products the user is
71           authorized to access within the classification. Each hash has the
72           following keys:
73
74           name
75               name (string) The name of the product.
76
77           id  id (int) The id of the product.
78
79           description
80               description (string) The description of the product.
81
82       Errors
83
84       900 - Classification not enabled
85           Classification is not enabled on this installation.
86

EXCEPTION HANDLING

88       See BZ::Client::Exception
89

SEE ALSO

91       BZ::Client, BZ::Client::API, Bugzilla API
92       <https://www.bugzilla.org/docs/tip/en/html/api/Bugzilla/WebService/Classification.html>
93

AUTHORS

95       ·   Dean Hamstead <dean@bytefoundry.com.au>
96
97       ·   Jochen Wiedmann <jochen.wiedmann@gmail.com>
98

100       This software is copyright (c) 2017 by Dean Hamstad.
101
102       This is free software; you can redistribute it and/or modify it under
103       the same terms as the Perl 5 programming language system itself.
104
105
106
107perl v5.28.1                      2019-02-02     BZ::Client::Classification(3)
Impressum