Difference between revisions of "Freeside:3:Documentation:Developer/FS/dsl device"

Revision as of 20:04, 27 June 2012

NAME

FS::dsl_device - Object methods for dsl_device records

SYNOPSIS

 use FS::dsl_device;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::dsl_device object represents a specific customer MAC address. The following fields are currently supported:

devicenum

primary key

svcnum

svcnum

mac_addr

mac_addr

METHODS

new HASHREF

Creates a new device. To add the device 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 device. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

svc_dsl

Returns the phone number (see FS::svc_dsl) associated with this customer device.

BUGS

SEE ALSO

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