<<

# Bugzilla::Keyword

- NAME
- SYNOPSIS
- DESCRIPTION
- METHODS

# NAME

Bugzilla::Keyword - A Keyword that can be added to a bug.

# SYNOPSIS

     use Bugzilla::Keyword;

     my $description = $keyword->description;

     my $keywords = Bugzilla::Keyword->get_all_with_bug_count();

# DESCRIPTION

Bugzilla::Keyword represents a keyword that can be added to a bug.

This implements all standard `Bugzilla::Object` methods. See Bugzilla::Object for more details.

# METHODS

This is only a list of methods specific to `Bugzilla::Keyword`. See Bugzilla::Object for more methods that this object implements.

`get_all_with_bug_count()`

       Description: Returns all defined keywords. This is an efficient way
                    to get the associated bug counts, as only one SQL query
                    is executed with this method, instead of one per keyword
                    when calling get_all and then bug_count.
       Params:      none
       Returns:     A reference to an array of Keyword objects, or an empty
                    arrayref if there are no keywords.

`is_active`

       Description: Indicates if the keyword may be used on a bug
       Params:      none
       Returns:     a boolean value that is true if the keyword can be applied to bugs.

`set_is_active($is_active)`

       Description: Set the is_active property to a boolean value
       Params:      the new value of the is_active property.
       Returns:     nothing

<<