SPBAS v1.7 API Documentation

_ A B C D E F G H I J L M N O P Q R S T U V W X Y

_

__construct() - Method in class Framework\search
Search customers

A

a() - Function in package General_Use_Functions_Storefront
Prep data for the database
acl() - Method in class Framework\admin
The administrator ACL
action() - Method in class System_Lib\forms
Displays the form action.
activated() - Method in class Licensing\license
Lock in the activation date
active_campaigns() - Method in class Mass_Mail\mass_mail
Get all active campaigns
add() - Method in class 3rd_Party_Modules\third_party
Add a new module
add() - Method in class Support\support_package
Add a new support_package
add() - Method in class Users\user
Add a new user.
add() - Method in class KB\glossary
Add a new glossary entry
add() - Method in class Billing\taxes
Add a new tax rule
add() - Method in class Media\download_control
Add a new download control
add() - Method in class Billing\currency
Add a new currency
add() - Method in class KB\article
Add a new article
add() - Method in class Billing\promotions
Add a new promotion
add() - Method in class Billing\orders
Add a new order
add() - Method in class Customers\customer
Add a new customer.
add() - Method in class KB\attachment
Add a new attachment
add() - Method in class Framework\cron
Add a new cron job
add() - Method in class Order_Forms\order_forms
Add a order form
add() - Method in class Agreements\agreements
Add a new agreement
add() - Method in class KB\profile
Add a KB profile
add() - Method in class Billing\price_sheet
Add a new price sheet.
add() - Method in class Framework\admin
Add a new administrator.
add() - Method in class Media\media
Add new media
add() - Method in class Billing\product
Add a new product record
add() - Method in class Customer_Areas\customer_area
Add a customer area login
add() - Method in class Framework\localization
Add a new language translation
add() - Method in class CMS\page
Add a new site
add() - Method in class CMS\site
Add a new site
add_access() - Method in class Licensing\license
Add a new access detail
add_access_key() - Method in class Billing\orders
Get order details by the access key
add_acl() - Method in class Framework\admin
Add an ACL entry
add_addon_to_product() - Method in class Billing\product
Add addon to product
add_address() - Method in class Customers\customer
Add a new address
add_address() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Add a new address for the customer.
add_announcement() - Method in class Customer_Areas\customer_area
Add an announcement
add_asset() - Method in class Billing\product
Add an asset to a sku
add_authorized_user() - Method in class Customers\customer
Add an authorized user for the customer
add_campaign() - Method in class Mass_Mail\mass_mail
Add a new mass campaign
add_category() - Method in class KB\category
Add a new category
add_category() - Method in class Order_Forms\order_forms
Add a new category
add_category() - Method in class Customer_Areas\customer_area
Add a new category
add_category() - Method in class Media\media
Add a new category
add_comment() - Method in class Billing\orders
Add an order comment
add_config() - Method in class Framework\email
Add a new e-mail configuration
add_contact() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Add a new contact.
add_country_assignment() - Method in class Billing\taxes
Assign a tax rule to a country
add_credit() - Method in class Billing\credit
Add a customer credit
add_customer_user_id2session() - Method in class Order_Forms\order_forms
Add the order id to the session
add_element() - Method in class Framework\admin
Add a new element to the user's profile
add_email() - Method in class Framework\email
Add a new e-mail template
add_gateway() - Method in class Billing\pay_gateways
Add a new pay gateway
add_gateway_jorder_form() - Method in class Billing\pay_gateways
Add a pay gateway to an order form
add_invoice_to_cart_session() - Method in class Order_Forms\order_forms
Add the invoice to the cart
add_job_log() - Method in class Framework\cron
Log when the main cron runner was last ran
add_license_attribute() - Method in class Licensing\license
Add a license level attribute
add_licensing_method_attribute() - Method in class Licensing\license
Add a licensing method attribute
add_licensing_type() - Method in class Licensing\license
Add a new licensing type
add_line_item() - Method in class Billing\invoice
Add a new line item to an invoice
add_line_item_detailed() - Method in class Billing\invoice
Add a new line item to an invoice
add_list() - Method in class Mass_Mail\mass_mail
Add a new mass mail list
add_log() - Method in class Framework\cron
Log when the main cron runner was last ran
add_mask() - Method in class Framework\localization
Add a new language translation mask
add_media() - Method in class Customer_Areas\customer_area
Add new media
add_module() - Method in class Licensing\license
Add a new licensing method
add_order_form_assignment() - Method in class Agreements\agreements
Assign an agreement to an order form
add_order_id2session() - Method in class Order_Forms\order_forms
Add the order id to the session
add_order_id_to_invoice() - Method in class Billing\invoice
Get invoice data using the order id - the first invoice
add_package() - Method in class Billing\package
Add a new package for the customer account.
add_package() - Method in class Billing\orders
Add the package ID to an order part
add_part() - Method in class Billing\invoice
Create a new invoice part
add_part() - Method in class Billing\orders
Add a new order part
add_part_tax() - Method in class Billing\orders
Add the taxes for the order part
add_payment() - Method in class Billing\pay_gateways
Add an invoice payment
add_payment() - Method in class Billing\invoice
Add an invoice payment
add_predefined_license() - Method in class Licensing\license
Get a total count of predefined licenses
add_pricing() - Method in class Billing\promotions
Add promotion fixed pricing
add_pricing() - Method in class Order_Forms\order_forms
Add pricing to an order form
add_pricing() - Method in class Customers\customer
Add custom pricing for a user.
add_product_assignment() - Method in class Agreements\agreements
Assign an agreement to a product
add_product_pricing_assignment() - Method in class Billing\taxes
Assign a tax rule to a product
add_product_to_cart_session() - Method in class Order_Forms\order_forms
Add the product to the cart
add_region() - Method in class Billing\taxes
Add a new region
add_region_assignment() - Method in class Billing\taxes
Assign an region to a country
add_region_tax_rule_assignment() - Method in class Billing\taxes
Assign a tax rule to a region
add_security_question() - Method in class Customer_Areas\customer_area
Add a customer area security question
add_server() - Method in class Licensing\license
Add a new license server
add_set() - Method in class Media\media
Add new media set
add_sku() - Method in class Billing\product
Add a new product sku
add_sku_pricing() - Method in class Billing\product
Add new product sku pricing
add_to_cart() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Add a product (and addons) to the cart.
add_translation() - Method in class Framework\localization
Add a new language translation
addon_display_order() - Method in class Billing\product
Change the category display order
addons() - Method in class Billing\product
Get all addons for a product
address() - Method in class Customers\customer
Query customer profile.
admin() - Class in package Framework
SPBAS Administrators
advanced_search() - Method in class Billing\product
Advanced product search
advanced_search() - Method in class Customers\customer
Advanced customer search
advanced_search() - Method in class Billing\orders
Advanced order search
advanced_search() - Method in class Users\user
Advanced user search
advanced_search() - Method in class Billing\invoice
Advanced invoice search
advanced_search() - Method in class Licensing\license
Advanced license search
agreements() - Class in package Agreements
SPBAS Agreements
agreements() - Method in class Billing\product
Get agreements assigned to a product
announcements() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Get announcements available to logged in users only.
api() - Class in package API
SPBAS API Handler
api_cms() - Class in package Storefront_API_Wrappers_CMS
SPBAS Storefront API Wrappers for the Order Forms API
api_customer_area() - Class in package Storefront_API_Wrappers_Customers
SPBAS Storefront API Wrappers for the Customer Area API
api_kb() - Class in package Storefront_API_Wrappers_KB
SPBAS Storefront API Wrappers for the KB API
api_order_forms() - Class in package Storefront_API_Wrappers_Order
SPBAS Storefront API Wrappers for the Order Forms API
apply_credit() - Method in class Billing\credit
Apply a customer credit
apply_discount_percentage() - Method in class Billing\price_sheet
Apply the exchange rate to a price
apply_discounts() - Method in class Order_Forms\order_forms
Remove an item from the cart
apply_exchange_rate() - Method in class Billing\price_sheet
Apply the exchange rate to a price
apply_overlib() - Method in class KB\glossary
Parse glossary terms into content blocks.
apply_promotion() - Method in class Billing\package
Add a new package for the customer account.
apply_recurring_discount() - Method in class Billing\invoice
Calc the total recurring discount
apply_taxes() - Method in class Billing\package
Add taxes to a package
apply_taxes() - Method in class Order_Forms\order_forms
Apply taxes to the cart
article() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the article page.
article() - Class in package KB
SPBAS KB Articles
article_attachments() - Method in class KB\article
Array of all attachments for $article_id
article_categories() - Method in class KB\article
Get all categories an article is assigned to
asset_map() - Method in class Billing\product
Map a module asset to a db table
assets() - Method in class Billing\product
Get all sku data for an asset
assign() - Method in class Billing\promotions
Assign a promotion to a sku
assign_email_templates() - Method in class Billing\product
Update product e-mail assignments
assign_email_templates() - Method in class Media\download_control
Update product e-mail assignments
assign_email_templates() - Method in class Billing\pay_gateways
Update product e-mail assignments
assign_email_templates() - Method in class Support\support_package
Update product e-mail assignments
assign_list() - Method in class Mass_Mail\mass_mail
Add a new e-mail list to a campaign
assign_template() - Method in class Framework\email
Set an e-mail for exclusion.
assigned2sites() - Method in class CMS\page
Get all sites the page is assigned to.
assignments() - Method in class Billing\promotions
Get the promotion assignments
attachment() - Class in package KB
SPBAS KB Attachments
available_languages() - Method in class Framework\localization
Get a list of all available languages
available_modules_select() - Method in class Licensing\license
Get a list of available licensing modules suitable for forms::select()
available_modules_select() - Method in class 3rd_Party_Modules\third_party
List of available modules suitable for forms::select()
available_select() - Method in class Billing\pay_gateways
Get a list of available pay gateways suitable for forms::select()

B

