FS::Record - Database record objects
use FS::Record;
use FS::Record qw(dbh fields qsearch qsearchs dbdef);
$record = new FS::Record 'table', \%hash;
$record = new FS::Record 'table', { 'column' => 'value', ... };
$record = qsearchs FS::Record 'table', \%hash;
$record = qsearchs FS::Record 'table', { 'column' => 'value', ... };
@records = qsearch FS::Record 'table', \%hash;
@records = qsearch FS::Record 'table', { 'column' => 'value', ... };
$table = $record->table;
$dbdef_table = $record->dbdef_table;
$value = $record->get('column');
$value = $record->getfield('column');
$value = $record->column;
$record->set( 'column' => 'value' );
$record->setfield( 'column' => 'value' );
$record->column('value');
%hash = $record->hash;
$hashref = $record->hashref;
$error = $record->insert;
#$error = $record->add; #depriciated
$error = $record->delete;
#$error = $record->del; #depriciated
$error = $new_record->replace($old_record);
#$error = $new_record->rep($old_record); #depriciated
$value = $record->unique('column');
$value = $record->ut_float('column');
$value = $record->ut_number('column');
$value = $record->ut_numbern('column');
$value = $record->ut_money('column');
$value = $record->ut_text('column');
$value = $record->ut_textn('column');
$value = $record->ut_alpha('column');
$value = $record->ut_alphan('column');
$value = $record->ut_phonen('column');
$value = $record->ut_anythingn('column');
$dbdef = reload_dbdef;
$dbdef = reload_dbdef "/non/standard/filename";
$dbdef = dbdef;
$quoted_value = _quote($value,'table','field');
#depriciated
$fields = hfields('table');
if ( $fields->{Field} ) { # etc.
@fields = fields 'table'; #as a subroutine
@fields = $record->fields; #as a method call
(Mostly) object-oriented interface to database records. Records are currently implemented on top of DBI. FS::Record is intended as a base class for table-specific classes to inherit from, i.e. FS::cust_main.
Creates a new record. It doesn't store it in the database, though. See insert for that.
Note that the object stores this hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
TABLE can only be omitted when a dervived class overrides the table method.
Searches the database for all records matching (at least) the key/value pairs in HASHREF. Returns all the records found as `FS::TABLE' objects if that module is loaded (i.e. via `use FS::cust_main;'), otherwise returns FS::Record objects.
Same as qsearch, except that if more than one record matches, it carps but returns the first. If this happens, you either made a logic error in asking for a single item, or your data is corrupted.
Returns the table name.
Returns the FS::dbdef_table object for the table.
Returns the value of the column/field/key COLUMN.
Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
$record->column is a synonym for $record->get('column');
$record->column('value') is a synonym for $record->set('column','value');
Returns a list of the column/value pairs, usually for assigning to a new hash.
To make a distinct duplicate of an FS::Record object, you can do:
$new = new FS::Record ( $old->table, { $old->hash } );
Returns a reference to the column/value hash.
Inserts this record to the database. If there is an error, returns the error, otherwise returns false.
Depriciated (use insert instead).
Delete this record from the database. If there is an error, returns the error, otherwise returns false.
Depriciated (use delete instead).
Replace the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Depriciated (use replace instead).
Not yet implemented, croaks. Derived classes should provide a check method.
Replaces COLUMN in record with a unique number. Called by the add method on primary keys and single-field unique columns (see FS::dbdef_table). Returns the new value.
Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May not be null. If there is an error, returns the error, otherwise returns false.
Check/untaint simple numeric data (whole numbers). May not be null. If there is an error, returns the error, otherwise returns false.
Check/untaint simple numeric data (whole numbers). May be null. If there is an error, returns the error, otherwise returns false.
Check/untaint monetary numbers. May be negative. Set to 0 if null. If there is an error, returns the error, otherwise returns false.
Check/untaint text. Alphanumerics, spaces, and the following punctuation symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / May not be null. If there is an error, returns the error, otherwise returns false.
Check/untaint text. Alphanumerics, spaces, and the following punctuation symbols are currently permitted: ! @ # $ % & ( ) - + ; : ' `` , . ? / May be null. If there is an error, returns the error, otherwise returns false.
Check/untaint alphanumeric strings (no spaces). May not be null. If there is an error, returns the error, otherwise returns false.
Check/untaint alphanumeric strings (no spaces). May be null. If there is an error, returns the error, otherwise returns false.
Check/untaint phone numbers. May be null. If there is an error, returns the error, otherwise returns false.
Untaints arbitrary data. Be careful.
This can be used as both a subroutine and a method call. It returns a list of the columns in this record's table, or an explicitly specified table. (See FS::dbdef_table).
Load a database definition (see FS::dbdef), optionally from a non-default filename. This command is executed at startup unless $FS::Record::setup_hack is true. Returns a FS::dbdef object.
Returns the current database definition. See FS::dbdef.
This is an internal function used to construct SQL statements. It returns VALUE DBI-quoted (see DBI) unless VALUE is a number and the column type (see FS::dbdef_column) does not end in `char' or `binary'.
This is depriciated. Don't use it.
It returns a hash-type list with the fields of this record's table set true.
$Id: Record.html,v 1.2 2000-03-03 18:22:42 ivan Exp $
This module should probably be renamed, since much of the functionality is of general use. It is not completely unlike Adapter::DBI (see below).
Exported qsearch and qsearchs should be depriciated in favor of method calls (against an FS::Record object like the old search and searchs that qsearch and qsearchs were on top of.)
The whole fields / hfields mess should be removed.
The various WHERE clauses should be subroutined.
table string should be depriciated in favor of FS::dbdef_table.
No doubt we could benefit from a Tied hash. Documenting how exists / defined true maps to the database (and WHERE clauses) would also help.
The ut_ methods should ask the dbdef for a default length.
ut_sqltype (like ut_varchar) should all be defined
A fallback check method should be provided whith uses the dbdef.
The ut_money method assumes money has two decimal digits.
The Pg money kludge in the new method only strips `$'.
The ut_phonen method assumes US-style phone numbers.
The _quote function should probably use ut_float instead of a regex.
All the subroutines probably should be methods, here or elsewhere.
Probably should borrow/use some dbdef methods where appropriate (like sub fields)
Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.