# This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. # # This Source Code Form is "Incompatible With Secondary Licenses", as # defined by the Mozilla Public License, v. 2.0. use strict; package Bugzilla::Keyword; use base qw(Bugzilla::Object); use Bugzilla::Error; use Bugzilla::Util; ############################### #### Initialization #### ############################### use constant DB_COLUMNS => qw( keyworddefs.id keyworddefs.name keyworddefs.description ); use constant DB_TABLE => 'keyworddefs'; use constant VALIDATORS => { name => \&_check_name, description => \&_check_description, }; use constant UPDATE_COLUMNS => qw( name description ); ############################### #### Accessors ###### ############################### sub description { return $_[0]->{'description'}; } sub bug_count { my ($self) = @_; return $self->{'bug_count'} if defined $self->{'bug_count'}; ($self->{'bug_count'}) = Bugzilla->dbh->selectrow_array( 'SELECT COUNT(*) FROM keywords WHERE keywordid = ?', undef, $self->id); return $self->{'bug_count'}; } ############################### #### Mutators ##### ############################### sub set_name { $_[0]->set('name', $_[1]); } sub set_description { $_[0]->set('description', $_[1]); } ############################### #### Subroutines ###### ############################### sub get_all_with_bug_count { my $class = shift; my $dbh = Bugzilla->dbh; my $keywords = $dbh->selectall_arrayref('SELECT ' . join(', ', $class->_get_db_columns) . ', COUNT(keywords.bug_id) AS bug_count FROM keyworddefs LEFT JOIN keywords ON keyworddefs.id = keywords.keywordid ' . $dbh->sql_group_by('keyworddefs.id', 'keyworddefs.name, keyworddefs.description') . ' ORDER BY keyworddefs.name', {'Slice' => {}}); if (!$keywords) { return []; } foreach my $keyword (@$keywords) { bless($keyword, $class); } return $keywords; } ############################### ### Validators ### ############################### sub _check_name { my ($self, $name) = @_; $name = trim($name); if (!defined $name or $name eq "") { ThrowUserError("keyword_blank_name"); } if ($name =~ /[\s,]/) { ThrowUserError("keyword_invalid_name"); } # We only want to validate the non-existence of the name if # we're creating a new Keyword or actually renaming the keyword. if (!ref($self) || $self->name ne $name) { my $keyword = new Bugzilla::Keyword({ name => $name }); ThrowUserError("keyword_already_exists", { name => $name }) if $keyword; } return $name; } sub _check_description { my ($self, $desc) = @_; $desc = trim($desc); if (!defined $desc or $desc eq '') { ThrowUserError("keyword_blank_description"); } return $desc; } 1; __END__ =head1 NAME Bugzilla::Keyword - A Keyword that can be added to a bug. =head1 SYNOPSIS use Bugzilla::Keyword; my $description = $keyword->description; my $keywords = Bugzilla::Keyword->get_all_with_bug_count(); =head1 DESCRIPTION Bugzilla::Keyword represents a keyword that can be added to a bug. This implements all standard C methods. See L for more details. =head1 SUBROUTINES This is only a list of subroutines specific to C. See L for more subroutines that this object implements. =over =item C 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. =back =cut