217 lines
5.4 KiB
Perl
217 lines
5.4 KiB
Perl
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
|
#
|
|
# The contents of this file are subject to the Mozilla Public
|
|
# License Version 1.1 (the "License"); you may not use this file
|
|
# except in compliance with the License. You may obtain a copy of
|
|
# the License at http://www.mozilla.org/MPL/
|
|
#
|
|
# Software distributed under the License is distributed on an "AS
|
|
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
# implied. See the License for the specific language governing
|
|
# rights and limitations under the License.
|
|
#
|
|
# The Original Code is the Bugzilla Bug Tracking System.
|
|
#
|
|
# Contributor(s): Tiago R. Mello <timello@async.com.br>
|
|
# Frédéric Buclin <LpSolit@gmail.com>
|
|
|
|
use strict;
|
|
|
|
package Bugzilla::Classification;
|
|
|
|
use Bugzilla::Constants;
|
|
use Bugzilla::Util;
|
|
use Bugzilla::Error;
|
|
use Bugzilla::Product;
|
|
|
|
use base qw(Bugzilla::Object);
|
|
|
|
###############################
|
|
#### Initialization ####
|
|
###############################
|
|
|
|
use constant DB_TABLE => 'classifications';
|
|
use constant LIST_ORDER => 'sortkey, name';
|
|
|
|
use constant DB_COLUMNS => qw(
|
|
id
|
|
name
|
|
description
|
|
sortkey
|
|
);
|
|
|
|
use constant REQUIRED_CREATE_FIELDS => qw(
|
|
name
|
|
);
|
|
|
|
use constant UPDATE_COLUMNS => qw(
|
|
name
|
|
description
|
|
sortkey
|
|
);
|
|
|
|
use constant VALIDATORS => {
|
|
name => \&_check_name,
|
|
description => \&_check_description,
|
|
sortkey => \&_check_sortkey,
|
|
};
|
|
|
|
###############################
|
|
#### Constructors #####
|
|
###############################
|
|
sub remove_from_db {
|
|
my $self = shift;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
ThrowUserError("classification_not_deletable") if ($self->id == 1);
|
|
|
|
$dbh->bz_start_transaction();
|
|
# Reclassify products to the default classification, if needed.
|
|
$dbh->do("UPDATE products SET classification_id = 1
|
|
WHERE classification_id = ?", undef, $self->id);
|
|
|
|
$self->SUPER::remove_from_db();
|
|
|
|
$dbh->bz_commit_transaction();
|
|
|
|
}
|
|
|
|
###############################
|
|
#### Validators ####
|
|
###############################
|
|
|
|
sub _check_name {
|
|
my ($invocant, $name) = @_;
|
|
|
|
$name = trim($name);
|
|
$name || ThrowUserError('classification_not_specified');
|
|
|
|
if (length($name) > MAX_CLASSIFICATION_SIZE) {
|
|
ThrowUserError('classification_name_too_long', {'name' => $name});
|
|
}
|
|
|
|
my $classification = new Bugzilla::Classification({name => $name});
|
|
if ($classification && (!ref $invocant || $classification->id != $invocant->id)) {
|
|
ThrowUserError("classification_already_exists", { name => $classification->name });
|
|
}
|
|
return $name;
|
|
}
|
|
|
|
sub _check_description {
|
|
my ($invocant, $description) = @_;
|
|
|
|
$description = trim($description || '');
|
|
return $description;
|
|
}
|
|
|
|
sub _check_sortkey {
|
|
my ($invocant, $sortkey) = @_;
|
|
|
|
$sortkey ||= 0;
|
|
my $stored_sortkey = $sortkey;
|
|
if (!detaint_natural($sortkey) || $sortkey > MAX_SMALLINT) {
|
|
ThrowUserError('classification_invalid_sortkey', { 'sortkey' => $stored_sortkey });
|
|
}
|
|
return $sortkey;
|
|
}
|
|
|
|
###############################
|
|
#### Methods ####
|
|
###############################
|
|
|
|
sub set_name { $_[0]->set('name', $_[1]); }
|
|
sub set_description { $_[0]->set('description', $_[1]); }
|
|
sub set_sortkey { $_[0]->set('sortkey', $_[1]); }
|
|
|
|
sub product_count {
|
|
my $self = shift;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
if (!defined $self->{'product_count'}) {
|
|
$self->{'product_count'} = $dbh->selectrow_array(q{
|
|
SELECT COUNT(*) FROM products
|
|
WHERE classification_id = ?}, undef, $self->id) || 0;
|
|
}
|
|
return $self->{'product_count'};
|
|
}
|
|
|
|
sub products {
|
|
my $self = shift;
|
|
my $dbh = Bugzilla->dbh;
|
|
|
|
if (!$self->{'products'}) {
|
|
my $product_ids = $dbh->selectcol_arrayref(q{
|
|
SELECT id FROM products
|
|
WHERE classification_id = ?
|
|
ORDER BY name}, undef, $self->id);
|
|
|
|
$self->{'products'} = Bugzilla::Product->new_from_list($product_ids);
|
|
}
|
|
return $self->{'products'};
|
|
}
|
|
|
|
###############################
|
|
#### Accessors ####
|
|
###############################
|
|
|
|
sub description { return $_[0]->{'description'}; }
|
|
sub sortkey { return $_[0]->{'sortkey'}; }
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
Bugzilla::Classification - Bugzilla classification class.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use Bugzilla::Classification;
|
|
|
|
my $classification = new Bugzilla::Classification(1);
|
|
my $classification = new Bugzilla::Classification({name => 'Acme'});
|
|
|
|
my $id = $classification->id;
|
|
my $name = $classification->name;
|
|
my $description = $classification->description;
|
|
my $sortkey = $classification->sortkey;
|
|
my $product_count = $classification->product_count;
|
|
my $products = $classification->products;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Classification.pm represents a classification object. It is an
|
|
implementation of L<Bugzilla::Object>, and thus provides all methods
|
|
that L<Bugzilla::Object> provides.
|
|
|
|
The methods that are specific to C<Bugzilla::Classification> are listed
|
|
below.
|
|
|
|
A Classification is a higher-level grouping of Products.
|
|
|
|
=head1 METHODS
|
|
|
|
=over
|
|
|
|
=item C<product_count()>
|
|
|
|
Description: Returns the total number of products that belong to
|
|
the classification.
|
|
|
|
Params: none.
|
|
|
|
Returns: Integer - The total of products inside the classification.
|
|
|
|
=item C<products>
|
|
|
|
Description: Returns all products of the classification.
|
|
|
|
Params: none.
|
|
|
|
Returns: A reference to an array of Bugzilla::Product objects.
|
|
|
|
=back
|
|
|
|
=cut
|