billing_end_date() - Method in class Billing\package
Calculate the billing end date
blog_posts_wp() - Method in class Framework\search
Save admin notes
bookmarks() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the bookmarks page.
breadcrumb() - Method in class Order_Forms\order_forms
Convert breadcrumb array to string
breadcrumb() - Method in class Customer_Areas\customer_area
Convert breadcrumb array to string
breadcrumb() - Function in package General_Use_Functions_Storefront
Create a breadcrumb menu
breadcrumb() - Method in class Media\media
Convert breadcrumb array to string
breadcrumb() - Method in class KB\category
Convert breadcrumb array to string
breadcrumb_array() - Method in class Customer_Areas\customer_area
Get a breadcrumb array
breadcrumb_array() - Method in class KB\category
Get a breadcrumb array
breadcrumb_array() - Method in class Media\media
Get a breadcrumb array
breadcrumb_array() - Method in class Order_Forms\order_forms
Get a breadcrumb array
breadcrumb_cart() - Method in class Order_Forms\order_forms
Convert breadcrumb array to string for order/cart.php
breadcrumb_customer_area() - Method in class Media\media
Convert breadcrumb array to string
breadcrumb_customer_area_home() - Method in class Media\media
Convert breadcrumb array to string
breadcrumb_downloads() - Method in class Customer_Areas\customer_area
Convert breadcrumb array to string
breadcrumb_downloads_home() - Method in class Customer_Areas\customer_area
Convert breadcrumb array to string
build_cart() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display cart.php
build_checkout() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display order_process.php
build_down_for_maintenance() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display private.php (down_for_maintenance.php)
build_login_page() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the login page.
build_order_complete() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display order_complete.php
build_order_process() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display order_process.php
build_payment() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display payment.php
build_payments() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display payments.php
build_private() - Method in class Storefront_API_Wrappers_CMS\api_cms
Build the down for private page.
build_private() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the private page.
build_product() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display product.php
build_querystring() - Method in class Framework\pagination
Sort out the querystring variables
build_select() - Method in class Framework\email
Build an array of all e-mail configurations for the select box
build_tax_array() - Method in class Billing\taxes
Build valid tax arrays
build_view_cart() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get an array of all data needed to display view_cart.php
button() - Method in class System_Lib\forms
Displays a button.
by() - Method in class Framework\sortable
Returns the sortable column
by_token() - Method in class Billing\invoice
Get an invoice using a specially crafted token.

C

calc_promotional_discount() - Method in class Billing\invoice
Apply a promotional recurring discount
calc_recurring_discount() - Method in class Billing\invoice
Get the total discount amount
calculate_discount() - Method in class Billing\promotions
Validate a promotion
campaign_unique() - Method in class Mass_Mail\mass_mail
Set the campaign as queued
capture_remote() - Function in package General_Use_Functions_Storefront
Grab the IP address of the end user
capture_remote() - Method in class API\api
Grab the IP address of the end user
cart_contents() - Method in class Order_Forms\order_forms
Get the cart contents
categories() - Method in class KB\profile
Get all categories a profile is assigned to
category() - Class in package KB
SPBAS KB Categories
category_display_order() - Method in class Order_Forms\order_forms
Change the category display order
category_products() - Method in class Order_Forms\order_forms
Get all product IDs for a category
category_tree() - Method in class Media\media
Category tree
category_tree_assign() - Method in class KB\article
Category tree for select box
category_tree_assign() - Method in class Billing\product
Category tree for select box
category_tree_assign() - Method in class Media\media
Category tree for select box
category_tree_select() - Method in class Media\media
Category tree for select box
category_tree_select() - Method in class Order_Forms\order_forms
Category tree for select box
category_tree_select() - Method in class KB\category
Category tree for select box
category_tree_select() - Method in class Customer_Areas\customer_area
Category tree for select box
change_assets_status() - Method in class Billing\package
Change the status of all assets assigned to a package
change_currency() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Change the currency of a cart session.
change_currency_option() - Method in class Order_Forms\order_forms
Get a list of all price sheets
change_key() - Method in class Framework\cron
Change the cron key
change_package_status() - Method in class Billing\pay_gateways
Change the package status and the status of all assets
change_password() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Change the logged in users password.
change_primary_contact() - Method in class Customers\customer
Change the primary user contact for a customer
change_security_question() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Change the logged in users security question.
change_status() - Method in class Media\download_control
Delete a download control
change_status() - Method in class Support\support_package
Delete a download control
checkbox() - Method in class System_Lib\forms
Displays a checkbox.
clean_server_url() - Method in class Licensing\license
Remove any .php or trailing slashes from the licensing server URL entered.
clear_cache() - Function in package General_Use_Functions_Storefront
Clear cache for a session
clickbank_item() - Method in class Billing\pay_gateways
Get clickbank item ID for a product sku
clickbank_sync() - Method in class Billing\pay_gateways
Get clickbank item ID for a product sku
clone_sheet() - Method in class Billing\price_sheet
Clone a price sheet.
clone_source() - Method in class Billing\product
Clone a product
commands_to_string() - Method in class API\api
Turn an array into a string suitable for fetching data.
compile() - Method in class General_Use_Functions\pagination
Easy use wrapper for pagination
compile_cart() - Method in class Order_Forms\order_forms
Compile the cart into a usable array
compile_list() - Method in class Mass_Mail\mass_mail
Send mass mail!
conf() - Method in class Framework\setup
Build a admin conf array
conf() - Method in class Framework\email
Get the transport configuration ID.
config() - Function in package General_Use_Functions_Storefront
Returns $config from the global scope
connect_import_db() - Method in class Import\import
Add a addon lookup record
control_specific() - Method in class Framework\email_ui_helper
Download Control
cookie_domain() - Function in package General_Use_Functions_Storefront
Get the cookie domain
countries() - Method in class Framework\country_state
Get a countries list.
countries_simple() - Method in class Framework\country_state
Get a countries list.
countries_with_states() - Method in class Framework\country_state
Get a countries list.
country() - Method in class Billing\taxes
Get tax rules assigned to a country
country_state() - Class in package Framework
SPBAS Country and State
create() - Method in class Licensing\license
Create a new license
create() - Method in class Media\download_control
Create a customer support package
create() - Method in class Billing\invoice
Create a new invoice
create() - Method in class Media\media
Create a customer media package
create() - Method in class Support\support_package
Create a customer support package
create_all() - Method in class Billing\invoice
Create new invoices
create_customer_account() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Create a new customer & primary user account.
create_session() - Method in class Users\user
Create a new session ID
create_session() - Method in class Framework\login
Create a new session ID
create_stub() - Method in class Billing\invoice
Create a new invoice stub
create_stub_customer() - Method in class Billing\invoice
Create a new customer invoice stub
credit() - Class in package Billing
SPBAS Invoice Credits
cron() - Class in package Framework
SPBAS Cron
ct_runner() - Method in class KB\category
Start $id and work down through the category tree
currency() - Class in package Billing
SPBAS Currency
currency_changer() - Method in class Order_Forms\order_forms
Change the session status
customer() - Class in package Customers
SPBAS Customers
customer_area() - Class in package Customer_Areas
SPBAS Customer Areas
customer_area() - Method in class Framework\email_ui_helper
Customer Area
customer_area_categories() - Method in class Media\media
Get all category IDs assigned to the customer area public downloads
customer_area_new_account_information() - Method in class Framework\email_ui_helper
Customer Area, Resend Password
customer_area_resend_user_password() - Method in class Framework\email_ui_helper
Customer Area, Resend Password
customer_data_complete() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Get a complete array of customer & user data
customer_licenses() - Method in class Licensing\license
Get all licenses for a customer
customer_price_sheet() - Method in class Customer_Areas\customer_area
Get the customer price sheet
customer_price_sheet() - Method in class Order_Forms\order_forms
Add the customer & user ID to the session if logged and determine assigned price sheet, if any.
customer_user_totals() - Method in class Customers\customer
Generate XML for invoice totals 7 days running

D

dashboard() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Get the customer area dashboard.
days() - Method in class Framework\cron
List of possible days for the cron run in a forms::select() compatiable format.
deassign() - Method in class Billing\promotions
Deassign a promotion from a sku
delete() - Method in class Billing\promotions
Delete a promotion
delete() - Method in class 3rd_Party_Modules\third_party
Delete an existing module
delete() - Method in class Framework\email
Delete an e-mail template.
delete() - Method in class Billing\product
Delete a sku
delete() - Method in class Support\support_package
Delete a support package
delete() - Method in class Billing\taxes
Delete a tax rule
delete() - Method in class KB\category
Delete category
delete() - Method in class KB\attachment
Delete an attachment from the database.
delete() - Method in class Framework\cron
Delete a cron job
delete() - Method in class Billing\currency
Make the currency the default
delete() - Method in class KB\article
Delete article
delete() - Method in class Licensing\license
Delete a license
delete() - Method in class KB\glossary
Delete a glossary entry from the database.
delete() - Method in class Agreements\agreements
Delete an agreement
delete() - Method in class Media\download_control
Delete a download control
delete() - Method in class Users\user
Delete the user.
delete() - Method in class Customers\customer
Delete the customer.
delete() - Method in class ION\ion
Delete the ION
delete() - Method in class CMS\page
Delete site
delete() - Method in class CMS\site
Delete site
delete() - Method in class Billing\price_sheet
Delete a price sheet.
delete() - Method in class Order_Forms\order_forms
Delete an order form
delete() - Method in class Framework\localization
Delete localization mask and translation
delete() - Method in class Framework\admin
Delete an admin
delete() - Method in class KB\profile
Delete profile
delete_access() - Method in class Licensing\license
Delete an access detail
delete_address() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Delete an address on file.
delete_address() - Method in class Customers\customer
Delete a customer address for $id
delete_all_addresses() - Method in class Customers\customer
Delete the customers contacts.
delete_all_license_access_logs() - Method in class Licensing\license
Delete all license logs
delete_all_users() - Method in class Customers\customer
Delete the users for a customer
delete_announcement() - Method in class Customer_Areas\customer_area
Delete an announcement
delete_assets() - Method in class Billing\package
Remove all assets for a package
delete_campaign() - Method in class Mass_Mail\mass_mail
Delete a mass e-mail campaign
delete_category() - Method in class Media\media
Delete a category and all of it's children + remove downloads
delete_category() - Method in class Order_Forms\order_forms
Delete a category and all of it's children
delete_category() - Method in class Customer_Areas\customer_area
Delete a category and all of it's children + remove downloads
delete_contact() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Delete a contact.
delete_instance() - Method in class Licensing\license
Delete a license instance
delete_instances() - Method in class Licensing\license
Delete all instances of a license - (Reissued to Active is an example of when you might use this)
delete_language_translation() - Method in class Framework\localization
Delete all translations for a specific language
delete_license_access_log() - Method in class Licensing\license
Delete a license log
delete_list() - Method in class Mass_Mail\mass_mail
Delete a mass e-mail list
delete_log() - Method in class Licensing\license
Remove a license access log
delete_log() - Method in class Framework\email
Delete an e-mail from the log.
delete_log() - Method in class Billing\pay_gateways
Remove a pay gateway log
delete_media() - Method in class Media\media
Delete a media
delete_media() - Method in class Customer_Areas\customer_area
Delete a media
delete_media_jsets() - Method in class Media\media
Delete media join sets
delete_media_jsets_category_id() - Method in class Media\media
Delete media join sets
delete_order_form_jcategories() - Method in class Order_Forms\order_forms
Delete a category and all of it's children from the join table
delete_predefined_key() - Method in class Licensing\license
Delete a predefined license key from the queue
delete_price_sheets() - Method in class Order_Forms\order_forms
Delete the price sheets for an order form
delete_profile() - Method in class Framework\admin
Delete an admin profile
delete_profile_attribute() - Method in class Framework\admin
Delete an attribute from the admin profile
delete_profile_pic() - Method in class Framework\admin
Delete the admin's profile pic
delete_region() - Method in class Billing\taxes
Delete a region
delete_security_question() - Method in class Customer_Areas\customer_area
Delete a customer area security question
delete_set() - Method in class Media\media
Delete a media set
delete_sheet_pricing() - Method in class Billing\price_sheet
Delete all price sheet pricing.
delete_sku() - Method in class Billing\product
Delete a sku
delete_sku_pricing() - Method in class Billing\product
Delete sku pricing
delete_sku_pricing_by() - Method in class Billing\product
Delete sku pricing
delete_translation() - Method in class Framework\localization
Delete translation
display() - Method in class Framework\sortable
Returns the arrow graphic for a column
display_errors() - Function in package General_Use_Functions_Storefront
Display errors in a nice wrapper.
display_order() - Method in class Development_Tools\menu_editor
Change the group display order
do_nl2br() - Function in package General_Use_Functions_Storefront
Apply nl2br article content if enable
do_validate_form() - Method in class System_Lib\forms
Include the form handler and return any errors.
down_for_maintenance() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the down for maintenance page.
down_for_maintenance() - Method in class Storefront_API_Wrappers_CMS\api_cms
Build the down for maintenance page.
download() - Method in class KB\attachment
Download media
download() - Method in class Media\media
Download media
download() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Download a public file
download() - Method in class Customer_Areas\customer_area
Download media
download_conf() - Method in class KB\profile
Download the KB site configuration file
download_conf() - Method in class Order_Forms\order_forms
Download the order form configuration file
download_conf() - Method in class CMS\site
Download the CMS site configuration file
download_conf() - Method in class Customer_Areas\customer_area
Download the customer area configuration file
download_control() - Class in package Media
SPBAS Download Controls
download_control_download_control_specific() - Method in class Framework\email_ui_helper
Download Control, Control Specific
downloads() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Get the download categories & contents for $category_id.
draw() - Method in class General_Use_Functions\pagination
Draw the HTML tags and text < << [1][2][3] >> >
due_invoices() - Method in class Framework\search
Total Due Invoices

