3 <TITLE>FS::svc_www - Object methods for svc_www records</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#methods">METHODS</A></LI>
18 <LI><A HREF="#version">VERSION</A></LI>
19 <LI><A HREF="#bugs">BUGS</A></LI>
20 <LI><A HREF="#see also">SEE ALSO</A></LI>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::svc_www - Object methods for svc_www records</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 use FS::svc_www;</PRE>
34 $record = new FS::svc_www \%hash;
35 $record = new FS::svc_www { 'column' => 'value' };</PRE>
37 $error = $record->insert;</PRE>
39 $error = $new_record->replace($old_record);</PRE>
41 $error = $record->delete;</PRE>
43 $error = $record->check;</PRE>
45 $error = $record->suspend;</PRE>
47 $error = $record->unsuspend;</PRE>
49 $error = $record->cancel;</PRE>
52 <H1><A NAME="description">DESCRIPTION</A></H1>
53 <P>An FS::svc_www object represents an web virtual host. FS::svc_www inherits
54 from FS::svc_Common. The following fields are currently supported:</P>
56 <DT><STRONG><A NAME="item_svcnum_%2D_primary_key">svcnum - primary key</A></STRONG><BR>
58 <DT><STRONG><A NAME="item_recnum_%2D_DNS_%60A%27_record_corresponding_to_thi">recnum - DNS `A' record corresponding to this web virtual host. (see <A HREF=".././FS/domain_record.html">the FS::domain_record manpage</A>)</A></STRONG><BR>
60 <DT><STRONG><A NAME="item_account">usersvc - account (see <A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>) corresponding to this web virtual host.</A></STRONG><BR>
65 <H1><A NAME="methods">METHODS</A></H1>
67 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
69 Creates a new web virtual host. To add the record to the database, see
70 <A HREF="#insert">insert</A>.
71 <P>Note that this stores the hash reference, not a distinct copy of the hash it
72 points to. You can ask the object for a copy with the <EM>hash</EM> method.</P>
74 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
76 Adds this record to the database. If there is an error, returns the error,
77 otherwise returns false.
78 <P>The additional fields pkgnum and svcpart (see <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>) should be
79 defined. An FS::cust_svc record will be created and inserted.</P>
80 <P>If the configuration values (see <A HREF=".././FS/Conf.html">the FS::Conf manpage</A>) <EM>apachemachine</EM>, and
81 <EM>apacheroot</EM> exist, the command:</P>
83 mkdir $apacheroot/$zone;
84 chown $username $apacheroot/$zone;
85 ln -s $apacheroot/$zone $homedir/$zone</PRE>
86 <P><EM>$zone</EM> is the DNS A record pointed to by <EM>recnum</EM>
87 <EM>$username</EM> is the username pointed to by <EM>usersvc</EM>
88 <EM>$homedir</EM> is that user's home directory</P>
89 <P>is executed on <EM>apachemachine</EM> via ssh. This behaviour can be surpressed by
90 setting $FS::svc_www::nossh_hack true.</P>
92 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
94 Delete this record from the database.
96 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
98 Replaces the OLD_RECORD with this one in the database. If there is an error,
99 returns the error, otherwise returns false.
101 <DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><BR>
103 Called by the suspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
105 <DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><BR>
107 Called by the unsuspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
109 <DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><BR>
111 Called by the cancel method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
113 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
115 Checks all fields to make sure this is a valid example. If there is
116 an error, returns the error, otherwise returns false. Called by the insert
121 <H1><A NAME="version">VERSION</A></H1>
122 <P>$Id: svc_www.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
125 <H1><A NAME="bugs">BUGS</A></H1>
128 <H1><A NAME="see also">SEE ALSO</A></H1>
129 <P><A HREF=".././FS/svc_Common.html">the FS::svc_Common manpage</A>, <A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/domain_record.html">the FS::domain_record manpage</A>, <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>,
130 <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>, <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>, schema.html from the base documentation.</P>