From 35227000d6222f35ec49bc4226e94200b77abc4f Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 23 Apr 2001 12:41:57 +0000 Subject: new API documentation --- htdocs/docs/man/FS/domain_record.html | 122 ++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 htdocs/docs/man/FS/domain_record.html (limited to 'htdocs/docs/man/FS/domain_record.html') diff --git a/htdocs/docs/man/FS/domain_record.html b/htdocs/docs/man/FS/domain_record.html new file mode 100644 index 000000000..78601b4d0 --- /dev/null +++ b/htdocs/docs/man/FS/domain_record.html @@ -0,0 +1,122 @@ + + +FS::domain_record - Object methods for domain_record records + + + + + + + + +

+ + +

NAME

FS::domain_record - Object methods for domain_record records

SYNOPSIS

+  use FS::domain_record;

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

+  $error = $record->insert;

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

+  $error = $record->delete;

+  $error = $record->check;

DESCRIPTION

An FS::domain_record object represents an entry in a DNS zone. +FS::domain_record inherits from FS::Record. The following fields are currently +supported:

recnum - primary key
+: +
svcnum - Domain (see the FS::svc_domain manpage) of this entry
+: +
reczone - partial (or full) zone for this entry
+: +
recaf - address family for this entry, currently only `IN' is recognized.
+: +
rectype - record type for this entry (A, MX, etc.)
+: +
recdata - data for this entry
+: +

METHODS

new HASHREF
+

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

VERSION

$Id: domain_record.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

BUGS

The data validation doesn't check everything it could. In particular, +there is no protection against bad data that passes the regex, duplicate +SOA records, forgetting the trailing `.', impossible IP addersses, etc. Of +course, it's still better than editing the zone files directly. :)

HISTORY

$Log: domain_record.html,v $ +

Revision 1.1 2001-04-23 12:41:57 ivan +

new API documentation +

+Revision 1.1 2000/02/03 05:16:52 ivan +beginning of DNS and Apache support

+ + + + -- cgit v1.2.1