Difference between revisions of "Freeside:3:Documentation:Developer/FS/cable provider"

From Freeside
Jump to: navigation, search
(Edit via perl MediaWiki framework (1.13))
 
m (Edit via perl MediaWiki framework (1.13))
 
(One intermediate revision by the same user not shown)
(No difference)

Latest revision as of 05:29, 10 February 2015

NAME

FS::cable_provider - Object methods for cable_provider records

SYNOPSIS

 use FS::cable_provider;

 $record = new FS::cable_provider \%hash;
 $record = new FS::cable_provider { 'column' => 'value' };

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cable_provider object represents a cable service provider. FS::cable_provider inherits from FS::Record. The following fields are currently supported:

providernum
primary key
provider
provider
disabled
disabled

METHODS

new HASHREF
Creates a new provider. To add the provider to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
insert
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
delete
Delete this record from the database.
replace OLD_RECORD
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
check
Checks all fields to make sure this is a valid provider. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.