% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>
FS::svc_www - Object methods for svc_www records
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;
An FS::svc_www object represents an web virtual host. FS::svc_www inherits from FS::svc_Common. The following fields are currently supported:
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.
Returns the zone name for this virtual host.
END_TIMESTAMP and START_TIMESTAMP can optionally be passed when dealing with history records.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted.
Currently available options are: depend_jobnum
If depend_jobnum is set (to a scalar jobnum or an array reference of jobnums), all provisioning jobs will have a dependancy on the supplied jobnum(s) (they will not run until the specific job(s) complete(s)).
Delete this record from the database.
Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).
Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).
Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).
Checks all fields to make sure this is a valid web virtual host. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
Returns the FS::domain_record record for this web virtual host's zone (see FS::domain_record).
Returns the FS::svc_acct record for this web virtual host's owner (see FS::svc_acct).
FS::svc_Common, FS::Record, FS::domain_record, FS::cust_svc, FS::part_svc, FS::cust_pkg, schema.html from the base documentation.