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

Latest revision as of 14:37, 27 June 2014

NAME

FS::part_tag - Object methods for part_tag records

SYNOPSIS

 use FS::part_tag;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::part_tag object represents a tag. FS::part_tag inherits from FS::Record. The following fields are currently supported:

tagnum - primary key; tagname - tag name; tagdesc - description (can be longer than name); tagcolor - HTML-style color to display this tag; by_default - 'Y' to enable this tag on new customers; disabled

METHODS

new HASHREF

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

CLASS METHODS

default_tags

Returns the tagnums of all tags that have 'by_default' enabled.

BUGS

SEE ALSO

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

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 134:

You forgot a '=back' before '=head1'