Freeside:1.9:Documentation:Developer/FS/Record

From Freeside
< Freeside:1.9:Documentation:Developer‎ | FS
Revision as of 15:51, 3 October 2007 by Ivan (talk | contribs) (import from POD)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::Record - Database record objects

SYNOPSIS

   use FS::Record;
   use FS::Record qw(dbh fields qsearch qsearchs);

   $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->delete;

   $error = $new_record->replace($old_record);

   # external use deprecated - handled by the database (at least for Pg, mysql)
   $value = $record->unique('column');

   $error = $record->ut_float('column');
   $error = $record->ut_floatn('column');
   $error = $record->ut_number('column');
   $error = $record->ut_numbern('column');
   $error = $record->ut_snumber('column');
   $error = $record->ut_snumbern('column');
   $error = $record->ut_money('column');
   $error = $record->ut_text('column');
   $error = $record->ut_textn('column');
   $error = $record->ut_alpha('column');
   $error = $record->ut_alphan('column');
   $error = $record->ut_phonen('column');
   $error = $record->ut_anything('column');
   $error = $record->ut_name('column');

   $quoted_value = _quote($value,'table','field');

   #deprecated
   $fields = hfields('table');
   if ( $fields->{Field} ) { # etc.

   @fields = fields 'table'; #as a subroutine
   @fields = $record->fields; #as a method call

DESCRIPTION

(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.

CONSTRUCTORS

new [ TABLE, ] HASHREF
Creates a new record. It doesn't store it in the database, though. See "insert"|#insert|"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.
qsearch PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
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.
The preferred usage is to pass a hash reference of named parameters:

 my @records = qsearch( {
                          'table'     => 'table_name',
                          'hashref'   => { 'field' => 'value'
                                           'field' => { 'op'    => '<',
                                                        'value' => '420',
                                                      },
                                         },

                          #these are optional...
                          'select'    => '*',
                          'extra_sql' => 'AND field ',
                          'order_by'  => 'ORDER BY something',
                          #'cache_obj' => '', #optional
                          'addl_from' => 'LEFT JOIN othtable USING ( field )',
                        }
                      );

Much code still uses old-style positional parameters, this is also probably fine in the common case where there are only two parameters:

 my @records = qsearch( 'table', { 'field' => 'value' } );

      1. oops, argh, FS::Record::new only lets us create database fields. #Normal behaviour if SELECT is not specified is `*', as in #SELECT * FROM table WHERE .... However, there is an experimental new #feature where you can specify SELECT - remember, the objects returned, #although blessed into the appropriate `FS::TABLE' package, will only have the #fields you specify. This might have unwanted results if you then go calling #regular FS::TABLE methods #on it.
by_key PRIMARY_KEY_VALUE
This is a class method that returns the record with the given primary key value. This method is only useful in FS::Record subclasses. For example:

 my $cust_main = FS::cust_main->by_key(1); # retrieve customer with custnum 1

is equivalent to:

 my $cust_main = qsearchs('cust_main', { 'custnum' => 1 } );

jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY
Experimental JOINed search method. Using this method, you can execute a single SELECT spanning multiple tables, and cache the results for subsequent method calls. Interface will almost definately change in an incompatible fashion.
Arguments:
qsearchs PARAMS_HASHREF | TABLE, HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ, ADDL_FROM
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.

METHODS

table
Returns the table name.
dbdef_table
Returns the DBIx::DBSchema::Table object for the table.
primary_key
Returns the primary key for the table.
get, getfield COLUMN
Returns the value of the column/field/key COLUMN.
set, setfield COLUMN, VALUE
Sets the value of the column/field/key COLUMN to VALUE. Returns VALUE.
AUTLOADED METHODS
$record->column is a synonym for $record->get('column');
$record->column('value') is a synonym for $record->set('column','value');
hash
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 } );

