Freeside:4:Documentation:Developer/FS/deploy zone vertex

From Freeside
< Freeside:4:Documentation:Developer‎ | FS
Revision as of 07:21, 18 November 2015 by Jeremyd (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::deploy_zone_vertex - Object methods for deploy_zone_vertex records

SYNOPSIS

 use FS::deploy_zone_vertex;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::deploy_zone_vertex object represents a vertex of a polygonal deployment zone (FS::deploy_zone). FS::deploy_zone_vertex inherits from FS::Record. The following fields are currently supported:

vertexnum
primary key
zonenum
Foreign key to FS::deploy_zone.
latitude
Latitude, as a decimal; positive values are north of the Equator.
longitude
Longitude, as a decimal; positive values are east of Greenwich.

METHODS

new HASHREF
Creates a new vertex record. To add the record to the database, see "insert".
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 vertex. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::Record