E

email() - Class in package Framework
SPBAS E-mail Handling & Wrappers
email_logs_wp() - Method in class Customers\customer
Get a list of all users for a customer with pagination.
email_sent() - Method in class Billing\orders
Mark the e-mails as sent for an order
email_ui_helper() - Class in package Framework
SPBAS Helper for the E-mail User Interface
enabled() - Method in class 3rd_Party_Modules\third_party
Get all modules that are enabled.
enforce_www() - Function in package General_Use_Functions_Storefront
Enforce the use of www.
events_select_box() - Method in class Framework\email
Build an array suitable for a select box in the forms class.
example_admin_new_user_registered() - Function in package 3rd_Party_Module_Code_Hooks
Runs when a new user is registered from the admin area.
example_admin_update_user() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the admin updates user information from the admin area.
example_customer_area_add_contact() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user changes there password from the customer area (?task=my_account&tab=change_password).
example_customer_area_change_password() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user changes there password from the customer area (?task=my_account&tab=change_password).
example_customer_area_new_user_registered() - Function in package 3rd_Party_Module_Code_Hooks
Runs when a new user is registered from the customer area (?task=register).
example_customer_area_resend_password() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user logs in at checkout in the order system (?task=checkout)
example_customer_area_update_my_info() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user updates their information from the customer area (?task=my_account&tab=my_info).
example_customer_area_update_user() - Function in package 3rd_Party_Module_Code_Hooks
Runs when user information is updated by the logged in customer (?task=my_account)
example_customer_area_user_login() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user logs in at checkout in the order system (?task=checkout)
example_order_form_new_user_registered() - Function in package 3rd_Party_Module_Code_Hooks
Runs when a new user is registered from the order system.
example_order_form_order_complete() - Function in package 3rd_Party_Module_Code_Hooks
Runs when an order is processed to completion from the order system.
example_order_form_resend_password() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user logs in at checkout in the order system (?task=checkout)
example_order_form_update_user() - Function in package 3rd_Party_Module_Code_Hooks
Runs when user information is updated at checkout in the order system (?task=checkout).
example_order_form_user_login() - Function in package 3rd_Party_Module_Code_Hooks
Runs when the user logs in at checkout in the order system (?task=checkout)
exclude_addons() - Method in class Billing\product
Get all excluded addons for a price tier
exclude_template() - Method in class Framework\email
Set an e-mail for exclusion.
excluded_addons() - Method in class Billing\product
Get all excluded addons for a price tier
excluded_addons() - Method in class Order_Forms\order_forms
Get all excluded addons for a price tier
exists_in_array() - Method in class KB\glossary
Callback function to identify target parent IDs
exists_in_array() - Method in class System_Lib\forms
Find a target $id in an $array for a matching $key, return boolean.
exists_in_array_return_value() - Method in class System_Lib\forms
Find a target $id in an $array for a matching $key, return key value of $return.
expire() - Method in class Support\support_package
Expire support packages if they've reached that point.
expire() - Method in class Media\download_control
Expire licenses if they've reached that point.
expire() - Method in class Licensing\license
Expire licenses if they've reached that point.
expires() - Method in class Licensing\license
Lock in the expire date
expires() - Method in class Media\download_control
Calculate the support package expire date
expires() - Method in class Support\support_package
Calculate the support package expire date
expires_for_customer() - Method in class Media\download_control
Get the expiration date for a customer assigned download control
export() - Method in class Framework\localization
Export a language file
export_language() - Method in class Framework\localization
Extract language from an export filename

F

fetch() - Method in class API\api
Fetch data from the API
fetch_fsockopen() - Method in class API\api
Fetch data from the API
fetch_rss() - Function in package General_Use_Functions_Storefront
Fetch an RSS feed
filter_by() - Method in class Mass_Mail\mass_mail
Add product sku filter to a list
filtered_products() - Method in class Mass_Mail\mass_mail
Get a list of all filtered products for the e-mail list
find_country_by() - Method in class Framework\country_state
Find a country based on the ISO code
find_dynamic() - Method in class Framework\admin
Find the record without an ID
find_mask() - Method in class Framework\localization
Find the mask entry, if any
find_state_by() - Method in class Framework\country_state
Find a state based on the abbreviation
fisherYatesShuffle() - Function in package General_Use_Functions_Storefront
Shuffle an array
fix_dates() - Method in class Media\media
Validate dates before they are saved.
fix_dates() - Method in class Customers\customer
Validate dates before they are saved.
fix_qty() - Method in class Order_Forms\order_forms
The qty in the cart is out of bounds with the min/max order limits
flip() - Method in class Framework\sortable
Returns the opposite of asc or desc
format() - Method in class Billing\currency
Format a price in the selected currency
format_replacable_tags() - Method in class Framework\email_ui_helper
Format replacable tags for display
format_revision_string() - Method in class CMS\page
Get a list of all revisions in a format suitable to forms::select()
format_view() - Method in class CMS\page
Format a page link
forms() - Class in package Framework
SPBAS Dynamically render HTML form elements.
forms() - Class in package System_Lib
Dynamically render HTML form elements.

G

