Freeside:1.9:Documentation:Developer/FS/registrar
From Freeside
Contents
NAME
FS::registrar - Object methods for registrar records
SYNOPSIS
use FS::registrar; $record = new FS::registrar \%hash; $record = new FS::registrar { 'column' => 'value' }; $error = $record->insert; $error = $new_record->replace($old_record); $error = $record->delete; $error = $record->check;
DESCRIPTION
An FS::registrar object represents a registrar. FS::registrar inherits from FS::Record. The following fields are currently supported:
- registrarnum - primary key; registrarname -
METHODS
- new HASHREF
- Creates a new registrar. To add the registrar to the database, see "insert"|#insert|"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 registrar. 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.