Freeside:3:Documentation:Developer/FS/UI/Web

From Freeside
< Freeside:3:Documentation:Developer‎ | FS
Revision as of 20:09, 27 June 2012 by Ivan (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
svc_url
Returns a service URL, first checking to see if there is a service-specific page to link to, otherwise to a generic service handling page. Options are passed as a list of name-value pairs, and include:
    • m - Mason request object ($m)
    • action - The action for which to construct "edit", "view", or "search"
    • ** part_svc - Service definition (see FS::part_svc)
    • ** svcdb - Service table
    • *** query - Query string
    • *** svc - FS::cust_svc or FS::svc_* object
    • ahref - Optional flag, if set true returns <A HREF="$url"> instead of just the URL.
  • Required fields
    • part_svc OR svcdb is required
      • query OR svc is required
cust_header [ CUST_FIELDS_VALUE ]
Returns an array of customer information headers according to the supplied customer fields value, or if no value is supplied, the cust-fields configuration value.
cust_sql_fields [ CUST_FIELDS_VALUE ]
Returns a list of fields for the SELECT portion of an SQL query.
As with the cust_header subroutine, the fields returned are defined by the supplied customer fields setting, or if no customer fields setting is supplied, the cust-fields configuration value.
cust_fields OBJECT [ CUST_FIELDS_VALUE ]
Given an object that contains fields from cust_main (say, from a JOINed search. See httemplate/search/svc_* for examples), returns an array of customer information, or "(unlinked)" if this service is not linked to a customer.
As with the cust_header subroutine, the fields returned are defined by the supplied customer fields setting, or if no customer fields setting is supplied, the cust-fields configuration value.
cust_fields_subs
Returns an array of subroutine references for returning customer field values. This is similar to cust_fields, but returns each field's sub as a distinct element.
cust_colors
Returns an array of subroutine references (or empty strings) for returning customer information colors.
As with the cust_header subroutine, the fields returned are defined by the supplied customer fields setting, or if no customer fields setting is supplied, the cust-fields configuration value.
cust_styles
Returns an array of customer information styles.
As with the cust_header subroutine, the fields returned are defined by the supplied customer fields setting, or if no customer fields setting is supplied, the cust-fields configuration value.
cust_aligns
Returns an array or scalar (depending on context) of customer information alignments.
As with the cust_header subroutine, the fields returned are defined by the supplied customer fields setting, or if no customer fields setting is supplied, the cust-fields configuration value.
is_mobile
Utility function to determine if the client is a mobile browser.

POD ERRORS

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

Around line 49:
'=item' outside of any '=over'
Around line 61:
Expected '=item *'
Around line 63:
Expected '=item *'
Around line 65:
Expected '=item *'
Around line 67:
Expected '=item *'
Around line 69:
Expected '=item *'