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="#version">VERSION</A></LI>
21 <LI><A HREF="#bugs">BUGS</A></LI>
22 <LI><A HREF="#see also">SEE ALSO</A></LI>
28 <H1><A NAME="name">NAME</A></H1>
29 <P>FS::Record - Database record objects</P>
32 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
35 use FS::Record qw(dbh fields qsearch qsearchs dbdef);</PRE>
37 $record = new FS::Record 'table', \%hash;
38 $record = new FS::Record 'table', { 'column' => 'value', ... };</PRE>
40 $record = qsearchs FS::Record 'table', \%hash;
41 $record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
42 @records = qsearch FS::Record 'table', \%hash;
43 @records = qsearch FS::Record 'table', { 'column' => 'value', ... };</PRE>
45 $table = $record->table;
46 $dbdef_table = $record->dbdef_table;</PRE>
48 $value = $record->get('column');
49 $value = $record->getfield('column');
50 $value = $record->column;</PRE>
52 $record->set( 'column' => 'value' );
53 $record->setfield( 'column' => 'value' );
54 $record->column('value');</PRE>
56 %hash = $record->hash;</PRE>
58 $hashref = $record->hashref;</PRE>
60 $error = $record->insert;
61 #$error = $record->add; #depriciated</PRE>
63 $error = $record->delete;
64 #$error = $record->del; #depriciated</PRE>
66 $error = $new_record->replace($old_record);
67 #$error = $new_record->rep($old_record); #depriciated</PRE>
69 $value = $record->unique('column');</PRE>
71 $value = $record->ut_float('column');
72 $value = $record->ut_number('column');
73 $value = $record->ut_numbern('column');
74 $value = $record->ut_money('column');
75 $value = $record->ut_text('column');
76 $value = $record->ut_textn('column');
77 $value = $record->ut_alpha('column');
78 $value = $record->ut_alphan('column');
79 $value = $record->ut_phonen('column');
80 $value = $record->ut_anythingn('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_qsearchs">qsearchs TABLE, HASHREF</A></STRONG><BR>
130 Same as qsearch, except that if more than one record matches, it <STRONG>carp</STRONG>s but
131 returns the first. If this happens, you either made a logic error in asking
132 for a single item, or your data is corrupted.
136 <H1><A NAME="methods">METHODS</A></H1>
138 <DT><STRONG><A NAME="item_table">table</A></STRONG><BR>
140 Returns the table name.
142 <DT><STRONG><A NAME="item_dbdef_table">dbdef_table</A></STRONG><BR>
144 Returns the FS::dbdef_table object for the table.
146 <DT><STRONG><A NAME="item_get%2C_getfield_COLUMN">get, getfield COLUMN</A></STRONG><BR>
148 Returns the value of the column/field/key COLUMN.
150 <DT><STRONG><A NAME="item_set%2C_setfield_COLUMN%2C_VALUE">set, setfield COLUMN, VALUE</A></STRONG><BR>
152 Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
154 <DT><STRONG><A NAME="item_AUTLOADED_METHODS">AUTLOADED METHODS</A></STRONG><BR>
156 $record->column is a synonym for $record->get('column');
157 <P>$record-><CODE>column('value')</CODE> is a synonym for $record->set('column','value');</P>
159 <DT><STRONG><A NAME="item_hash">hash</A></STRONG><BR>
161 Returns a list of the column/value pairs, usually for assigning to a new hash.
162 <P>To make a distinct duplicate of an FS::Record object, you can do:</P>
164 $new = new FS::Record ( $old->table, { $old->hash } );</PRE>
166 <DT><STRONG><A NAME="item_hashref">hashref</A></STRONG><BR>
168 Returns a reference to the column/value hash.
170 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
172 Inserts this record to the database. If there is an error, returns the error,
173 otherwise returns false.
175 <DT><STRONG><A NAME="item_add">add</A></STRONG><BR>
177 Depriciated (use insert instead).
179 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
181 Delete this record from the database. If there is an error, returns the error,
182 otherwise returns false.
184 <DT><STRONG><A NAME="item_del">del</A></STRONG><BR>
186 Depriciated (use delete instead).
188 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
190 Replace the OLD_RECORD with this one in the database. If there is an error,
191 returns the error, otherwise returns false.
193 <DT><STRONG><A NAME="item_rep">rep</A></STRONG><BR>
195 Depriciated (use replace instead).
197 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
199 Not yet implemented, croaks. Derived classes should provide a check method.
201 <DT><STRONG><A NAME="item_unique">unique COLUMN</A></STRONG><BR>
203 Replaces COLUMN in record with a unique number. Called by the <STRONG>add</STRONG> method
204 on primary keys and single-field unique columns (see <A HREF="../DBIx/DBSchema/Table.html">the DBIx::DBSchema::Table manpage</A>).
205 Returns the new value.
207 <DT><STRONG><A NAME="item_ut_float_COLUMN">ut_float COLUMN</A></STRONG><BR>
209 Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be
210 null. If there is an error, returns the error, otherwise returns false.
212 <DT><STRONG><A NAME="item_ut_number_COLUMN">ut_number COLUMN</A></STRONG><BR>
214 Check/untaint simple numeric data (whole numbers). May not be null. If there
215 is an error, returns the error, otherwise returns false.
217 <DT><STRONG><A NAME="item_ut_numbern_COLUMN">ut_numbern COLUMN</A></STRONG><BR>
219 Check/untaint simple numeric data (whole numbers). May be null. If there is
220 an error, returns the error, otherwise returns false.
222 <DT><STRONG><A NAME="item_ut_money_COLUMN">ut_money COLUMN</A></STRONG><BR>
224 Check/untaint monetary numbers. May be negative. Set to 0 if null. If there
225 is an error, returns the error, otherwise returns false.
227 <DT><STRONG><A NAME="item_ut_text_COLUMN">ut_text COLUMN</A></STRONG><BR>
229 Check/untaint text. Alphanumerics, spaces, and the following punctuation
230 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? /
231 May not be null. If there is an error, returns the error, otherwise returns
234 <DT><STRONG><A NAME="item_ut_textn_COLUMN">ut_textn COLUMN</A></STRONG><BR>
236 Check/untaint text. Alphanumerics, spaces, and the following punctuation
237 symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? /
238 May be null. If there is an error, returns the error, otherwise returns false.
240 <DT><STRONG><A NAME="item_ut_alpha_COLUMN">ut_alpha COLUMN</A></STRONG><BR>
242 Check/untaint alphanumeric strings (no spaces). May not be null. If there is
243 an error, returns the error, otherwise returns false.
245 <DT><STRONG>ut_alpha COLUMN</STRONG><BR>
247 Check/untaint alphanumeric strings (no spaces). May be null. If there is an
248 error, returns the error, otherwise returns false.
250 <DT><STRONG><A NAME="item_ut_phonen_COLUMN_%5B_COUNTRY_%5D">ut_phonen COLUMN [ COUNTRY ]</A></STRONG><BR>
252 Check/untaint phone numbers. May be null. If there is an error, returns
253 the error, otherwise returns false.
254 <P>Takes an optional two-letter ISO country code; without it or with unsupported
255 countries, ut_phonen simply calls ut_alphan.</P>
257 <DT><STRONG><A NAME="item_ut_ip_COLUMN">ut_ip COLUMN</A></STRONG><BR>
259 Check/untaint ip addresses. IPv4 only for now.
261 <DT><STRONG><A NAME="item_ut_ipn_COLUMN">ut_ipn COLUMN</A></STRONG><BR>
263 Check/untaint ip addresses. IPv4 only for now. May be null.
265 <DT><STRONG><A NAME="item_ut_domain_COLUMN">ut_domain COLUMN</A></STRONG><BR>
267 Check/untaint host and domain names.
269 <DT><STRONG><A NAME="item_ut_anything_COLUMN">ut_anything COLUMN</A></STRONG><BR>
271 Untaints arbitrary data. Be careful.
273 <DT><STRONG><A NAME="item_fields_%5B_TABLE_%5D">fields [ TABLE ]</A></STRONG><BR>
275 This can be used as both a subroutine and a method call. It returns a list
276 of the columns in this record's table, or an explicitly specified table.
277 (See <A HREF="../DBIx/DBSchema/Table.html">the DBIx::DBSchema::Table manpage</A>).
281 <H1><A NAME="subroutines">SUBROUTINES</A></H1>
283 <DT><STRONG><A NAME="item_reload_dbdef"><CODE>reload_dbdef([FILENAME])</CODE></A></STRONG><BR>
285 Load a database definition (see <A HREF="../DBIx/DBSchema.html">the DBIx::DBSchema manpage</A>), optionally from a
286 non-default filename. This command is executed at startup unless
287 <EM>$FS::Record::setup_hack</EM> is true. Returns a DBIx::DBSchema object.
289 <DT><STRONG><A NAME="item_dbdef">dbdef</A></STRONG><BR>
291 Returns the current database definition. See <A HREF="../FS/dbdef.html">the FS::dbdef manpage</A>.
293 <DT><STRONG><A NAME="item__quote_VALUE%2C_TABLE%2C_COLUMN">_quote VALUE, TABLE, COLUMN</A></STRONG><BR>
295 This is an internal function used to construct SQL statements. It returns
296 VALUE DBI-quoted (see <EM>DBI/``quote''</EM>) unless VALUE is a number and the column
297 type (see <A HREF="../FS/dbdef_column.html">the FS::dbdef_column manpage</A>) does not end in `char' or `binary'.
299 <DT><STRONG><A NAME="item_hfields">hfields TABLE</A></STRONG><BR>
301 This is depriciated. Don't use it.
302 <P>It returns a hash-type list with the fields of this record's table set true.</P>
306 <H1><A NAME="version">VERSION</A></H1>
307 <P>$Id: Record.html,v 1.3 2001-04-23 12:40:30 ivan Exp $</P>
310 <H1><A NAME="bugs">BUGS</A></H1>
311 <P>This module should probably be renamed, since much of the functionality is
312 of general use. It is not completely unlike Adapter::DBI (see below).</P>
313 <P>Exported qsearch and qsearchs should be depriciated in favor of method calls
314 (against an FS::Record object like the old search and searchs that qsearch
315 and qsearchs were on top of.)</P>
316 <P>The whole fields / hfields mess should be removed.</P>
317 <P>The various WHERE clauses should be subroutined.</P>
318 <P>table string should be depriciated in favor of FS::dbdef_table.</P>
319 <P>No doubt we could benefit from a Tied hash. Documenting how exists / defined
320 true maps to the database (and WHERE clauses) would also help.</P>
321 <P>The ut_ methods should ask the dbdef for a default length.</P>
322 <P>ut_sqltype (like ut_varchar) should all be defined</P>
323 <P>A fallback check method should be provided which uses the dbdef.</P>
324 <P>The ut_money method assumes money has two decimal digits.</P>
325 <P>The Pg money kludge in the new method only strips `$'.</P>
326 <P>The ut_phonen method assumes US-style phone numbers.</P>
327 <P>The _quote function should probably use ut_float instead of a regex.</P>
328 <P>All the subroutines probably should be methods, here or elsewhere.</P>
329 <P>Probably should borrow/use some dbdef methods where appropriate (like sub
331 <P>As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
332 or allow it to be set. Working around it is ugly any way around - DBI should
333 be fixed. (only affects RDBMS which return uppercase column names)</P>
336 <H1><A NAME="see also">SEE ALSO</A></H1>
337 <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>
338 <P>Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.</P>