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

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::contact_class - Object methods for contact_class records
  
 +
==SYNOPSIS==
 +
<code>
 +
  use FS::contact_class;
 +
 +
  $record = new FS::contact_class \%hash;
 +
  $record = new FS::contact_class { 'column' => 'value' };
 +
 +
  $error = $record->insert;
 +
 +
  $error = $new_record->replace($old_record);
 +
 +
  $error = $record->delete;
 +
 +
  $error = $record->check;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::contact_class object represents a contact class. FS::contact_class inherits from FS::class_Common. The following fields are currently supported:
 +
 +
; classnum
 +
:primary key
 +
; classname
 +
:Class name
 +
; disabled
 +
:Disabled flag
 +
 +
==METHODS==
 +
; new HASHREF
 +
:Creates a new example. 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. =item check
 +
 +
:Checks all fields to make sure this is a valid class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
The author forgot to customize this manpage.
 +
 +
==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::contact_class - Object methods for contact_class records

SYNOPSIS

 use FS::contact_class;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::contact_class object represents a contact class. FS::contact_class inherits from FS::class_Common. The following fields are currently supported:

classnum
primary key
classname
Class name
disabled
Disabled flag

METHODS

new HASHREF
Creates a new example. 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. =item check
Checks all fields to make sure this is a valid class. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

The author forgot to customize this manpage.

SEE ALSO

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

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