1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
package FS::class_Common;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
=head1 NAME
FS::class_Common - Base class for classification classes
=head1 SYNOPSIS
use base qw( FS::class_Common );
use FS::category_table; #should use this
#required
sub _target_table { 'table_name'; }
#optional for non-standard names
sub _target_column { 'classnum'; } #default is classnum
sub _category_table { 'table_name'; } #default is to replace s/class/category/
=head1 DESCRIPTION
FS::class_Common is a base class for classes which provide a classification for
other classes, such as pkg_class or cust_class.
=head1 METHODS
=over 4
=item new HASHREF
Creates a new classification. To add the classfication to the database, see
L<"insert">.
=cut
=item insert
Adds this classification to the database. If there is an error, returns the
error, otherwise returns false.
=item delete
Deletes this classification from the database. Only classifications with no
associated target objects can be deleted. If there is an error, returns
the error, otherwise returns false.
=cut
sub delete {
my $self = shift;
return "Can't delete a ". $self->table.
" with ". $self->_target_table. " records!"
if qsearch( $self->_target_table,
{ $self->_target_column => $self->classnum }
);
$self->SUPER::delete;
}
=item replace OLD_RECORD
Replaces OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=item check
Checks all fields to make sure this is a valid classification. If
there is an error, returns the error, otherwise returns false. Called by the
insert and replace methods.
=cut
sub check {
my $self = shift;
$self->ut_numbern('classnum')
or $self->ut_text('classname')
or $self->ut_foreign_keyn( 'categorynum',
$self->_category_table,
'categorynum',
)
or $self->ut_enum('disabled', [ '', 'Y' ] )
or $self->SUPER::check;
}
=item category
Returns the category record associated with this class, or false if there is
none.
=cut
sub category {
my $self = shift;
qsearchs($self->_category_table, { 'categorynum' => $self->categorynum } );
}
=item categoryname
Returns the category name associated with this class, or false if there
is none.
=cut
sub categoryname {
my $category = shift->category;
$category ? $category->categoryname : '';
}
#required
sub _target_table {
my $self = shift;
die "_target_table unspecified for $self";
}
#defaults
sub _target_column { 'classnum'; }
use vars qw( %_category_table );
sub _category_table {
my $self = shift;
return $_category_table{ ref $self } ||= do {
my $category_table = $self->table;
$category_table =~ s/class/category/ # s/_class$/_category/
or die "can't determine an automatic category table for $category_table";
$category_table;
}
}
=head1 BUGS
=head1 SEE ALSO
L<FS::category_Common>, L<FS::pkg_class>, L<FS::cust_class>
=cut
1;
|