gateway_specific() - Method in class Framework\email_ui_helper
Pay gateway
get() - Method in class Billing\currency
Get currency details
get() - Method in class Framework\cron
Get job details
get() - Method in class Billing\invoice
Get invoice data
get() - Method in class Media\download_control
Get download control data
get() - Method in class Billing\orders
Get order details by the access key
get() - Method in class Customers\customer
Query customer data.
get() - Method in class Support\support_package
Get support package data
get() - Method in class Customer_Areas\customer_area
Get the customer area data
get() - Method in class Framework\admin
Get administrator data based on id
get() - Method in class KB\glossary
Get article data.
get() - Method in class KB\attachment
Get attachment data.
get() - Method in class KB\category
Get category details
get() - Method in class 3rd_Party_Modules\third_party
Get an existing module data
get() - Method in class Billing\product
Get product details
get() - Method in class KB\article
Get an article
get() - Method in class CMS\page
Get site data.
get() - Method in class Billing\taxes
Get a tax rule
get() - Method in class Billing\promotions
Get the promotion details
get() - Method in class Users\user
Query user data.
get() - Method in class CMS\site
Get site data.
get() - Method in class Order_Forms\order_forms
Get the order form data
get() - Method in class KB\profile
Get profile data.
get() - Method in class Billing\pay_gateways
Get the pay gateway data
get() - Method in class Licensing\license
Get license data
get() - Method in class Agreements\agreements
Get an agreement
get() - Method in class Billing\price_sheet
Query price sheet data.
get() - Method in class Framework\localization
Get an existing language translation
get_address() - Method in class Customers\customer
Get the address for $id
get_addresses() - Method in class Customers\customer
Get a list of all customers addresses
get_addresses_wp() - Method in class Customers\customer
Get a list of all customers addresses with pagination.
get_admin_logs_wp() - Method in class Framework\search
Admin login history with paging.
get_agreements() - Method in class Order_Forms\order_forms
Get an agreements assigned to the order form
get_alias_templates() - Method in class Framework\email
Get templates for a specific alias & table
get_all() - Method in class Framework\admin
Get a list of all administrators.
get_all() - Method in class KB\profile
Get all profiles
get_all() - Method in class Billing\product
Get all products
get_all() - Method in class KB\glossary
Get all KB glossary entries.
get_all() - Method in class KB\attachment
Get all attachments
get_all() - Method in class KB\category
Get all categories
get_all() - Method in class Customer_Areas\customer_area
Get a list of all customer areas
get_all() - Method in class Order_Forms\order_forms
Get a list of all order forms
get_all_by_customer_wp() - Method in class Billing\orders
All orders for a customer with paging.
get_all_by_customers() - Method in class Billing\orders
All orders for a customer.
get_all_by_order_id() - Method in class Billing\invoice
Get invoice data using the order id - the first invoice
get_all_campaigns_wp() - Method in class Mass_Mail\mass_mail
Get a list of all e-mail campaigns with pagination
get_all_comments_for() - Method in class KB\article
Get all article comments.
get_all_config() - Method in class Framework\email
Query e-mail configuration data for all records.
get_all_config_wp() - Method in class Framework\email
Query e-mail configuration data for all records with paging.
get_all_countries_wp() - Method in class Billing\taxes
Get all countries w/ paging
get_all_credits() - Method in class Billing\credit
Get all customer credits
get_all_email_lists_wp() - Method in class Mass_Mail\mass_mail
Get a list of all e-mail lists with pagination
get_all_for_customer() - Method in class Billing\invoice
Get all invoices for a customer
get_all_for_customer_wp() - Method in class Billing\invoice
Get all invoices for a customer
get_all_gateways_wa() - Method in class Billing\pay_gateways
Get a list of all pay gateways with attributes.
get_all_gateways_wp() - Method in class Billing\pay_gateways
Get a list of all pay gateways with paging.
get_all_invoices() - Method in class Billing\pay_gateways
All invoices for an order
get_all_invoices() - Method in class Billing\orders
All invoices for an order
get_all_licenses_for_package() - Method in class Licensing\license
Get a list of all licenses for a package
get_all_lists() - Method in class Mass_Mail\mass_mail
Get a list of all e-mail lists with pagination
get_all_logs_wp() - Method in class Framework\email
Get all e-mail logs with pagination
get_all_methods() - Method in class Licensing\license
Get a list of all installed licensing methods.
get_all_methods_wp() - Method in class Licensing\license
Get a list of all installed licensing methods with paging.
get_all_modules_wp() - Method in class 3rd_Party_Modules\third_party
Get a list of all installed 3rd party modules with paging.
get_all_packages_wp() - Method in class Billing\product
Get all packages with pagination
get_all_past_due() - Method in class Billing\invoice
Get a list of all past due invoices
get_all_predefined() - Method in class Licensing\license
Get a list of licenses that have been predefined
get_all_pricing() - Method in class Order_Forms\order_forms
Get a list of all price sheets
get_all_pricing_wp() - Method in class Order_Forms\order_forms
Get a list of all price sheets with pagination.
get_all_pricing_wp() - Method in class Customers\customer
Get all pricing for a customer with pagination
get_all_security_questions_wp() - Method in class Customer_Areas\customer_area
Get a list of all security questions with pagination.
get_all_servers() - Method in class Licensing\license
Get a list of all installed license servers
get_all_servers_wp() - Method in class Licensing\license
Get a list of all installed license servers with paging.
get_all_sku_pricing() - Method in class Billing\product
Get all sku pricing for a sku id
get_all_templates_wp() - Method in class Framework\email
Get all system templates with paging
get_all_types_wp() - Method in class Licensing\license
Get a list of all installed licensing methods with paging.
get_all_wp() - Method in class Framework\admin
Get a list of all administrators with paging.
get_all_wp() - Method in class Licensing\license
Get a list of all licenses with paging.
get_all_wp() - Method in class Order_Forms\order_forms
Get a list of all order forms with pagination.
get_all_wp() - Method in class KB\profile
Get all profiles terms w/ paging
get_all_wp() - Method in class KB\category
Get a list of all categories with pagination.
get_all_wp() - Method in class KB\attachment
Get all attachments terms w/ paging
get_all_wp() - Method in class KB\article
Get all articles w/ paging
get_all_wp() - Method in class Users\user
Get a list of all customers with pagination.
get_all_wp() - Method in class KB\glossary
Get all glossary terms w/ paging
get_all_wp() - Method in class Framework\cron
Get a list of all jobs with paging.
get_all_wp() - Method in class Billing\taxes
Get all tax rules w/ paging
get_all_wp() - Method in class Agreements\agreements
Get all agreements w/ paging
get_all_wp() - Method in class CMS\site
Get all profiles terms w/ paging
get_all_wp() - Method in class Customer_Areas\customer_area
Get a list of all customer areas with pagination.
get_all_wp() - Method in class Billing\orders
All orders with paging.
get_all_wp() - Method in class Billing\price_sheet
Get a list of all price sheets with pagination.
get_all_wp() - Method in class Billing\product
Get all products with pagination
get_all_wp() - Method in class Customers\customer
Get a list of all customers with pagination.
get_all_wp() - Method in class Billing\currency
Get all currencies with pagination
get_all_wp() - Method in class Billing\promotions
All orders with paging.
get_all_wp() - Method in class CMS\page
Get all profiles terms w/ paging
get_all_wp() - Method in class Billing\invoice
Get a list of all invoices with pagination.
get_announcement() - Method in class Customer_Areas\customer_area
Get an announcement
get_announcement_by_customer_area() - Method in class Customer_Areas\customer_area
Get an announcement
get_announcements_wp() - Method in class Customer_Areas\customer_area
Get a list of all announcements areas with pagination.
get_articles() - Method in class KB\category
Get all articles for a category
get_asset() - Method in class Billing\product
Get asset data for $asset_id
get_asset_by_ids() - Method in class Billing\product
Get asset data by ids
get_asset_map() - Method in class Billing\product
Get a complete asset map
get_asset_map() - Method in class Billing\package
Get a complete asset map
get_assets_by_ids() - Method in class Billing\product
Get all assets data by ids
get_assigned_assets() - Method in class Billing\product
Get asset for a package and customer
get_assigned_lists() - Method in class Mass_Mail\mass_mail
Get a list of all assigned e-mail lists to the campaign
get_attributes() - Method in class Billing\pay_gateways
Get the pay gateway specific attributes
get_attributes() - Method in class 3rd_Party_Modules\third_party
Get a list of all installed 3rd party module attributes.
get_by() - Method in class Billing\promotions
Get the promotion details using the promotion code
get_by() - Method in class Framework\admin
Get administrator data based on session_id
get_by() - Method in class Customer_Areas\customer_area
Get the customer area data using the API key
get_by() - Method in class Order_Forms\order_forms
Get the order form data using the api key
get_by_access_key() - Method in class Billing\orders
Get order details by the access key
get_by_alias() - Method in class KB\attachment
Get attachment by the alias $web_id
get_by_key() - Method in class Licensing\license
Get license data by key
get_by_letter() - Method in class KB\glossary
Get all KB glossary entries.
get_by_order_id() - Method in class Billing\invoice
Get invoice data using the order id - the first invoice
get_campaign() - Method in class Mass_Mail\mass_mail
Get campaign data
get_campaign_by_token() - Method in class Mass_Mail\mass_mail
Get campaign data
get_categories() - Method in class Order_Forms\order_forms
Get all categories
get_categories() - Method in class Media\media
Get all categories
get_categories() - Method in class Customer_Areas\customer_area
Get all categories
get_category() - Method in class Media\media
Get category details
get_category() - Method in class Order_Forms\order_forms
Get category details
get_category() - Method in class Customer_Areas\customer_area
Get category details
get_category_by_parent() - Method in class Media\media
Get parent category details
get_comments() - Method in class Billing\orders
Get order comments NOTE: later expand this to be threaded comments, which means rewriting this function to bring back more than 1 record
get_company_info() - Method in class Users\user
Get company info for a user, if any
get_config() - Method in class Framework\email
Get the e-mail template configurations.
get_configuration() - Method in class Framework\email
Get e-mail configuration for $config_id
get_contact() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Get contact details.
get_controls() - Method in class Media\download_control
Get all download controls
get_controls_wp() - Method in class Media\download_control
Get all download controls w/ paging
get_country() - Method in class Framework\country_state
Find a country based on the $id
get_country_tax_rule_assignments() - Method in class Billing\taxes
Get a country assignments for a tax rule
get_credit() - Method in class Billing\credit
Get credit data
get_credit_used() - Method in class Billing\credit
Get the amount of credit used
get_credits_used() - Method in class Billing\credit
Get credits used for an invoice
get_customer_media() - Method in class Customers\customer
Get all media for customer
get_customer_price_sheet() - Method in class Order_Forms\order_forms
Get all price sheets assigned to a customer
get_default() - Method in class Billing\currency
Get the default currency
get_download_control_emails() - Method in class Media\download_control
Get templates for a specific download control
get_download_controls() - Method in class Customers\customer
Get all download controls for customer
get_download_controls_wp() - Method in class Customers\customer
Get all download controls for customer w/ paging
get_event() - Method in class Framework\email
Get an e-mail event.
get_events() - Method in class Framework\email
Get a list of valid e-mail events.
get_fixed_discounts() - Method in class Billing\promotions
Get the promotion fixed discounts
get_group() - Method in class Framework\localization
Get a group of translations for this page
get_highest_rated() - Method in class KB\article
Get the highest rated $x articles.
get_history() - Method in class CMS\page
Get page history
get_icons() - Method in class KB\article
Get any icons that may be available.
get_icons() - Method in class KB\category
Get any icons that may be available.
get_instances_simple() - Method in class Licensing\license
List of access details
get_invoice_credit() - Method in class Billing\credit
Get invoice credit data
get_latest() - Method in class KB\article
Get the latest $x articles.
get_licenses_wp() - Method in class Customers\customer
Get all licenses for customer w/ paging
get_licensing_method() - Method in class Licensing\license
Get licensing type data
get_licensing_method_attributes() - Method in class Licensing\license
Remove a licensing method attribute
get_list() - Method in class Mass_Mail\mass_mail
Get list data
get_lists() - Method in class Mass_Mail\mass_mail
Get a list of all assigned e-mail lists to the campaign
get_log() - Method in class Billing\pay_gateways
Get the pay gateway log data
get_log() - Method in class Framework\email
Get an e-mail log.
get_log() - Method in class 3rd_Party_Modules\third_party
Get log entry
get_log() - Method in class Licensing\license
Get the license access log data
get_log_attributes() - Method in class Framework\email
Get all e-mail log attributes
get_logs_for_gateway_wp() - Method in class Billing\pay_gateways
Get a list of all pay gateway logs for a specific gateway with paging.
get_logs_wp() - Method in class Licensing\license
Get a list of all license access logs with paging.
get_logs_wp() - Method in class Users\user
User login history with paging.
get_logs_wp() - Method in class Billing\pay_gateways
Get a list of all pay gateway logs with paging.
get_logs_wp() - Method in class Framework\admin
Admin login history with paging.
get_masks() - Method in class Framework\localization
Get all language masks
get_media() - Method in class Media\media
Get media
get_media() - Method in class Customer_Areas\customer_area
Get media
get_media_by_alias() - Method in class Media\media
Get media by the alias string
get_media_by_alias() - Method in class Customer_Areas\customer_area
Get media by the alias string
get_media_by_category_id() - Method in class Customer_Areas\customer_area
Get all media for a category
get_media_by_category_id() - Method in class Media\media
Get all media for a category
get_media_wp() - Method in class Customers\customer
Get all media for customer w/ paging
get_menu_entry() - Method in class Framework\admin
Get the menu entry for $id
get_method() - Method in class Licensing\license
Get licensing method data
get_most_viewed() - Method in class KB\article
Get the most viewed $x articles.
get_opt_out() - Method in class Mass_Mail\mass_mail
Get all users who have opt-out
get_order_form_assignments() - Method in class Agreements\agreements
Get an agreement order form assignments
get_package() - Method in class Billing\package
Get package details
get_package_asset() - Method in class Billing\package
Get all licenses that belong to a package.
get_package_pricing_wp() - Method in class Billing\price_sheet
Get all pricing for a price sheet
get_package_taxes() - Method in class Billing\package
Get taxes for the package
get_packages() - Method in class Billing\orders
Get all packages for an order
get_packages() - Method in class Support\support_package
Get all support packages
get_packages() - Method in class Billing\package
Get a list of all customers packages.
get_packages_wp() - Method in class Billing\package
Get a list of all customers packages with pagination.
get_packages_wp() - Method in class Support\support_package
Get all support packages w/ paging
get_pages() - Method in class CMS\site
Get all pages for a site
get_parent_id() - Method in class Billing\package
Get the parent package ID for a package
get_part() - Method in class Billing\invoice
Get all invoice part details
get_part() - Method in class Billing\orders
Get the order part
get_part_taxes() - Method in class Billing\orders
Get taxes for the order part
get_parts() - Method in class Billing\orders
Get the order parts
get_parts() - Method in class Billing\invoice
Get all invoice parts
get_pay_gateway_emails() - Method in class Billing\pay_gateways
Get templates for a specific pay gateway
get_payment() - Method in class Billing\invoice
Payment details for a single entry
get_payment_by_transaction() - Method in class Billing\invoice
Payment details for a single entry by transaction ID
get_payments() - Method in class Billing\invoice
Get all invoice payments
get_pricing() - Method in class Billing\product
Get product details
get_pricing_assignments() - Method in class Billing\taxes
Get an product pricing assignments
get_primary_contact() - Method in class Customers\customer
Change the primary user contact for a customer
get_product_assignments() - Method in class Agreements\agreements
Get an agreement product assignments
get_random_color() - Function in package General_Use_Functions_Storefront
Generate a random hex color
get_record() - Method in class Import\import
Get a lookup record
get_records() - Method in class Import\import
Get lookup records
get_region_tax_rule_assignments() - Method in class Billing\taxes
Get a region assignments for a tax rule
get_renewal_options() - Method in class Billing\product
Get the renewal product options
get_security_question() - Method in class Customer_Areas\customer_area
Get a security question
get_server() - Method in class Licensing\license
Get license server data
get_session() - Method in class Order_Forms\order_forms
Get the session data
get_session_by_transaction_id() - Method in class Order_Forms\order_forms
Get the session data
get_session_extras() - Method in class Order_Forms\order_forms
Get the sessio ndata
get_session_order_notes() - Method in class Order_Forms\order_forms
Get the order notes
get_set() - Method in class Media\media
Get media set
get_sets() - Method in class Media\media
Get all media sets
get_sets_wp() - Method in class Media\media
Get all media sets w/ paging
get_sku_by_id() - Method in class Billing\product
Get sku data by the ID
get_sku_emails() - Method in class Billing\product
Get templates for a specific product price tier
get_sku_pricing() - Method in class Billing\product
Get sku pricing
get_sku_pricing_by_id() - Method in class Billing\product
Get sku pricing by the ID
get_sku_pricing_for_product() - Method in class Billing\product
Get all sku pricing for a product
get_skus() - Method in class Billing\product
Get all skus
get_skus_wp() - Method in class Billing\product
Get all sku pricing with pagination
get_state() - Method in class Framework\country_state
Find a state based on the $id
get_support_package_emails() - Method in class Support\support_package
Get templates for a specific support package
get_support_packages() - Method in class Customers\customer
Get all support packages for customer
get_support_wp() - Method in class Customers\customer
Get all support packages for customer w/ paging
get_template() - Method in class Framework\email
Get an e-mail tempalte for $id
get_template_excludes_by_template_id() - Method in class Framework\email
Get an e-mail tempaltes for an event
get_templates_by_event() - Method in class Framework\email
Get an e-mail tempaltes for an event
get_templates_excludes_by_event() - Method in class Framework\email
Get an e-mail tempaltes for an event
get_user_logs_wp() - Method in class Framework\search
User login history with paging.
get_users() - Method in class Customers\customer
Get a list of all users for a customer
get_users_wp() - Method in class Customers\customer
Get a list of all users for a customer with pagination.
get_validation_rules() - Method in class Licensing\license
Get a list of licenses that have been predefined
glossary() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the glossary page.
glossary() - Class in package KB
SPBAS KB Glossary
group_map() - Method in class Framework\email
Table mappings for e-mail groups

