Difference between revisions of "Freeside:3:Documentation:Developer/FS/cust main Mixin"

Revision as of 10:51, 30 March 2015

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

display_custnum

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.

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_status_label; 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

Class methods that return SQL framents, equivalent to the corresponding FS::cust_main method.

cust_search_sql

Returns a list of SQL WHERE fragments to search for parameters specified in HASHREF. Valid parameters are:

agentnum

; status:; payby; email_search_result HASHREF

Emails a notice to the specified customers. Customers without invoice email destinations will be skipped.

Parameters:

job

Queue job for status updates. Required.

search

Hashref of params to the search() method. Required.

msgnum

Message template number (see FS::msg_template). Overrides all of the following options.

from

From: address

subject

Email Subject:

html_body

HTML body

text_body

Text body

Returns an error message, or false for success.

If any messages fail to send, they will be queued as individual jobs which can be manually retried. If the first ten messages in the job fail, the entire job will abort and return an error.

conf

Returns a configuration handle (FS::Conf) set to the customer's locale, if they have one. If not, returns an FS::Conf with no locale.

mt TEXT [, ARGS ]

Localizes a text string (see Locale::Maketext) for the customer's locale, if they have one.

time2str_local FORMAT, TIME[, ESCAPE]

Localizes a date (see Date::Language) for the customer's locale.

FORMAT can be a Date::Format string, or one of these special words:

- "short": the value of the "date_format" config setting for the customer's locale, defaulting to "%x". - "rdate": the same as "short" except that the default has a four-digit year. - "long": the value of the "date_format_long" config setting for the customer's locale, defaulting to "%b %o, %Y".

ESCAPE, if specified, is one of "latex" or "html", and will escape non-ASCII characters and convert spaces to nonbreaking spaces.

BUGS

SEE ALSO

FS::cust_main, FS::Record