Difference between revisions of "Freeside:3:Documentation:Developer/FS/conf"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::conf - Object methods for conf records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::conf;
 +
 +
  $record = new FS::conf \%hash;
 +
  $record = new FS::conf { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::conf object represents a configuration value. FS::conf inherits from FS::Record. The following fields are currently supported:
 +
 +
; confnum - primary key; agentnum - the agent to which this configuration value applies; name - the name of the configuration value; value - the configuration value
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new configuration value. To add the example to the database, see [[#insert|"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 configuration value. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.

Latest revision as of 05:30, 10 February 2015

NAME

FS::conf - Object methods for conf records

SYNOPSIS

 use FS::conf;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::conf object represents a configuration value. FS::conf inherits from FS::Record. The following fields are currently supported:

confnum - primary key; agentnum - the agent to which this configuration value applies; name - the name of the configuration value; value - the configuration value

METHODS

new HASHREF
Creates a new configuration value. 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 configuration value. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/conf&oldid=8331"