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
|
package FS::part_virtual_field;
use base qw(FS::Record);
use strict;
use HTML::Entities;
use FS::Schema qw( dbdef );
=head1 NAME
FS::part_virtual_field - Object methods for part_virtual_field records
=head1 SYNOPSIS
use FS::part_virtual_field;
$record = new FS::part_virtual_field \%hash;
$record = new FS::part_virtual_field { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::part_virtual_field object represents the definition of a custom field
(see the BACKGROUND section). FS::part_virtual_field contains the name and
base table of the field.
FS::part_virtual_field inherits from FS::Record. The following fields are
currently supported:
=over 2
=item vfieldpart - primary key (assigned automatically)
=item name - name of the field
=item dbtable - table for which this virtual field is defined
=item length - expected length of the value (UI hint)
=item label - descriptive label for the field (UI hint)
=back
=head1 METHODS
=over 4
=item new HASHREF
Create a new record. To add the record to the database, see "insert".
=cut
sub table { 'part_virtual_field'; }
sub virtual_fields { () }
sub virtual_fields_hash { () }
=item widget UI_TYPE MODE [ VALUE ]
Generates UI code for a widget suitable for editing/viewing the field, based on
list_source and length.
The only UI_TYPE currently supported is 'HTML', and possible MODEs are 'view'
and 'edit'.
In HTML, all widgets are assumed to be table rows. View widgets look like
<TR><TD ALIGN="right">Label</TD><TD BGCOLOR="#ffffff">Value</TD></TR>
(Most of the display style stuff, such as the colors, should probably go into
a separate module specific to the UI. That can wait, though. The API for
this function won't change.)
VALUE (optional) is the current value of the field.
=cut
sub widget {
my $self = shift;
my ($ui_type, $mode, $value, $header_col_type) = @_;
$header_col_type = 'TD' unless $header_col_type;
my $text;
my $label = $self->label || $self->name;
if ($ui_type eq 'HTML') {
if ($mode eq 'view') {
$text = q!<TR><!.$header_col_type.q! ALIGN="right">! . encode_entities($label) .
q!</!.$header_col_type.q!><TD BGCOLOR="#ffffff">! . encode_entities($value) .
q!</TD></TR>! . "\n";
} elsif ($mode eq 'edit') {
$text = q!<TR><!.$header_col_type.q! ALIGN="right">! . encode_entities($label) .
q!</!.$header_col_type.q!><TD>!;
$text .= q!<INPUT TYPE=text NAME="! . $self->name .
q!" VALUE="! . encode_entities($value) . q!"!;
if ($self->length) {
$text .= q! SIZE="! . $self->length . q!"!;
}
$text .= '>';
$text .= q!</TD></TR>! . "\n";
} else {
return '';
}
} else {
return '';
}
return $text;
}
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Deletes this record from the database. If there is an error, returns the
error, otherwise returns false.
=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
If there is an error, returns the error, otherwise returns false.
Called by the insert and replace methods.
=back
=cut
sub check {
my $self = shift;
my $error = $self->ut_text('name') ||
$self->ut_text('dbtable') ||
$self->ut_number('length')
;
return $error if $error;
# Make sure it's a real table with a numeric primary key
my ($table, $pkey);
if($table = dbdef->table($self->dbtable)) {
if($pkey = $table->primary_key) {
if($table->column($pkey)->type =~ /int/i) {
# this is what it should be
} else {
$error = "$table.$pkey is not an integer";
}
} else {
$error = "$table does not have a single-field primary key";
}
} else {
$error = "$table does not exist in the schema";
}
return $error if $error;
$self->SUPER::check;
}
=head1 NOTES
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>
=cut
1;
|