H

hidden() - Method in class System_Lib\forms
Displays a hidden input box.
history_select() - Method in class CMS\page
Get a list of all revisions in a format suitable to forms::select()
hours() - Method in class Framework\cron
List of possible hours for the cron run in a forms::select() compatiable format.
href() - Function in package General_Use_Functions_Storefront
Format a href links

I

import() - Method in class Framework\localization
Export a language file
import() - Class in package Import
SPBAS Import
import_key_list() - Method in class Licensing\license
Get a total count of predefined licenses
include_template() - Method in class Framework\email
Set an e-mail for exclusion.
increment_dl_count() - Method in class KB\attachment
Log a download count
increment_dl_count() - Method in class Media\media
Get media by the alias string
increment_dl_count() - Method in class Customer_Areas\customer_area
Get media by the alias string
increment_invoice_id() - Method in class Billing\invoice
Parse the invoice ID format to create a new invoice ID
index() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the index page.
index() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the main customer area index page.
index() - Method in class Storefront_API_Wrappers_CMS\api_cms
Build the main index page.
instance_id() - Method in class Licensing\license
Create a series ID
invoice() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the invoice page.
invoice() - Class in package Billing
SPBAS Invoices
invoice_credit_used() - Method in class Billing\credit
Get the amount of credit used
invoices_for_order() - Method in class Billing\pay_gateways
Get all invoices for an order ID
ion() - Class in package ION
SPBAS Instant Order Notification (ION)
is_admin_login() - Method in class Users\user
Check to see if it's the admin trying to login with the customer password.
is_campaign_complete() - Method in class Mass_Mail\mass_mail
Is the campaign complete?
is_campaign_queued() - Method in class Mass_Mail\mass_mail
Get all queued campaigns
is_customer_assigned_sheet() - Method in class Customers\customer
Add a new package for the customer account.
is_unique_code() - Method in class Billing\promotions
Verify a promotion code is unique (before trying to add it)
is_valid_customer_price_sheet() - Method in class Order_Forms\order_forms
Make sure the customer is actually assigned the said price_sheet_id
is_valid_price_sheet_for_order_form() - Method in class Order_Forms\order_forms
Do we have a valid price sheet for the order form?
is_windows() - Function in package General_Use_Functions_Storefront
Determine if we are using windows
isset_asset() - Method in class Billing\product
Does the asset assignment exist
isset_gateway_jorder_form() - Method in class Billing\pay_gateways
Get all order forms for a gateway
isset_log() - Method in class 3rd_Party_Modules\third_party
Does a log already exist?
isset_pricing() - Method in class Billing\promotions
Does promotion pricing exist for a currency?
isset_product_in_cart_session() - Method in class Order_Forms\order_forms
Is the product already in the cart?
isset_product_in_category() - Method in class Order_Forms\order_forms
Is the product already assigned to the category?
isset_record() - Method in class Import\import
Record already imported?
isset_renewal_options() - Method in class Billing\product
See if we have any renewal products assigned to a particular sku
isset_session() - Method in class Order_Forms\order_forms
Does the session exist?
isset_username() - Method in class Framework\admin
Validate the username
issue_asset() - Method in class Billing\package
Issue product asset
issue_assets() - Method in class Billing\package
Issue product assets

J

job_list() - Method in class Framework\cron
Log when the main cron runner was last ran

L

landing_page() - Method in class Framework\login
Get the default landing page for after login
last_invoice_created() - Method in class Framework\search
The last invoice created
last_user_login() - Method in class Framework\search
Total Packages
license() - Class in package Licensing
SPBAS Licensing
license() - Method in class Framework\email_ui_helper
License
license_access_logs_wp() - Method in class Licensing\license
Get the access logs for a license with paging
license_email_local_key() - Method in class Framework\email_ui_helper
License, E-mail Local Key
license_free_trial_abuse() - Method in class Framework\email_ui_helper
License, Free Trial Abuse
license_license_expired() - Method in class Framework\email_ui_helper
License, License Expired
license_license_key_email() - Method in class Framework\email_ui_helper
License, License Key E-mail
license_license_reissued() - Method in class Framework\email_ui_helper
License, License Reissued
license_license_suspended() - Method in class Framework\email_ui_helper
License, License Suspended
limits() - Method in class General_Use_Functions\pagination
Upper and lower limits based on the current page.
listings() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the listings page.
local_expires() - Method in class Licensing\license
Lock in the expire date
localization() - Class in package Framework
SPBAS Localization
lock_session() - Method in class Order_Forms\order_forms
Lock the session
lock_unlock_product() - Method in class Billing\product
Lock or unlock the sku while updating
log() - Method in class Framework\email
Log a sent e-mail
log() - Method in class Billing\pay_gateways
Log payments
log() - Method in class Licensing\license
Add a license log entry
log() - Method in class 3rd_Party_Modules\third_party
Add a new log entry
log_attribute() - Method in class Framework\email
Log sent e-mail attributes
log_helpful() - Method in class KB\article
Add to the helpful or not helpful count
log_page_view() - Method in class KB\article
Log a page view for an article.
log_session() - Method in class Framework\login
Log the login
log_session() - Method in class Users\user
Log login
login() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Send the login request to create a new session.
login() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Process a customer login
login() - Class in package Framework
SPBAS Admin Login

