/ 
BZ-Client-4.4004
River stage zero No dependents
/ BZ::Client::Classification

NAME

BZ::Client::Classification - Client side representation of Classifications in Bugzilla

VERSION

version 4.4004

SYNOPSIS

This class provides methods for accessing Classification information in the Bugzilla server.

my $client = BZ::Client->new( url      => $url,
                              user     => $user,
                              password => $password );

my $classifications = BZ::Client::Classification->get( $client, \%params );

CLASS METHODS

This section lists the class methods, which are available in this module.

get

$classifications = BZ::Client::Classification->get( $client, \%params );

Returns a hash containing information about a set of classifications.

History

Added in Bugzilla 4.4.

Marked experiemental as of Bugzilla 5.0.

Parameters

In addition to the parameters below, this method also accepts the standard "include_fields" in BZ::Client::Bug and "exclude_fields" in BZ::Client::Bug arguments.

You could get classifications info by supplying their names and/or ids. So, this method accepts the following parameters:

ids

An array of classification ids.

names

An array of classification names.

Returns

An array of hashes as the corresponding value. Each element of the array represents a classification that the user is authorized to see and has the following keys:

id

id (int) The id of the classification.

name

name (string) The name of the classification.

description

description (string) The description of the classificaion.

sort_key

sort_key (int) The value which determines the order the classification is sorted.

products

An array of hashes. The array contains the products the user is authorized to access within the classification. Each hash has the following keys:

name

name (string) The name of the product.

id

id (int) The id of the product.

description

description (string) The description of the product.

Errors

900 - Classification not enabled

Classification is not enabled on this installation.

EXCEPTION HANDLING

See BZ::Client::Exception

SEE ALSO

BZ::Client, BZ::Client::API, Bugzilla API

AUTHORS

  • Dean Hamstead <dean@bytefoundry.com.au>

  • Jochen Wiedmann <jochen.wiedmann@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Dean Hamstad.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.