fix payment lookup when revoking batch payments, #18548 and #21117
[freeside.git] / FS / FS / access_user_pref.pm
1 package FS::access_user_pref;
2
3 use strict;
4 use vars qw( @ISA );
5 use FS::Record qw( qsearch qsearchs );
6
7 @ISA = qw(FS::Record);
8
9 =head1 NAME
10
11 FS::access_user_pref - Object methods for access_user_pref records
12
13 =head1 SYNOPSIS
14
15   use FS::access_user_pref;
16
17   $record = new FS::access_user_pref \%hash;
18   $record = new FS::access_user_pref { 'column' => 'value' };
19
20   $error = $record->insert;
21
22   $error = $new_record->replace($old_record);
23
24   $error = $record->delete;
25
26   $error = $record->check;
27
28 =head1 DESCRIPTION
29
30 An FS::access_user_pref object represents an per-user preference.  Preferenaces
31 are also used to store transient state information (server-side "cookies").
32 FS::access_user_pref inherits from FS::Record.  The following fields are
33 currently supported:
34
35 =over 4
36
37 =item prefnum - primary key
38
39 =item usernum - Internal access user (see L<FS::access_user>)
40
41 =item prefname - 
42
43 =item prefvalue - 
44
45 =item expiration - 
46
47 =back
48
49 =head1 METHODS
50
51 =over 4
52
53 =item new HASHREF
54
55 Creates a new preference.  To add the preference to the database, see L<"insert">.
56
57 Note that this stores the hash reference, not a distinct copy of the hash it
58 points to.  You can ask the object for a copy with the I<hash> method.
59
60 =cut
61
62 # the new method can be inherited from FS::Record, if a table method is defined
63
64 sub table { 'access_user_pref'; }
65
66 =item insert
67
68 Adds this record to the database.  If there is an error, returns the error,
69 otherwise returns false.
70
71 =cut
72
73 # the insert method can be inherited from FS::Record
74
75 =item delete
76
77 Delete this record from the database.
78
79 =cut
80
81 # the delete method can be inherited from FS::Record
82
83 =item replace OLD_RECORD
84
85 Replaces the OLD_RECORD with this one in the database.  If there is an error,
86 returns the error, otherwise returns false.
87
88 =cut
89
90 # the replace method can be inherited from FS::Record
91
92 =item check
93
94 Checks all fields to make sure this is a valid preference.  If there is
95 an error, returns the error, otherwise returns false.  Called by the insert
96 and replace methods.
97
98 =cut
99
100 # the check method should currently be supplied - FS::Record contains some
101 # data checking routines
102
103 sub check {
104   my $self = shift;
105
106   my $error = 
107     $self->ut_numbern('prefnum')
108     || $self->ut_number('usernum')
109     || $self->ut_text('prefname')
110     #|| $self->ut_textn('prefvalue')
111     || $self->ut_anything('prefvalue')
112   ;
113   return $error if $error;
114
115   $self->SUPER::check;
116 }
117
118 =back
119
120 =head1 BUGS
121
122 =head1 SEE ALSO
123
124 L<FS::access_user>, L<FS::Record>, schema.html from the base documentation.
125
126 =cut
127
128 1;
129