M

mail_new_registration() - Method in class Users\user
Send the user registration details on account creation
make_default() - Method in class Order_Forms\order_forms
Get the default configuration asc
make_default() - Method in class Billing\currency
Make the currency the default
make_default() - Method in class Framework\email
Get the default configuration asc
make_default() - Method in class Billing\pay_gateways
Get the default pay gateway id
make_default() - Method in class KB\profile
Get the default configuration asc
make_default() - Method in class Customer_Areas\customer_area
Get the default configuration asc
make_id() - Method in class Billing\invoice
Parse the invoice ID format to create a new invoice ID
make_page_select() - Method in class CMS\site
Make an array suitable for forms::select()
make_pay_gateway_default() - Method in class Order_Forms\order_forms
Make a pay gateway the default for the order form
make_select() - Method in class KB\profile
Make an array suitable for forms::select()
make_select() - Method in class Billing\product
Get all products in a suitable format for forms::select()
make_select() - Method in class Order_Forms\order_forms
Make a select box suitable for forms::select()
make_select() - Method in class CMS\page
Make an array suitable for forms::select()
make_select() - Method in class Billing\pay_gateways
Make an array suitable for forms::select().
make_select() - Method in class CMS\site
Make an array suitable for forms::select()
make_select() - Method in class Billing\currency
Make the currency list suitable for forms::select()
make_select() - Method in class Billing\price_sheet
Make the price sheet list suitable for forms::select()
make_select_alpha() - Method in class Billing\currency
Make the currency list suitable for forms::select()
make_select_ca() - Method in class Customer_Areas\customer_area
Make an array suitable for forms::select()
make_select_caa() - Method in class Customer_Areas\customer_area
Make an array suitable for forms::select() using an existing array
make_select_caa() - Method in class Licensing\license
Make an array suitable for forms::select() using an existing array
make_select_caa() - Method in class KB\profile
Make an array suitable for forms::select()
make_select_caa() - Method in class Order_Forms\order_forms
Make a select box suitable for forms::select()
make_verify_sign() - Method in class ION\ion
Make the verify sign for ION
map_asset() - Method in class Billing\product
Map a module asset to the asset_record
mass_mail() - Class in package Mass_Mail
SPBAS Mass Mail
max_rows() - Method in class Framework\pagination
User have a max rows prefrence set already?
media() - Class in package Media
SPBAS Media
menu_editor() - Class in package Development_Tools
SPBAS Menu Editor Development Tool
merge() - Method in class Customers\customer
Merge two customers together
method_email_templates() - Method in class Licensing\license
Get e-mail templates for a method/module/event
module_select() - Method in class Development_Tools\menu_editor
Get all modules
modules() - Method in class Import\import
Get a list of import modules
months() - Function in package General_Use_Functions_Storefront
All possible months.
my_account() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the my account page.
my_invoices() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the my invoices page.
my_package_details() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the my package details page.
my_packages() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the my packages page.

N

next_renewal_date() - Method in class Billing\package
Calculate the next renewal date

O

oldest_unpaid_invoice() - Method in class Billing\pay_gateways
Get the oldest unpaid invoice for an order
on() - Function in package General_Use_Functions_Storefront
Set the focus class
ooe() - Function in package General_Use_Functions_Storefront
Is the $number odd or even?
opt_out() - Method in class Mass_Mail\mass_mail
Opt-out the user
opt_out() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the mass mail opt-out page.
order_complete_summary() - Method in class Order_Forms\order_forms
Remove an item from the cart
order_form() - Method in class Framework\email_ui_helper
Order Form
order_form_categories() - Method in class Billing\product
Get order form category assignments for a product
order_form_new_account_information() - Method in class Framework\email_ui_helper
Order Form, New Account Information
order_form_new_order_confirmation() - Method in class Framework\email_ui_helper
Order Form, New Order Confirmation
order_form_resend_user_password() - Method in class Framework\email_ui_helper
Order Form, Resend User Password
order_forms() - Class in package Order_Forms
SPBAS Order Forms
orders() - Class in package Billing
SPBAS Orders
overlib() - Method in class System_Lib\forms
Displays the overlib.js help hint.

P

package() - Class in package Billing
SPBAS Packages
package_by_order_id() - Method in class Billing\invoice
Get package details by the order ID
package_price_sheets_select() - Method in class Billing\product
Get all packages with pagination
page() - Class in package CMS
SPBAS CMS Pages
page_display_order() - Method in class CMS\site
Do the page sort order
pagination() - Class in package Framework
SPBAS Pagination
pagination() - Class in package General_Use_Functions
SPBAS Storefront Pagination
paid_invoices() - Method in class Framework\search
Total Paid Invoices
parse_b_cc() - Method in class Framework\email
Parse BCC recipients
parse_invoice_key() - Method in class Billing\invoice
Parse the top level key from invoice::to_create() into meaningful data
parse_sql() - Function in package General_Use_Functions_Storefront
Convert a Comma Separated Value list into an array
parse_template() - Method in class Framework\email_ui_helper
Parse template
parse_xml_by_eval() - Method in class API\api
Parse XML using eval() to compile the resulting array
parse_xml_by_eval() - Function in package General_Use_Functions_Storefront
Parse XML using eval() to compile the resulting array
password() - Method in class System_Lib\forms
Displays a password input box.
pay_gateway_gateway_specific() - Method in class Framework\email_ui_helper
Pay gateway, Gateway Specific
pay_gateway_log_by_order_id() - Method in class Billing\invoice
Get package details by the order ID
pay_gateways() - Class in package Billing
SPBAS Pay Gateways
payment_already_applied() - Method in class Billing\pay_gateways
Is this a duplicate transaction?
post_xml() - Function in package General_Use_Functions_Storefront
Post XML using cURL
posted() - Method in class ION\ion
Delete the ION
pr() - Method in class API\api
Debug helper - prints a formatted array
pr() - Function in package General_Use_Functions_Storefront
Debug helper - prints a formatted array
predefined_license_count() - Method in class Licensing\license
Get a total count of predefined licenses
predefined_license_get() - Method in class Licensing\license
Get a predefined license key from the pool
predefined_mark_as_taken() - Method in class Licensing\license
Remove the predefined license key from the pool.
price_sheet() - Class in package Billing
SPBAS Price Sheets
price_sheets_for_product_select() - Method in class Billing\price_sheet
Get all price sheets for a product
pricing_display_order() - Method in class Billing\product
Change the category display order
print_page() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the print page.
process() - Method in class Billing\orders
Process a payment
process_acl() - Method in class Framework\admin
Process the page level acl.
process_ideal_gateway_response() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Process the Ideal pay gateway module response.
process_session() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Process the session for a logged in user.
process_session() - Method in class Users\user
Process the session
process_session() - Method in class Framework\admin
Process an admin session.
process_subscription_payment() - Method in class Billing\pay_gateways
Process an incoming subscription payment.
product() - Class in package Billing
SPBAS Products
product() - Method in class Framework\email_ui_helper
Product
product() - Method in class Billing\taxes
Get tax rules assigned to a product
product_assets() - Method in class Billing\product
Get all asset data for a product
product_assets_by_product_id() - Method in class Billing\product
Get all asset data for a product
product_assets_wp() - Method in class Billing\product
Get all asset data for a product with pagination
product_display_order() - Method in class Order_Forms\order_forms
Change the product display order
product_order_approved_after_review() - Method in class Framework\email_ui_helper
Product, Order Approved After Review
product_order_under_review() - Method in class Framework\email_ui_helper
Product, Order Under Review
product_product_specific() - Method in class Framework\email_ui_helper
Product, Product Specific
product_specific() - Method in class Framework\email_ui_helper
Product Specific
profile() - Class in package KB
SPBAS KB Sites
profile() - Method in class Framework\admin
The administrator profile
profile_pic() - Method in class Framework\admin
Display the admin profile pic
promotions() - Class in package Billing
SPBAS Promotions & Coupons
promotions() - Method in class Billing\product
Get the promotion assignments
public_announcements() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the public announcements page.

Q

query() - Method in class General_Use_Functions\pagination
Build a querystring
query() - Method in class API\api
Issue a command via the API
queued_campaigns() - Method in class Mass_Mail\mass_mail
Get all queued campaigns

R

