<<

# Bugzilla::Component

- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS
- SUBROUTINES

# NAME

Bugzilla::Component - Bugzilla product component class.

# SYNOPSIS

        use Bugzilla::Component;

        my $component = new Bugzilla::Component(1);
        my $component = new Bugzilla::Component({product_id => 1,
                                                 name       => 'AcmeComp'});

        my $bug_count          = $component->bug_count();
        my $bug_ids            = $component->bug_ids();
        my $id                 = $component->id;
        my $name               = $component->name;
        my $description        = $component->description;
        my $product_id         = $component->product_id;
        my $default_assignee   = $component->default_assignee;
        my $default_qa_contact = $component->default_qa_contact;
        my $initial_cc         = $component->initial_cc
        my $bug_flag_types     = $component->flag_types->{'bug'};
        my $attach_flag_types  = $component->flag_types->{'attachment'};

        my $component  = Bugzilla::Component::check_component($product, 'AcmeComp');

# DESCRIPTION

Component.pm represents a Product Component object.

# METHODS

`new($param)`

       Description: The constructor is used to load an existing component
                    by passing a component id or a hash with the product
                    id and the component name.

       Params:      $param - If you pass an integer, the integer is the
                             component id from the database that we want to
                             read in. If you pass in a hash with 'name' key,
                             then the value of the name key is the name of a
                             component from the DB.

       Returns:     A Bugzilla::Component object.

`bug_count()`

       Description: Returns the total of bugs that belong to the component.

       Params:      none.

       Returns:     Integer with the number of bugs.

`bugs_ids()`

       Description: Returns all bug IDs that belong to the component.

       Params:      none.

       Returns:     A reference to an array of bug IDs.

`default_assignee()`

       Description: Returns a user object that represents the default assignee for
                    the component.

       Params:      none.

       Returns:     A Bugzilla::User object.

`default_qa_contact()`

       Description: Returns a user object that represents the default QA contact for
                    the component.

       Params:      none.

       Returns:     A Bugzilla::User object.

`initial_cc`

  Returns an arrayref of Bugzilla::User objects representing the Initial CC List.

`flag_types()`

        Description: Returns all bug and attachment flagtypes available for
                     the component.

        Params:      none.

        Returns:     Two references to an array of flagtype objects.

# SUBROUTINES

`check_component($product, $comp_name)`

       Description: Checks if the component name was passed in and if it is a valid
                    component.

       Params:      $product - A Bugzilla::Product object.
                    $comp_name - String with a component name.

       Returns:     Bugzilla::Component object.

<<