httemplate/docs/man/FS/svc_www.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::svc_www - Object methods for svc_www records</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  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>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::svc_www - Object methods for svc_www records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::svc_www;</PRE>
  33 <PRE>
  34   $record = new FS::svc_www \%hash;
  35   $record = new FS::svc_www { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <PRE>
  45   $error = $record-&gt;suspend;</PRE>
  46 <PRE>
  47   $error = $record-&gt;unsuspend;</PRE>
  48 <PRE>
  49   $error = $record-&gt;cancel;</PRE>
  50 <P>
  51 <HR>
  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>
  55 <DL>
  56 <DT><STRONG><A NAME="item_svcnum_%2D_primary_key">svcnum - primary key</A></STRONG><BR>
  57 <DD>
  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>
  59 <DD>
  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>
  61 <DD>
  62 </DL>
  63 <P>
  64 <HR>
  65 <H1><A NAME="methods">METHODS</A></H1>
  66 <DL>
  67 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  68 <DD>
  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>
  73 <P></P>
  74 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  75 <DD>
  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>
  82 <PRE>
  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>
  91 <P></P>
  92 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  93 <DD>
  94 Delete this record from the database.
  95 <P></P>
  96 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  97 <DD>
  98 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  99 returns the error, otherwise returns false.
 100 <P></P>
 101 <DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><BR>
 102 <DD>
 103 Called by the suspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
 104 <P></P>
 105 <DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><BR>
 106 <DD>
 107 Called by the unsuspend method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
 108 <P></P>
 109 <DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><BR>
 110 <DD>
 111 Called by the cancel method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).
 112 <P></P>
 113 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
 114 <DD>
 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
 117 and repalce methods.
 118 <P></P></DL>
 119 <P>
 120 <HR>
 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>
 123 <P>
 124 <HR>
 125 <H1><A NAME="bugs">BUGS</A></H1>
 126 <P>
 127 <HR>
 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>
 131
 132 </BODY>
 133
 134 </HTML>