Difference between revisions of "Freeside:3:Documentation:Developer/FS/cgp rule condition"

Revision as of 20:03, 27 June 2012

NAME

FS::cgp_rule_condition - Object methods for cgp_rule_condition records

SYNOPSIS

 use FS::cgp_rule_condition;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::cgp_rule_condition object represents a mail filtering condition. FS::cgp_rule_condition inherits from FS::Record. The following fields are currently supported:

ruleconditionnum

primary key

conditionname

condition

op

op

params

params

rulenum

rulenum

METHODS

new HASHREF

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

arrayref

Returns an array reference of the conditionname, op and params fields.

BUGS

SEE ALSO

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