X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fsvc_www.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fsvc_www.html;h=8f3a99a64c3e0bd9dcb9e618fe250f5fba6fe6db;hp=0000000000000000000000000000000000000000;hb=35227000d6222f35ec49bc4226e94200b77abc4f;hpb=f3235d39d083518d47f21cd5585e5f9a13070763 diff --git a/htdocs/docs/man/FS/svc_www.html b/htdocs/docs/man/FS/svc_www.html new file mode 100644 index 000000000..8f3a99a64 --- /dev/null +++ b/htdocs/docs/man/FS/svc_www.html @@ -0,0 +1,150 @@ + + +FS::svc_www - Object methods for svc_www records + + + + + + + + +

+ + +

NAME

FS::svc_www - Object methods for svc_www records

SYNOPSIS

+  use FS::svc_www;

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

+  $error = $record->insert;

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

+  $error = $record->delete;

+  $error = $record->check;

+  $error = $record->suspend;

+  $error = $record->unsuspend;

+  $error = $record->cancel;

DESCRIPTION

An FS::svc_www object represents an web virtual host. FS::svc_www inherits +from FS::svc_Common. The following fields are currently supported:

svcnum - primary key
+: +
recnum - DNS `A' record corresponding to this web virtual host. (see the FS::domain_record manpage)
+: +
usersvc - account (see the FS::svc_acct manpage) corresponding to this web virtual host.
+: +

METHODS

new HASHREF
+

+Creates a new web virtual host. To add the record 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. +

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be +defined. An FS::cust_svc record will be created and inserted.

If the configuration values (see the FS::Conf manpage) apachemachine, and +apacheroot exist, the command:

+  mkdir $apacheroot/$zone;
+  chown $username $apacheroot/$zone;
+  ln -s $apacheroot/$zone $homedir/$zone

$zone is the DNS A record pointed to by recnum +$username is the username pointed to by usersvc +$homedir is that user's home directory

is executed on apachemachine via ssh. This behaviour can be surpressed by +setting $FS::svc_www::nossh_hack true.

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

suspend
+

+Called by the suspend method of FS::cust_pkg (see the FS::cust_pkg manpage). +

unsuspend
+

+Called by the unsuspend method of FS::cust_pkg (see the FS::cust_pkg manpage). +

cancel
+

+Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage). +

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 repalce methods. +

VERSION

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

BUGS

HISTORY

$Log: svc_www.html,v $ +

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

new API documentation +

+Revision 1.4 2001/04/22 01:56:15 ivan +get rid of FS::SSH.pm (became Net::SSH and Net::SCP on CPAN)

Revision 1.3 2000/11/22 23:30:51 ivan +tyop

Revision 1.2 2000/03/01 08:13:59 ivan +compilation bugfixes

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

+ + + +