radio() - Method in class System_Lib\forms
Displays a radio button.
rearrange() - Method in class Development_Tools\menu_editor
Change the menu structure
recordset() - Method in class General_Use_Functions\pagination
Maps out a cross section used in pagination::draw()
region() - Method in class Billing\taxes
Get tax rules assigned to a region
register() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Build the register page.
register_new_user() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Register a new user.
reissue_license() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Reissue a license.
related() - Method in class KB\article
Array of all related articles
remove() - Method in class Billing\pay_gateways
Remove a pay gateway
remove() - Method in class Customer_Areas\customer_area
Remove a customer area
remove() - Method in class Licensing\license
Remove a licensing module
remove_acl() - Method in class Framework\admin
Remove an ACL entry
remove_addon_from_product() - Method in class Billing\product
Remove addon from product
remove_article_from_category() - Method in class KB\article
Remove article from a category
remove_article_relation() - Method in class KB\article
Remove article from a category
remove_asset() - Method in class Billing\product
Remove an asset from a sku
remove_asset_by_id() - Method in class Billing\product
Remove an asset from a sku
remove_attachment_from_article() - Method in class KB\article
Remove article from a category
remove_category_from_customer_area() - Method in class Media\media
Remove category from the customer area public downloads
remove_category_from_profile() - Method in class KB\profile
Remove article from a category
remove_category_from_set() - Method in class Media\media
Remove category from media set
remove_config() - Method in class Framework\email
Delete the e-mail configuration.
remove_contact() - Method in class Customers\customer
Remove a authorized user from a customer
remove_country_assignment() - Method in class Billing\taxes
Remove an tax rule from a product
remove_credit() - Method in class Billing\credit
Remove a credit
remove_download_control() - Method in class Customers\customer
Remove download control
remove_filter() - Method in class Mass_Mail\mass_mail
Remove product sku filter from a list
remove_from_cart() - Method in class Order_Forms\order_forms
Remove an item from the cart
remove_gateway_jorder_form() - Method in class Billing\pay_gateways
Remove a pay gateway from an order form
remove_invoice() - Method in class Billing\invoice
Remove a customer invoice
remove_invoice_credit() - Method in class Billing\credit
Remove credit from an invoice
remove_invoice_from_cart_session() - Method in class Order_Forms\order_forms
Remove the invoice from the cart
remove_invoice_part() - Method in class Billing\invoice
Remove an invoice part
remove_item() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Remove an item from the cart
remove_license() - Method in class Customers\customer
Remove a customer license
remove_license_attribute() - Method in class Licensing\license
Remove a license level attribute
remove_licensing_method() - Method in class Licensing\license
Remove a licensing method
remove_list() - Method in class Mass_Mail\mass_mail
Remove a list from a campaign
remove_media() - Method in class Customers\customer
Remove media
remove_order() - Method in class Billing\orders
Remove an order
remove_order_form_assignment() - Method in class Agreements\agreements
Remove an agreement assignment from the order form
remove_package() - Method in class Billing\package
Remove a package
remove_page_from_site() - Method in class CMS\page
Remove a page from a site
remove_parts() - Method in class Billing\orders
Remove all of the order parts
remove_payment() - Method in class Billing\invoice
Remove an invoice part
remove_pricing() - Method in class Customers\customer
Remove custom pricing from a user.
remove_pricing() - Method in class Order_Forms\order_forms
Add pricing to an order form
remove_product_assignment() - Method in class Agreements\agreements
Remove an agreement assignment from a product
remove_product_from_category() - Method in class Order_Forms\order_forms
Remove product from the category and order form
remove_product_pricing_assignment() - Method in class Billing\taxes
Remove an tax rule from a product
remove_promotion_code() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Remove a promotion code from the cart
remove_promotion_code_to_session() - Method in class Order_Forms\order_forms
Remove a promotion code from the primary session
remove_region_assignment() - Method in class Billing\taxes
Remove a region assignment from a country
remove_region_tax_rule_assignment() - Method in class Billing\taxes
Remove an tax rule from a region
remove_server() - Method in class Licensing\license
Remove a license server
remove_setting() - Method in class KB\profile
Remove article from a category
remove_setting() - Method in class CMS\site
Remove a site setting
remove_support() - Method in class Customers\customer
Remove support
remove_taxes() - Method in class Billing\orders
Remove all of the order parts
remove_taxes() - Method in class Billing\package
Remove taxes from a package
remove_validation_rules() - Method in class Licensing\license
Remove all validation rules from a method
renewal_assign() - Method in class Billing\product
Assign a renewal to a sku
renewal_assignments() - Method in class Billing\product
Get the renewal product assignments
renewal_deassign() - Method in class Billing\product
Deassign a renewal from a sku
resend_password() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Send the resend password request.
resend_password() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Resend the user password based on e-mail address
return_credit_balance() - Method in class Billing\credit
Return an applied balance to the customer credit

S

s() - Function in package General_Use_Functions_Storefront
Convert data back to state before a()
save() - Method in class Framework\sortable
Saves the current sort order to the admin profile
save_attribute() - Method in class 3rd_Party_Modules\third_party
Get a list of all installed 3rd party module attributes.
save_attribute() - Method in class Billing\pay_gateways
Remove a pay gateway from an order form
save_campaign() - Method in class Mass_Mail\mass_mail
Save new mass campaign advanced settings
save_campaign_copy() - Method in class Mass_Mail\mass_mail
Save the e-mail copy
save_license_attribute() - Method in class Licensing\license
Save a license level attribute
save_licensing_method_attribute() - Method in class Licensing\license
Save the licensing method attribute
save_list() - Method in class Mass_Mail\mass_mail
Save changes to an existing list
save_notes() - Method in class Licensing\license
Remove a license level attribute
save_notes() - Method in class Customers\customer
Save customer notes
save_notes() - Method in class Framework\search
Save admin notes
save_order_notes_to_session() - Method in class Order_Forms\order_forms
Save the order notes to the primary session
save_promotion_code_to_session() - Method in class Order_Forms\order_forms
Save a promotion code to the primary session
save_validation_rules() - Method in class Licensing\license
Get a total count of predefined licenses
search() - Method in class Billing\price_sheet
Search price sheets
search() - Method in class Billing\product
Search products
search() - Method in class Billing\taxes
Search tax rules
search() - Method in class Licensing\license
Search license methods
search() - Method in class CMS\site
Search cms sites
search() - Method in class Billing\currency
Search currency entries
search() - Method in class Framework\cron
Search cron jobs
search() - Method in class Framework\localization
Search for localization
search() - Method in class Customer_Areas\customer_area
Search customer areas
search() - Method in class Billing\promotions
Search promotions
search() - Class in package Framework
SPBAS Search
search() - Method in class Framework\admin
Search for administrators
search() - Method in class Customers\customer
Customer Search
search() - Method in class KB\attachment
Search for attachments
search() - Method in class Billing\pay_gateways
Search pay gateways
search() - Method in class Agreements\agreements
Search for agreements
search() - Method in class CMS\page
Search CMS Pages
search() - Method in class KB\article
Search for KB articles
search() - Method in class KB\glossary
Search the glossary
search() - Method in class KB\profile
Search KB sites
search() - Method in class Billing\invoice
Search for invoices
search() - Method in class Users\user
Search users
search() - Method in class Storefront_API_Wrappers_KB\api_kb
Build the search page.
search() - Method in class Billing\orders
Search for orders
search() - Method in class Order_Forms\order_forms
Search order forms
search_license_logs() - Method in class Licensing\license
Search the license logs
search_licenses() - Method in class Licensing\license
Search licenses
search_licenses_api() - Method in class Licensing\license
Search license servers
search_logs() - Method in class Framework\email
Search e-mail logs
search_servers() - Method in class Licensing\license
Search license servers
security_question_select() - Method in class Customer_Areas\customer_area
Get a list of all security questions.
select() - Method in class KB\article
Array of attachments suitable for forms::select()
select() - Method in class System_Lib\forms
Displays a select box.
select() - Method in class KB\attachment
Array of attachments suitable for forms::select()
send() - Method in class Mass_Mail\mass_mail
Send mass mail!
send() - Method in class Framework\email
Compiles and sends the e-mail.
send_campaign() - Method in class Mass_Mail\mass_mail
Get all messages ready to be sent from the log
send_invoice_reminder() - Method in class Billing\invoice
Send an invoice reminder
send_new_invoice_email() - Method in class Billing\invoice
Send the new invoice e-mail
send_suspension_notice() - Method in class Billing\invoice
Send a suspension notice
send_test() - Method in class Mass_Mail\mass_mail
Send mass mail campaign test
servers_select() - Method in class Licensing\license
Get a list of all installed license servers in a forms::select() format
session_add_amount_due() - Method in class Order_Forms\order_forms
Add a promotional discount total
session_add_promotion_discounts() - Method in class Order_Forms\order_forms
Add a promotional discount total
session_extras() - Method in class Order_Forms\order_forms
Does the session exist?
session_payment() - Method in class Billing\pay_gateways
Record the payment
session_payment_by_transaction_id() - Method in class Billing\pay_gateways
Record the payment using the transaction ID
session_price_sheet_id() - Method in class Order_Forms\order_forms
Change the session status
session_status() - Method in class Order_Forms\order_forms
Change the session status
set_categories() - Method in class Media\media
Get all category IDs assigned to the set
set_cookie() - Function in package General_Use_Functions_Storefront
Wrapper to handle cookies
set_max_rows() - Method in class Users\user
Update the max_rows value for pagination
set_parent_package_id() - Method in class Billing\orders
Update an order part status
set_queued() - Method in class Mass_Mail\mass_mail
Set the campaign as queued
setup() - Class in package Framework
SPBAS General Setup
site() - Class in package CMS
SPBAS CMS Sites
skip_validation() - Method in class Framework\admin
List of modules and tasks that do not require authenication.
sku_pricing_id() - Method in class Billing\orders
Get the m3_product_sku_pricing id using the sku_id and the price_sheet_id
sortable() - Class in package Framework
SPBAS Datagrid Sortables
spinner() - Method in class System_Lib\forms
Generate a spinner
start_m3() - Function in package General_Use_Functions_Storefront
Recursively search for the configuration file!
start_session() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Start a new shopping cart session
start_session() - Method in class Order_Forms\order_forms
Start a cart session
states() - Method in class Framework\country_state
Get a states list.
states_simple() - Method in class Framework\country_state
Get a key / value pair list for states.
status() - Method in class Licensing\license
Update license status
submit() - Method in class System_Lib\forms
Displays a submit button.
sum_of_credits() - Method in class Billing\invoice
Get the sum of all credits applied to this invoice
sum_of_payments() - Method in class Billing\invoice
Get the sum of all payments made
support_package() - Class in package Support
SPBAS Support Packages
support_package_specific() - Method in class Framework\email_ui_helper
Support Package
support_package_support_package_specific() - Method in class Framework\email_ui_helper
Support Package, Control Specific
suspend_license() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Suspend a license.
sx() - Function in package General_Use_Functions_Storefront
Convert data back to state before a()

T

tab_template() - Method in class Framework\email_ui_helper
Assignment tab template
table_map() - Method in class Framework\email
Table mappings for e-mail templates
taxes() - Class in package Billing
SPBAS Tax Support
test_url() - Function in package General_Use_Functions_Storefront
Verify the url entered is valid.
text() - Method in class System_Lib\forms
Displays a text input box.
textarea() - Method in class System_Lib\forms
Displays a textarea box.
third_party() - Class in package 3rd_Party_Modules
SPBAS Third party modules and related hooks.
to_create() - Method in class Billing\invoice
Build an array of invoices that need to be created.
to_history() - Method in class CMS\page
Push the current page to history
to_unixtime() - Function in package General_Use_Functions_Storefront
Convert date to unix timestamp
toggle_article_in_category() - Method in class KB\article
Add article to category
toggle_article_relation() - Method in class KB\article
Remove attachment from article
toggle_attachment_for_article() - Method in class KB\article
Remove attachment from article
toggle_category_in_customer_area() - Method in class Media\media
Add category to the customer area public downloads
toggle_category_in_profile() - Method in class KB\profile
Add article to category
toggle_category_in_set() - Method in class Media\media
Add category to media set
toggle_page_in_site() - Method in class CMS\page
Add a page to a site
toggle_product_in_category() - Method in class Order_Forms\order_forms
Add product to order form and category
toggle_profile() - Method in class Framework\admin
Toggle an administrator profile value
toggle_setting() - Method in class KB\profile
Add article to category
toggle_setting() - Method in class CMS\site
Change site settings
top_currency() - Method in class Framework\search
The top currency
total() - Method in class KB\glossary
Get the total used.
total() - Method in class Framework\email
Get the total used.
total_config() - Method in class Framework\email
Get the total configurations used.
total_customers() - Method in class Framework\search
Total customer count
total_license_per_status() - Method in class Framework\search
Total licenses by status
total_licenses() - Method in class Framework\search
Total licenses
total_packages() - Method in class Framework\search
Total Packages
total_price_sheets() - Method in class Framework\search
Total Product Tiers
total_product_assets() - Method in class Framework\search
Total Product Assets
total_product_tiers() - Method in class Framework\search
Total Product Tiers
total_products() - Method in class Framework\search
Total Products
total_recipients() - Method in class Mass_Mail\mass_mail
Get the total recipients
total_recipients_enqueue() - Method in class Mass_Mail\mass_mail
Get the total recipients based on the queue
total_used() - Method in class Billing\promotions
Get a count of how many times this promotion has been used
total_users() - Method in class Framework\search
Total user count
types() - Method in class Billing\price_sheet
Types of price sheets

