Difference between revisions of "Freeside:4:Documentation:Developer/FS/log context"

Latest revision as of 07:24, 18 November 2015

NAME

FS::log_context - Object methods for log_context records

SYNOPSIS

 use FS::log_context;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::log_context object represents a context tag attached to a log entry (FS::log). FS::log_context inherits from FS::Record. The following fields are currently supported:

logcontextnum - primary key; lognum - lognum (FS::log foreign key); context - context

METHODS

new HASHREF

Creates a new context tag. 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.

CLASS METHODS

contexts

Returns a list of all valid contexts.

BUGS

SEE ALSO

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