Freeside:1.7:Documentation:Developer/FS/cust main Mixin

From Freeside
< Freeside:1.7:Documentation:Developer‎ | FS
Revision as of 17:52, 3 October 2007 by Ivan (talk | contribs) (import from POD)

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

NAME

FS::cust_main_Mixin - Mixin class for records that contain fields from cust_main

SYNOPSIS

package FS::some_table; use vars qw(@ISA); @ISA = qw( FS::cust_main_Mixin FS::Record );

DESCRIPTION

This is a mixin class for records that contain fields from the cust_main table, for example, from a JOINed search. See httemplate/search/ for examples.

METHODS

name
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main name method, or "(unlinked)" if this object is not linked to a customer.
ship_name
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main ship_name method, or "(unlinked)" if this object is not linked to a customer.
contact
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main contact method, or "(unlinked)" if this object is not linked to a customer.
ship_contact
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main ship_contact method, or "(unlinked)" if this object is not linked to a customer.
country_full
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main country_full method, or "(unlinked)" if this object is not linked to a customer.
invoicing_list_emailonly
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main invoicing_list_emailonly method, or "(unlinked)" if this object is not linked to a customer.
invoicing_list_emailonly_scalar
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main invoicing_list_emailonly_scalar method, or "(unlinked)" if this object is not linked to a customer.
invoicing_list
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main invoicing_list method, or "(unlinked)" if this object is not linked to a customer.
Note: this method is read-only.
status
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main status method, or "(unlinked)" if this object is not linked to a customer.
ucfirst_cust_status
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main ucfirst_status method, or "(unlinked)" if this object is not linked to a customer.
cust_statuscolor
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the FS::cust_main statuscol method, or "000000" if this object is not linked to a customer.
prospect_sql; active_sql; inactive_sql; suspended_sql; cancelled_sql
Given an object that contains fields from cust_main (say, from a JOINed search; see httemplate/search/ for examples), returns the equivalent of the corresponding FS::cust_main method, or "0" if this object is not linked to a customer.

BUGS

SEE ALSO

FS::cust_main, FS::Record