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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
package FS::svc_table;
use strict;
use base qw( FS::svc_Common );
#use FS::Record qw( qsearch qsearchs );
use FS::cust_svc;
=head1 NAME
FS::table_name - Object methods for table_name records
=head1 SYNOPSIS
use FS::table_name;
$record = new FS::table_name \%hash;
$record = new FS::table_name { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
$error = $record->suspend;
$error = $record->unsuspend;
$error = $record->cancel;
=head1 DESCRIPTION
An FS::table_name object represents an example. FS::table_name inherits from
FS::svc_Common. The following fields are currently supported:
=over 4
=item field - description
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new example. To add the example to the database, see L<"insert">.
Note that this stores the hash reference, not a distinct copy of the hash it
points to. You can ask the object for a copy with the I<hash> method.
=cut
sub table { 'table_name'; }
sub table_info {
{
'name' => 'Example',
'name_plural' => 'Example services', #optional,
'longname_plural' => 'Example services', #optional
'sorts' => 'svcnum', # optional sort field (or arrayref of sort fields, main first)
'display_weight' => 100,
'cancel_weight' => 100,
'fields' => {
'field' => 'Description',
'another_field' => {
'label' => 'Description',
'def_label' => 'Description for service definitions',
'type' => 'text',
'disable_default' => 1, #disable switches
'disable_fixed' => 1, #
'disable_inventory' => 1, #
'disable_select' => 1, #
},
'foreign_key' => {
'label' => 'Description',
'def_label' => 'Description for service defs',
'type' => 'select',
'select_table' => 'foreign_table',
'select_key' => 'key_field_in_table',
'select_label' => 'label_field_in_table',
},
},
};
}
=item search_sql STRING
Class method which returns an SQL fragment to search for the given string.
=cut
#or something more complicated if necessary
sub search_sql {
my($class, $string) = @_;
$class->search_sql_field('search_field', $string);
}
=item label
Returns a meaningful identifier for this example
=cut
sub label {
my $self = shift;
$self->label_field; #or something more complicated if necessary
}
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
defined. An FS::cust_svc record will be created and inserted.
=cut
sub insert {
my $self = shift;
my $error;
$error = $self->SUPER::insert;
return $error if $error;
'';
}
=item delete
Delete this record from the database.
=cut
sub delete {
my $self = shift;
my $error;
$error = $self->SUPER::delete;
return $error if $error;
'';
}
=item replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
sub replace {
my ( $new, $old ) = ( shift, shift );
my $error;
$error = $new->SUPER::replace($old);
return $error if $error;
'';
}
=item suspend
Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
=item unsuspend
Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
=item cancel
Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and repalce methods.
=cut
sub check {
my $self = shift;
my $x = $self->setfixed;
return $x unless ref($x);
my $part_svc = $x;
$self->SUPER::check;
}
=back
=head1 BUGS
The author forgot to customize this manpage.
=head1 SEE ALSO
L<FS::svc_Common>, L<FS::Record>, L<FS::cust_svc>, L<FS::part_svc>,
L<FS::cust_pkg>, schema.html from the base documentation.
=cut
1;
|
