Difference between revisions of "Freeside:4:Documentation:Developer/FS/rate time"

Latest revision as of 07:28, 18 November 2015

NAME

FS::rate_time - Object methods for rate_time records

SYNOPSIS

 use FS::rate_time;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::rate_time object represents a time period for selection of CDR billing rates. FS::rate_time inherits from FS::Record. The following fields are currently supported:

ratetimenum

primary key

ratetimename

A label (like "Daytime" or "Weekend").

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.

check

Checks all fields to make sure this is a valid example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

intervals

Return the FS::rate_time_interval objects included in this rating period.

contains TIME

Return the FS::rate_time_interval object that contains the specified time-of-week (in seconds from the start of Sunday). The primary use of this is to test whether that time falls within this rating period.

description

Returns a list of arrayrefs containing the starting and ending times of each interval in this period, in a readable format.

BUGS

To be seen.

SEE ALSO

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