U

unassign_template() - Method in class Framework\email
Set an e-mail for exclusion.
undelete_order() - Method in class Billing\orders
Remove an order
unwrap_package() - Method in class API\api
Base64 decode the data and unserialize it back to an array.
update() - Method in class KB\profile
Update KB profile
update() - Method in class Billing\price_sheet
Update an existing price sheet
update() - Method in class KB\category
Update a category
update() - Method in class KB\glossary
Update an existing glossary entry.
update() - Method in class Customers\customer
Update customer.
update() - Method in class Billing\promotions
Update a promotion
update() - Method in class KB\attachment
Update an attachment
update() - Method in class Billing\taxes
Add a new tax rule
update() - Method in class Framework\setup
Add a new setup configuration
update() - Method in class Users\user
Update user details.
update() - Method in class Billing\product
Update the product record
update() - Method in class KB\article
Update an article
update() - Method in class Framework\localization
Update an existing language translation
update() - Method in class Billing\orders
Update the order
update() - Method in class CMS\page
Update site
update() - Method in class Framework\admin
Update an administrator account
update() - Method in class Billing\invoice
Update the invoice
update() - Method in class Agreements\agreements
Update an agreement
update() - Method in class 3rd_Party_Modules\third_party
Update an existing module
update() - Method in class Order_Forms\order_forms
Update an order form
update() - Method in class Billing\currency
Update an existing currency
update() - Method in class Customer_Areas\customer_area
Update a customer area
update() - Method in class CMS\site
Update site
update() - Method in class Framework\cron
Update a cron job
update_access() - Method in class Licensing\license
Update an access detail
update_address() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Update the customers address
update_address() - Method in class Customers\customer
Update a customer address record
update_advanced() - Method in class Order_Forms\order_forms
Update an order form
update_advanced() - Method in class Customer_Areas\customer_area
Update a customer area
update_advanced() - Method in class KB\profile
Update KB profile
update_advanced() - Method in class Billing\price_sheet
Update an existing price sheet
update_announcement() - Method in class Customer_Areas\customer_area
Update a customer area announcement
update_asset_qty() - Method in class Billing\product
Update asset qty
update_attributes() - Method in class KB\article
Update an article
update_cart() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Update the cart
update_category() - Method in class Customer_Areas\customer_area
Update a category
update_category() - Method in class Order_Forms\order_forms
Add a new category
update_category() - Method in class Media\media
Add a new category
update_comment() - Method in class Billing\orders
Update an order comment
update_config() - Method in class Framework\email
Update an e-mail configuration
update_contact() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Update a contact.
update_content() - Method in class CMS\page
Update css
update_control() - Method in class Media\download_control
Update a download control
update_creation_date() - Method in class Customers\customer
Update the creation date for an assigned download control or support package
update_creation_date() - Method in class Media\media
Update the creation date for an assigned download control or support package
update_credit() - Method in class Billing\credit
Update a customer credit
update_credit_balance() - Method in class Billing\credit
Update a customer credit balance
update_css() - Method in class CMS\page
Update css
update_customer_account() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Update the customer & user account.
update_email() - Method in class Framework\email
Update an existing e-mail template
update_email_advanced() - Method in class Framework\email
Update an existing e-mail template advanced settings
update_expiration_date() - Method in class Customers\customer
Update the expiration date for an assigned download control
update_fixed_price() - Method in class Billing\promotions
Ajax update fixed pricing
update_gateway() - Method in class Billing\pay_gateways
Update a pay gateway
update_gateway_logs() - Method in class Order_Forms\order_forms
Update the pay gateway logs
update_invoice() - Method in class Billing\invoice
Update an invoice
update_invoice_package_status() - Method in class Billing\pay_gateways
Update the invoice package status column
update_invoice_package_status() - Method in class Billing\invoice
Update the invoice package status column
update_invoice_status() - Method in class Billing\package
Update the invoice status column
update_license_key() - Method in class Licensing\license
Update the license key string
update_line_item() - Method in class Billing\invoice
Add a new line item to an invoice
update_line_item_detailed() - Method in class Billing\invoice
Update a line item in detail
update_mask() - Method in class Framework\localization
Update an existing language translation mask
update_module() - Method in class Licensing\license
Update an existing licensing method
update_my_info() - Method in class Storefront_API_Wrappers_Customers\api_customer_area
Change the logged in users information.
update_order_customer_id() - Method in class Order_Forms\order_forms
Save the order form ID and the customer area id to the session
update_package() - Method in class Support\support_package
Update a support package
update_package() - Method in class Billing\package
Update an existing package for the customer.
update_part_status() - Method in class Billing\orders
Update an order part status
update_part_tax() - Method in class Billing\invoice
Update the invoice total tax
update_part_tax() - Method in class Billing\orders
Update the tax totals per order part
update_part_totals() - Method in class Billing\invoice
Update the invoice part totals
update_password() - Method in class Users\user
Update the password
update_password() - Method in class Framework\login
Update the password
update_pay_gateway() - Method in class Billing\orders
Update the order gateway used for payment
update_payment() - Method in class Billing\invoice
Update an invoice payment
update_price() - Method in class Billing\product
Update the price
update_price_recurring() - Method in class Billing\product
Update the recurring price
update_price_sheet_label() - Method in class Order_Forms\order_forms
Update the price sheet label
update_pricing() - Method in class Billing\promotions
Update promotion fixed pricing
update_product_in_cart_session() - Method in class Order_Forms\order_forms
Add the product to the cart
update_profile_pic() - Method in class Framework\admin
Update the admin's profile pic
update_qty() - Method in class Order_Forms\order_forms
Update the item qty
update_recurring_invoices_created() - Method in class Billing\package
Update the package recurring total invoices created column
update_renewal_dates() - Method in class Billing\package
Update the package renewal dates
update_security_question() - Method in class Users\user
Update the security question
update_server() - Method in class Licensing\license
Update an existing license server
update_session() - Method in class Framework\login
Update the session
update_session() - Method in class Users\user
Update the session
update_session_TOS() - Method in class Order_Forms\order_forms
Change the Terms Of Service status for a session
update_set() - Method in class Media\media
Update a media set
update_settings() - Method in class CMS\page
Update site
update_setup_fee() - Method in class Billing\product
Update the setup fee
update_sku() - Method in class Billing\product
Update product sku
update_sku_pricing() - Method in class Billing\product
Update sku pricing
update_status() - Method in class Billing\pay_gateways
Update the invoice status
update_status() - Method in class Billing\invoice
Update the invoice status
update_status() - Method in class Billing\orders
Update an order status
update_totals() - Method in class Billing\invoice
Update the invoice totals
update_translation() - Method in class Framework\localization
Update an existing language translation
url() - Function in package General_Use_Functions_Storefront
Use https or not
user() - Class in package Users
SPBAS Users
user_id2company_id() - Method in class Customers\customer
Find the customer a user belongs to

V

valid_articles() - Method in class KB\category
Valid article ID's
valid_category_ids() - Method in class Media\media
Get a list of IDs to validate against
validate() - Method in class Billing\promotions
Validate a promotion
validate() - Method in class Framework\login
Validate the login
validate() - Method in class Users\user
Validate the login
validate() - Method in class ION\ion
Validate the verify sign
validate_addons() - Method in class Order_Forms\order_forms
Validate qty of an item in the cart
validate_by_email() - Method in class Framework\admin
Validate the admin
validate_customer() - Method in class Customers\customer
Validate an customer based on e-mail.
validate_customer_address() - Method in class Customers\customer
Validate an customer contact based on customer id and contact type.
validate_email() - Method in class Framework\login
Validate the email belongs to an account
validate_qty() - Method in class Order_Forms\order_forms
Validate qty of an item in the cart
validate_user() - Method in class Users\user
Validate an user based on e-mail.
value() - Method in class System_Lib\forms
Sets the default value for a posted form

W

w() - Function in package General_Use_Functions_Storefront
Localization wrapper function based on $GLOBALS['conf']['localization']
whois_email() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Check to see if the e-mail address in question is already taken.
whois_username() - Method in class Storefront_API_Wrappers_Order\api_order_forms
Check to see if the username in question is already taken.
write_addon_lookup() - Method in class Import\import
Add a addon lookup record
write_complete() - Method in class Mass_Mail\mass_mail
Mark the campaign as complete
write_customer_area_lookup() - Method in class Import\import
Add a customer lookup record
write_customer_lookup() - Method in class Import\import
Add a customer lookup record
write_download_lookup() - Method in class Import\import
Add a product lookup record
write_invoice_lookup() - Method in class Import\import
Add an invoice lookup record
write_last_run() - Method in class Mass_Mail\mass_mail
Set the campaign last run date
write_last_run_queued() - Method in class Mass_Mail\mass_mail
Set the campaign last run date
write_licensing_type_lookup() - Method in class Import\import
Add a product lookup record
write_orders_lookup() - Method in class Import\import
Add an order lookup record
write_product_lookup() - Method in class Import\import
Add a product lookup record
write_support_package_lookup() - Method in class Import\import
Add a support package lookup record
write_to_queue() - Method in class Mass_Mail\mass_mail
Write the mass mail queue
write_to_queue_complete() - Method in class Mass_Mail\mass_mail
Set a queue entry to complete
write_upgrade_package_lookup() - Method in class Import\import
Add a upgrade package lookup record
write_verify_sign() - Method in class ION\ion
Write the verify sign

X

x() - Function in package General_Use_Functions_Storefront
Allows you to find a value in $_GET, $_POST and then $_COOKIE.

Y

years() - Function in package General_Use_Functions_Storefront
All possible days (integer).

SPBAS v1.7 API Documentation