# 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;
use Bugzilla::Error;
use Bugzilla::Product;
+use base qw(Bugzilla::Object);
+
###############################
#### Initialization ####
###############################
+use constant DB_TABLE => 'classifications';
+
use constant DB_COLUMNS => qw(
- classifications.id
- classifications.name
- classifications.description
- classifications.sortkey
+ id
+ name
+ description
+ sortkey
+);
+
+use constant REQUIRED_CREATE_FIELDS => qw(
+ name
+);
+
+use constant UPDATE_COLUMNS => qw(
+ name
+ description
+ sortkey
);
-our $columns = join(", ", DB_COLUMNS);
+use constant VALIDATORS => {
+ name => \&_check_name,
+ description => \&_check_description,
+ sortkey => \&_check_sortkey,
+};
###############################
-#### Methods ####
+#### Validators ####
###############################
-sub new {
- my $invocant = shift;
- my $class = ref($invocant) || $invocant;
- my $self = {};
- bless($self, $class);
- return $self->_init(@_);
-}
+sub _check_name {
+ my ($invocant, $name) = @_;
-sub _init {
- my $self = shift;
- my ($param) = @_;
- my $dbh = Bugzilla->dbh;
+ $name = trim($name);
+ $name || ThrowUserError('classification_not_specified');
- my $id = $param unless (ref $param eq 'HASH');
- my $classification;
+ my $classification = new Bugzilla::Classification({name => $name});
+ if ($classification && (!ref $invocant || $classification->id != $invocant->id)) {
+ ThrowUserError("classification_already_exists", { name => $classification->name });
+ }
+ return $name;
+}
- if (defined $id) {
- detaint_natural($id)
- || ThrowCodeError('param_must_be_numeric',
- {function => 'Bugzilla::Classification::_init'});
+sub _check_description {
+ my ($invocant, $description) = @_;
- $classification = $dbh->selectrow_hashref(qq{
- SELECT $columns FROM classifications
- WHERE id = ?}, undef, $id);
+ $description = trim($description || '');
+ return $description;
+}
- } elsif (defined $param->{'name'}) {
+sub _check_sortkey {
+ my ($invocant, $sortkey) = @_;
- trick_taint($param->{'name'});
- $classification = $dbh->selectrow_hashref(qq{
- SELECT $columns FROM classifications
- WHERE name = ?}, undef, $param->{'name'});
- } else {
- ThrowCodeError('bad_arg',
- {argument => 'param',
- function => 'Bugzilla::Classification::_init'});
- }
+ $sortkey ||= 0;
+ my $stored_sortkey = $sortkey;
+ detaint_natural($sortkey)
+ || ThrowUserError('classification_invalid_sortkey', { 'sortkey' => $stored_sortkey });
- return undef unless (defined $classification);
-
- foreach my $field (keys %$classification) {
- $self->{$field} = $classification->{$field};
- }
- return $self;
+ return $sortkey;
}
+###############################
+#### Methods ####
+###############################
+
sub product_count {
my $self = shift;
my $dbh = Bugzilla->dbh;
#### Accessors ####
###############################
-sub id { return $_[0]->{'id'}; }
-sub name { return $_[0]->{'name'}; }
sub description { return $_[0]->{'description'}; }
sub sortkey { return $_[0]->{'sortkey'}; }
-###############################
-#### Subroutines ####
-###############################
-
-sub get_all_classifications {
- my $dbh = Bugzilla->dbh;
-
- my $ids = $dbh->selectcol_arrayref(q{
- SELECT id FROM classifications ORDER BY sortkey, name});
-
- my @classifications;
- foreach my $id (@$ids) {
- push @classifications, new Bugzilla::Classification($id);
- }
- return @classifications;
-}
-
-sub check_classification {
- my ($class_name) = @_;
-
- unless ($class_name) {
- ThrowUserError("classification_not_specified");
- }
-
- my $classification =
- new Bugzilla::Classification({name => $class_name});
-
- unless ($classification) {
- ThrowUserError("classification_doesnt_exist",
- { name => $class_name });
- }
-
- return $classification;
-}
-
1;
__END__
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;
- my $hash_ref = Bugzilla::Classification::get_all_classifications();
- my $classification = $hash_ref->{1};
-
- my $classification =
- Bugzilla::Classification::check_classification('AcmeClass');
-
=head1 DESCRIPTION
-Classification.pm represents a Classification object.
+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.
=over
-=item C<new($param)>
-
- Description: The constructor is used to load an existing
- classification by passing a classification
- id or classification name using a hash.
-
- Params: $param - If you pass an integer, the integer is the
- classification_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 classification from the DB.
-
- Returns: A Bugzilla::Classification object.
-
=item C<product_count()>
Description: Returns the total number of products that belong to
=back
-=head1 SUBROUTINES
-
-=over
-
-=item C<get_all_classifications()>
-
- Description: Returns all classifications.
-
- Params: none.
-
- Returns: Bugzilla::Classification object list.
-
-=item C<check_classification($classification_name)>
-
- Description: Checks if the classification name passed in is a
- valid classification.
-
- Params: $classification_name - String with a classification name.
-
- Returns: Bugzilla::Classification object.
-
-=back
-
=cut
my $cgi = Bugzilla->cgi;
my $template = Bugzilla->template;
- $vars->{'classifications'} = [Bugzilla::Classification::get_all_classifications()]
+ $vars->{'classifications'} = [Bugzilla::Classification->get_all]
if ($action eq 'select');
# There is currently only one section about classifications,
# so all pages point to it. Let's define it here.
my $sortkey = trim($cgi->param('sortkey') || 0);
my $stored_sortkey = $sortkey;
detaint_natural($sortkey)
- || ThrowUserError('classification_invalid_sortkey', {'name' => $class_name,
- 'sortkey' => $stored_sortkey});
+ || ThrowUserError('classification_invalid_sortkey', {'sortkey' => $stored_sortkey});
trick_taint($description);
trick_taint($class_name);
$vars->{'message'} = 'classification_created';
$vars->{'classification'} = new Bugzilla::Classification({name => $class_name});
- $vars->{'classifications'} = [Bugzilla::Classification::get_all_classifications];
+ $vars->{'classifications'} = [Bugzilla::Classification->get_all];
$vars->{'token'} = issue_session_token('reclassify_classifications');
LoadTemplate('reclassify');
}
if ($action eq 'del') {
- my $classification =
- Bugzilla::Classification::check_classification($class_name);
+ my $classification = Bugzilla::Classification->check($class_name);
if ($classification->id == 1) {
ThrowUserError("classification_not_deletable");
if ($action eq 'delete') {
check_token_data($token, 'delete_classification');
- my $classification =
- Bugzilla::Classification::check_classification($class_name);
+ my $classification = Bugzilla::Classification->check($class_name);
if ($classification->id == 1) {
ThrowUserError("classification_not_deletable");
if ($action eq 'edit') {
- my $classification =
- Bugzilla::Classification::check_classification($class_name);
+ my $classification = Bugzilla::Classification->check($class_name);
$vars->{'classification'} = $classification;
$vars->{'token'} = issue_session_token('edit_classification');
my $class_old_name = trim($cgi->param('classificationold') || '');
- my $class_old =
- Bugzilla::Classification::check_classification($class_old_name);
+ my $class_old = Bugzilla::Classification->check($class_old_name);
my $description = trim($cgi->param('description') || '');
my $sortkey = trim($cgi->param('sortkey') || 0);
my $stored_sortkey = $sortkey;
detaint_natural($sortkey)
- || ThrowUserError('classification_invalid_sortkey', {'name' => $class_old->name,
- 'sortkey' => $stored_sortkey});
+ || ThrowUserError('classification_invalid_sortkey', {'sortkey' => $stored_sortkey});
$dbh->bz_start_transaction();
#
if ($action eq 'reclassify') {
-
- my $classification =
- Bugzilla::Classification::check_classification($class_name);
+ my $classification = Bugzilla::Classification->check($class_name);
my $sth = $dbh->prepare("UPDATE products SET classification_id = ?
WHERE name = ?");
delete_token($token);
}
- my @classifications =
- Bugzilla::Classification::get_all_classifications;
- $vars->{'classifications'} = \@classifications;
+ $vars->{'classifications'} = [Bugzilla::Classification->get_all];
$vars->{'classification'} = $classification;
$vars->{'token'} = issue_session_token('reclassify_classifications');
&& !$product_name)
{
$vars->{'classifications'} = $user->in_group('editcomponents') ?
- [Bugzilla::Classification::get_all_classifications] : $user->get_selectable_classifications;
+ [Bugzilla::Classification->get_all] : $user->get_selectable_classifications;
$template->process("admin/products/list-classifications.html.tmpl", $vars)
|| ThrowTemplateError($template->error());
my $products;
if (Bugzilla->params->{'useclassification'}) {
- $classification =
- Bugzilla::Classification::check_classification($classification_name);
-
+ $classification = Bugzilla::Classification->check($classification_name);
$products = $user->get_selectable_products($classification->id);
$vars->{'classification'} = $classification;
} else {
object => "products"});
if (Bugzilla->params->{'useclassification'}) {
- my $classification =
- Bugzilla::Classification::check_classification($classification_name);
+ my $classification = Bugzilla::Classification->check($classification_name);
$vars->{'classification'} = $classification;
}
$vars->{'token'} = issue_session_token('add_product');
if (Bugzilla->params->{'useclassification'}) {
$vars->{'classifications'} = $user->in_group('editcomponents') ?
- [Bugzilla::Classification::get_all_classifications] : $user->get_selectable_classifications;
+ [Bugzilla::Classification->get_all] : $user->get_selectable_classifications;
$template->process("admin/products/list-classifications.html.tmpl", $vars)
|| ThrowTemplateError($template->error());
projects / thirdparty / bugzilla.git / commitdiff