hashref
Returns a reference to the column/value hash. This may be deprecated in the future; if there's a reason you can't just use the autoloaded or get/set methods, speak up.
modified
Returns true if any of this object's values have been modified with set (or via an autoloaded method). Doesn't yet recognize when you retreive a hashref and modify that.
select_for_update
Selects this record with the SQL "FOR UPDATE" command. This can be useful as a mutex.
insert
Inserts this record to the database. If there is an error, returns the error, otherwise returns false.
add
Depriciated (use insert instead).
delete
Delete this record from the database. If there is an error, returns the error, otherwise returns false.
del
Depriciated (use delete instead).
replace OLD_RECORD
Replace the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
rep
Depriciated (use replace instead).
check
Checks virtual fields (using check_blocks). Subclasses should still provide a check method to validate real fields, foreign keys, etc., and call this method via $self->SUPER::check.
(FIXME: Should this method try to make sure that it is being called from a subclass's check method, to keep the current semantics as far as possible?)
unique COLUMN
Warning: External use is deprecated.
Replaces COLUMN in record with a unique number, using counters in the filesystem. Used by the insert method on single-field unique columns (see DBIx::DBSchema::Table) and also as a fallback for primary keys that aren't SERIAL (Pg) or AUTO_INCREMENT (mysql).
Returns the new value.
ut_float COLUMN
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.
ut_floatn COLUMN
Check/untaint floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be null. If there is an error, returns the error, otherwise returns false.
ut_sfloat COLUMN
Check/untaint signed 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.
ut_sfloatn COLUMN
Check/untaint signed floating point numeric data: 1.1, 1, 1.1e10, 1e10. May be null. If there is an error, returns the error, otherwise returns false.
ut_snumber COLUMN
Check/untaint signed numeric data (whole numbers). If there is an error, returns the error, otherwise returns false.
ut_snumbern COLUMN
Check/untaint signed numeric data (whole numbers). If there is an error, returns the error, otherwise returns false.
ut_number COLUMN
Check/untaint simple numeric data (whole numbers). May not be null. If there is an error, returns the error, otherwise returns false.
ut_numbern COLUMN
Check/untaint simple numeric data (whole numbers). May be null. If there is an error, returns the error, otherwise returns false.
ut_money COLUMN
Check/untaint monetary numbers. May be negative. Set to 0 if null. If there is an error, returns the error, otherwise returns false.
ut_text COLUMN
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.
ut_textn COLUMN
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.
ut_alpha COLUMN
Check/untaint alphanumeric strings (no spaces). May not be null. If there is an error, returns the error, otherwise returns false.
ut_alpha COLUMN
Check/untaint alphanumeric strings (no spaces). May be null. If there is an error, returns the error, otherwise returns false.
ut_phonen COLUMN [ COUNTRY ]
Check/untaint phone numbers. May be null. If there is an error, returns the error, otherwise returns false.
Takes an optional two-letter ISO country code; without it or with unsupported countries, ut_phonen simply calls ut_alphan.
ut_hex COLUMN
Check/untaint hexadecimal values.
ut_hexn COLUMN
Check/untaint hexadecimal values. May be null.
ut_ip COLUMN
Check/untaint ip addresses. IPv4 only for now.
ut_ipn COLUMN
Check/untaint ip addresses. IPv4 only for now. May be null.
ut_coord COLUMN [ LOWER [ UPPER ] ]
Check/untaint coordinates. Accepts the following forms: DDD.DDDDD -DDD.DDDDD DDD MM.MMM -DDD MM.MMM DDD MM SS -DDD MM SS DDD MM MMM -DDD MM MMM
The "DDD MM SS" and "DDD MM MMM" are potentially ambiguous. The latter form (that is, the MMM are thousands of minutes) is assumed if the "MMM" is exactly three digits or two digits > 59.
To be safe, just use the DDD.DDDDD form.
If LOWER or UPPER are specified, then the coordinate is checked for lower and upper bounds, respectively.
ut_coordn COLUMN [ LOWER [ UPPER ] ]
Same as ut_coord, except optionally null.
ut_domain COLUMN
Check/untaint host and domain names.
ut_name COLUMN
Check/untaint proper names; allows alphanumerics, spaces and the following punctuation: , . - '
May not be null.
ut_zip COLUMN
Check/untaint zip codes.
ut_country COLUMN
Check/untaint country codes. Country names are changed to codes, if possible - see Locale::Country.
ut_anything COLUMN
Untaints arbitrary data. Be careful.
ut_enum COLUMN CHOICES_ARRAYREF
Check/untaint a column, supplying all possible choices, like the "enum" type.
ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
Check/untaint a foreign column key. Call a regular ut_ method (like ut_number) on the column first.
ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
Like ut_foreign_key, except the null value is also allowed.
ut_agentnum_acl
Checks this column as an agentnum, taking into account the current users's ACLs.
virtual_fields [ TABLE ]
Returns a list of virtual fields defined for the table. This should not be exported, and should only be called as an instance or class method.
fields [ TABLE ]
This is a wrapper for real_fields and virtual_fields. Code that called fields before should probably continue to call fields.
pvf FIELD_NAME
Returns the FS::part_virtual_field object corresponding to a field in the record (specified by FIELD_NAME).

SUBROUTINES

real_fields [ TABLE ]
Returns a list of the real columns in the specified table. Called only by fields() and other subroutines elsewhere in FS::Record.
_quote VALUE, TABLE, COLUMN
This is an internal function used to construct SQL statements. It returns VALUE DBI-quoted (see "quote" in DBI|DBI#quote|"quote" in DBI) unless VALUE is a number and the column type (see DBIx::DBSchema::Column) does not end in `char' or `binary'.
vfieldpart_hashref TABLE
Returns a hashref of virtual field names and vfieldparts applicable to the given TABLE.
hfields TABLE
This is deprecated. Don't use it.
It returns a hash-type list with the fields of this record's table set true.
encrypt($value)
Encrypts the credit card using a combination of PK to encrypt and uuencode to armour.
Returns the encrypted string.
You should generally not have to worry about calling this, as the system handles this for you.
is_encrypted($value)
Checks to see if the string is encrypted and returns true or false (1/0) to indicate it's status.
decrypt($value)
Uses the private key to decrypt the string. Returns the decryoted string or undef on failure.
You should generally not have to worry about calling this, as the system handles this for you.

BUGS

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 deprecated 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 deprecated in favor of DBIx::DBSchema::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 which 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 only checks 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)

As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc, or allow it to be set. Working around it is ugly any way around - DBI should be fixed. (only affects RDBMS which return uppercase column names)

ut_zip should take an optional country like ut_phone.

SEE ALSO

DBIx::DBSchema, FS::UID, DBI

Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.

http://poop.sf.net/

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 1945:
'=item' outside of any '=over'
Around line 1962:
You forgot a '=back' before '=head1'
Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:1.9:Documentation:Developer/FS/Record&oldid=2559"