3 <TITLE>FS::Record - Database record objects</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#constructors">CONSTRUCTORS</A></LI>
18 <LI><A HREF="#methods">METHODS</A></LI>
19 <LI><A HREF="#subroutines">SUBROUTINES</A></LI>
20 <LI><A HREF="#bugs">BUGS</A></LI>
21 <LI><A HREF="#see also">SEE ALSO</A></LI>
27 <H1><A NAME="name">NAME</A></H1>
28 <P>FS::Record - Database record objects</P>
31 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
34 use FS::Record qw(dbh fields qsearch qsearchs dbdef);</PRE>
36 $record = new FS::Record 'table', \%hash;
37 $record = new FS::Record 'table', { 'column' => 'value', ... };</PRE>
39 $record = qsearchs FS::Record 'table', \%hash;
40 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
41 @records = qsearch FS::Record 'table', \%hash;
42 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };</PRE>
44 $table = $record->table;
45 $dbdef_table = $record->dbdef_table;</PRE>
47 $value = $record->get('column');
48 $value = $record->getfield('column');
49 $value = $record->column;</PRE>
51 $record->set( 'column' => 'value' );
52 $record->setfield( 'column' => 'value' );
53 $record->column('value');</PRE>
55 %hash = $record->hash;</PRE>
57 $hashref = $record->hashref;</PRE>
59 $error = $record->insert;
60 #$error = $record->add; #depriciated</PRE>
62 $error = $record->delete;
63 #$error = $record->del; #depriciated</PRE>
65 $error = $new_record->replace($old_record);
66 #$error = $new_record->rep($old_record); #depriciated</PRE>
68 $value = $record->unique('column');</PRE>
70 $error = $record->ut_float('column');
71 $error = $record->ut_number('column');
72 $error = $record->ut_numbern('column');
73 $error = $record->ut_money('column');
74 $error = $record->ut_text('column');
75 $error = $record->ut_textn('column');
76 $error = $record->ut_alpha('column');
77 $error = $record->ut_alphan('column');
78 $error = $record->ut_phonen('column');
79 $error = $record->ut_anything('column');
80 $error = $record->ut_name('column');</PRE>
82 $dbdef = reload_dbdef;
83 $dbdef = reload_dbdef "/non/standard/filename";
86 $quoted_value = _quote($value,'table','field');</PRE>
89 $fields = hfields('table');
90 if ( $fields->{Field} ) { # etc.</PRE>
92 @fields = fields 'table'; #as a subroutine
93 @fields = $record->fields; #as a method call</PRE>
96 <H1><A NAME="description">DESCRIPTION</A></H1>
97 <P>(Mostly) object-oriented interface to database records. Records are currently
98 implemented on top of DBI. FS::Record is intended as a base class for
99 table-specific classes to inherit from, i.e. FS::cust_main.</P>
102 <H1><A NAME="constructors">CONSTRUCTORS</A></H1>
104 <DT><STRONG><A NAME="item_new_%5B_TABLE%2C_%5D_HASHREF">new [ TABLE, ] HASHREF</A></STRONG><BR>
106 Creates a new record. It doesn't store it in the database, though. See
107 <A HREF="#insert">insert</A> for that.
108 <P>Note that the object stores this hash reference, not a distinct copy of the
109 hash it points to. You can ask the object for a copy with the <EM>hash</EM>
111 <P>TABLE can only be omitted when a dervived class overrides the table method.</P>
113 <DT><STRONG><A NAME="item_qsearch_TABLE%2C_HASHREF%2C_SELECT%2C_EXTRA_SQL">qsearch TABLE, HASHREF, SELECT, EXTRA_SQL</A></STRONG><BR>
115 Searches the database for all records matching (at least) the key/value pairs
116 in HASHREF. Returns all the records found as `FS::TABLE' objects if that
117 module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record
119 <P>###oops, argh, FS::Record::new only lets us create database fields.
120 #Normal behaviour if SELECT is not specified is `*', as in
121 #<CODE>SELECT * FROM table WHERE ...</CODE>. However, there is an experimental new
122 #feature where you can specify SELECT - remember, the objects returned,
123 #although blessed into the appropriate `FS::TABLE' package, will only have the
124 #fields you specify. This might have unwanted results if you then go calling
125 #regular FS::TABLE methods
128 <DT><STRONG><A NAME="item_jsearch_TABLE%2C_HASHREF%2C_SELECT%2C_EXTRA_SQL%2C">jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY</A></STRONG><BR>
130 Experimental JOINed search method. Using this method, you can execute a
131 single SELECT spanning multiple tables, and cache the results for subsequent
132 method calls. Interface will almost definately change in an incompatible
136 <DT><STRONG><A NAME="item_qsearchs">qsearchs TABLE, HASHREF</A></STRONG><BR>
138 Same as qsearch, except that if more than one record matches, it <STRONG>carp</STRONG>s but
139 returns the first. If this happens, you either made a logic error in asking
140 for a single item, or your data is corrupted.
144 <H1><A NAME="methods">METHODS</A></H1>
146 <DT><STRONG><A NAME="item_table">table</A></STRONG><BR>
148 Returns the table name.
150 <DT><STRONG><A NAME="item_dbdef_table">dbdef_table</A></STRONG><BR>
152 Returns the FS::dbdef_table object for the table.
154 <DT><STRONG><A NAME="item_get%2C_getfield_COLUMN">get, getfield COLUMN</A></STRONG><BR>
156 Returns the value of the column/field/key COLUMN.
158 <DT><STRONG><A NAME="item_set%2C_setfield_COLUMN%2C_VALUE">set, setfield COLUMN, VALUE</A></STRONG><BR>
160 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
162 <DT><STRONG><A NAME="item_AUTLOADED_METHODS">AUTLOADED METHODS</A></STRONG><BR>
164 $record->column is a synonym for $record->get('column');
165 <P>$record-><CODE>column('value')</CODE> is a synonym for $record->set('column','value');</P>
167 <DT><STRONG><A NAME="item_hash">hash</A></STRONG><BR>
169 Returns a list of the column/value pairs, usually for assigning to a new hash.
170 <P>To make a distinct duplicate of an FS::Record object, you can do:</P>
172 $new = new FS::Record ( $old->table, { $old->hash } );</PRE>
174 <DT><STRONG><A NAME="item_hashref">hashref</A></STRONG><BR>
176 Returns a reference to the column/value hash.
178 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
180 Inserts this record to the database. If there is an error, returns the error,
181 otherwise returns false.
183 <DT><STRONG><A NAME="item_add">add</A></STRONG><BR>
185 Depriciated (use insert instead).
187 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
189 Delete this record from the database. If there is an error, returns the error,
190 otherwise returns false.
192 <DT><STRONG><A NAME="item_del">del</A></STRONG><BR>
194 Depriciated (use delete instead).
196 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
198 Replace the OLD_RECORD with this one in the database. If there is an error,
199 returns the error, otherwise returns false.
201 <DT><STRONG><A NAME="item_rep">rep</A></STRONG><BR>
203 Depriciated (use replace instead).
205 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
207 Not yet implemented, croaks. Derived classes should provide a check method.
209 <DT><STRONG><A NAME="item_unique">unique COLUMN</A></STRONG><BR>
211 Replaces COLUMN in record with a unique number. Called by the <STRONG>add</STRONG> method
212 on primary keys and single-field unique columns (see <A HREF="../DBIx/DBSchema/Table.html">the DBIx::DBSchema::Table manpage</A>).
213 Returns the new value.
215 <DT><STRONG><A NAME="item_ut_float_COLUMN">ut_float COLUMN</A></STRONG><BR>
217 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
218 null. If there is an error, returns the error, otherwise returns false.
220 <DT><STRONG><A NAME="item_ut_number_COLUMN">ut_number COLUMN</A></STRONG><BR>
222 Check/untaint simple numeric data (whole numbers). May not be null. If there
223 is an error, returns the error, otherwise returns false.
225 <DT><STRONG><A NAME="item_ut_numbern_COLUMN">ut_numbern COLUMN</A></STRONG><BR>
227 Check/untaint simple numeric data (whole numbers). May be null. If there is
228 an error, returns the error, otherwise returns false.
230 <DT><STRONG><A NAME="item_ut_money_COLUMN">ut_money COLUMN</A></STRONG><BR>
232 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
233 is an error, returns the error, otherwise returns false.
235 <DT><STRONG><A NAME="item_ut_text_COLUMN">ut_text COLUMN</A></STRONG><BR>
237 Check/untaint text. Alphanumerics, spaces, and the following punctuation
238 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? /
239 May not be null. If there is an error, returns the error, otherwise returns
242 <DT><STRONG><A NAME="item_ut_textn_COLUMN">ut_textn COLUMN</A></STRONG><BR>
244 Check/untaint text. Alphanumerics, spaces, and the following punctuation
245 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? /
246 May be null. If there is an error, returns the error, otherwise returns false.
248 <DT><STRONG><A NAME="item_ut_alpha_COLUMN">ut_alpha COLUMN</A></STRONG><BR>
250 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
251 an error, returns the error, otherwise returns false.
253 <DT><STRONG>ut_alpha COLUMN</STRONG><BR>
255 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
256 error, returns the error, otherwise returns false.
258 <DT><STRONG><A NAME="item_ut_phonen_COLUMN_%5B_COUNTRY_%5D">ut_phonen COLUMN [ COUNTRY ]</A></STRONG><BR>
260 Check/untaint phone numbers. May be null. If there is an error, returns
261 the error, otherwise returns false.
262 <P>Takes an optional two-letter ISO country code; without it or with unsupported
263 countries, ut_phonen simply calls ut_alphan.</P>
265 <DT><STRONG><A NAME="item_ut_ip_COLUMN">ut_ip COLUMN</A></STRONG><BR>
267 Check/untaint ip addresses. IPv4 only for now.
269 <DT><STRONG><A NAME="item_ut_ipn_COLUMN">ut_ipn COLUMN</A></STRONG><BR>
271 Check/untaint ip addresses. IPv4 only for now. May be null.
273 <DT><STRONG><A NAME="item_ut_domain_COLUMN">ut_domain COLUMN</A></STRONG><BR>
275 Check/untaint host and domain names.
277 <DT><STRONG><A NAME="item_ut_name_COLUMN">ut_name COLUMN</A></STRONG><BR>
279 Check/untaint proper names; allows alphanumerics, spaces and the following
281 <P>May not be null.</P>
283 <DT><STRONG><A NAME="item_ut_zip_COLUMN">ut_zip COLUMN</A></STRONG><BR>
285 Check/untaint zip codes.
287 <DT><STRONG><A NAME="item_ut_country_COLUMN">ut_country COLUMN</A></STRONG><BR>
289 Check/untaint country codes. Country names are changed to codes, if possible -
290 see <A HREF="../Locale/Country.html">the Locale::Country manpage</A>.
292 <DT><STRONG><A NAME="item_ut_anything_COLUMN">ut_anything COLUMN</A></STRONG><BR>
294 Untaints arbitrary data. Be careful.
296 <DT><STRONG><A NAME="item_ut_enum_COLUMN_CHOICES_ARRAYREF">ut_enum COLUMN CHOICES_ARRAYREF</A></STRONG><BR>
298 Check/untaint a column, supplying all possible choices, like the ``enum'' type.
300 <DT><STRONG><A NAME="item_fields_%5B_TABLE_%5D">fields [ TABLE ]</A></STRONG><BR>
302 This can be used as both a subroutine and a method call. It returns a list
303 of the columns in this record's table, or an explicitly specified table.
304 (See <A HREF="../DBIx/DBSchema/Table.html">the DBIx::DBSchema::Table manpage</A>).
308 <H1><A NAME="subroutines">SUBROUTINES</A></H1>
310 <DT><STRONG><A NAME="item_reload_dbdef"><CODE>reload_dbdef([FILENAME])</CODE></A></STRONG><BR>
312 Load a database definition (see <A HREF="../DBIx/DBSchema.html">the DBIx::DBSchema manpage</A>), optionally from a
313 non-default filename. This command is executed at startup unless
314 <EM>$FS::Record::setup_hack</EM> is true. Returns a DBIx::DBSchema object.
316 <DT><STRONG><A NAME="item_dbdef">dbdef</A></STRONG><BR>
318 Returns the current database definition. See <A HREF="../FS/dbdef.html">the FS::dbdef manpage</A>.
320 <DT><STRONG><A NAME="item__quote_VALUE%2C_TABLE%2C_COLUMN">_quote VALUE, TABLE, COLUMN</A></STRONG><BR>
322 This is an internal function used to construct SQL statements. It returns
323 VALUE DBI-quoted (see <EM>DBI/``quote''</EM>) unless VALUE is a number and the column
324 type (see <A HREF="../FS/dbdef_column.html">the FS::dbdef_column manpage</A>) does not end in `char' or `binary'.
326 <DT><STRONG><A NAME="item_hfields">hfields TABLE</A></STRONG><BR>
328 This is depriciated. Don't use it.
329 <P>It returns a hash-type list with the fields of this record's table set true.</P>
333 <H1><A NAME="bugs">BUGS</A></H1>
334 <P>This module should probably be renamed, since much of the functionality is
335 of general use. It is not completely unlike Adapter::DBI (see below).</P>
336 <P>Exported qsearch and qsearchs should be depriciated in favor of method calls
337 (against an FS::Record object like the old search and searchs that qsearch
338 and qsearchs were on top of.)</P>
339 <P>The whole fields / hfields mess should be removed.</P>
340 <P>The various WHERE clauses should be subroutined.</P>
341 <P>table string should be depriciated in favor of FS::dbdef_table.</P>
342 <P>No doubt we could benefit from a Tied hash. Documenting how exists / defined
343 true maps to the database (and WHERE clauses) would also help.</P>
344 <P>The ut_ methods should ask the dbdef for a default length.</P>
345 <P>ut_sqltype (like ut_varchar) should all be defined</P>
346 <P>A fallback check method should be provided which uses the dbdef.</P>
347 <P>The ut_money method assumes money has two decimal digits.</P>
348 <P>The Pg money kludge in the new method only strips `$'.</P>
349 <P>The ut_phonen method only checks US-style phone numbers.</P>
350 <P>The _quote function should probably use ut_float instead of a regex.</P>
351 <P>All the subroutines probably should be methods, here or elsewhere.</P>
352 <P>Probably should borrow/use some dbdef methods where appropriate (like sub
354 <P>As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
355 or allow it to be set. Working around it is ugly any way around - DBI should
356 be fixed. (only affects RDBMS which return uppercase column names)</P>
357 <P>ut_zip should take an optional country like ut_phone.</P>
360 <H1><A NAME="see also">SEE ALSO</A></H1>
361 <P><A HREF="../DBIx/DBSchema.html">the DBIx::DBSchema manpage</A>, <A HREF=".././FS/UID.html">the FS::UID manpage</A>, <EM>DBI</EM></P>
362 <P>Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.</P>