order_forms
public class order_forms
| Method Summary | |
|---|---|
| integer|boolean | add(string status, integer price_sheet_id, string can_change_currency, string name, string url, string maintenance_message, integer email_configuration_id, integer default_pay_gateway_id, integer default_customer_area_id) Add a order form |
| integer|boolean | add_category(integer order_form_id, string name, integer parent_id, string status, string icon) Add a new category |
| boolean | add_customer_user_id2session(integer session_id, integer customer_id, integer user_id) Add the order id to the session |
| boolean | add_invoice_to_cart_session(integer session_id, integer invoice_id) Add the invoice to the cart |
| boolean | add_order_id2session(integer session_id, integer order_id) Add the order id to the session |
| boolean | add_pricing(integer order_form_id, integer price_sheet_id, string name) Add pricing to an order form |
| boolean | add_product_to_cart_session(integer session_id, integer product_id, integer sku_id, integer qty, string is_addon, integer package_id) Add the product to the cart |
| array | apply_discounts(array cart) Remove an item from the cart |
| array | apply_taxes(array cart, array taxes, mixed total_due_today, mixed total_order) Apply taxes to the cart |
| string | breadcrumb(integer order_form_id, integer parent_id, array buffer) Convert breadcrumb array to string |
| array | breadcrumb_array(integer id, array buffer, boolean no_root_category) Get a breadcrumb array |
| string | breadcrumb_cart(integer order_form_id, integer parent_id, integer base_category_id) Convert breadcrumb array to string for order/cart.php |
| array | cart_contents(mixed session_id) Get the cart contents |
| boolean | category_display_order(integer category_id, integer display_order) Change the category display order |
| array | category_products(integer order_form_id, integer category_id, mixed status) Get all product IDs for a category |
| array | category_tree_select(integer parent_id, integer tick, string separator) Category tree for select box |
| array | change_currency_option(string can_change_currency, integer order_form_id) Get a list of all price sheets |
| array | compile_cart(array cart, string session) Compile the cart into a usable array |
| integer|boolean | currency_changer(string session_id, integer price_sheet_id, integer order_form_id, integer customer_id) Change the session status |
| array | customer_price_sheet(string session, mixed customer_session) Add the customer & user ID to the session if logged and determine assigned price sheet, if any. |
| boolean | delete(integer id) Delete an order form |
| boolean | delete_category(integer category_id) Delete a category and all of it's children |
| boolean | delete_order_form_jcategories(integer category_id) Delete a category and all of it's children from the join table |
| boolean | delete_price_sheets(integer order_form_id) Delete the price sheets for an order form |
| string | download_conf(integer order_form_id) Download the order form configuration file |
| array | excluded_addons(integer sku_id) Get all excluded addons for a price tier |
| boolean | fix_qty(integer id, integer qty) The qty in the cart is out of bounds with the min/max order limits |
| array|boolean | get(integer id) Get the order form data |
| array | get_agreements(mixed id, integer order_form_id) Get an agreements assigned to the order form |
| array | get_all() Get a list of all order forms |
| array | get_all_pricing(integer order_form_id) Get a list of all price sheets |
| array | get_all_pricing_wp(integer order_form_id, string sort, array link_extras) Get a list of all price sheets with pagination. |
| array | get_all_wp(string sort, array link_extras) Get a list of all order forms with pagination. |
| array|boolean | get_by(string api_key) Get the order form data using the api key |
| array | get_categories(integer order_form_id, integer parent_id, mixed status) Get all categories |
| array|boolean | get_category(integer id) Get category details |
| array|boolean | get_customer_price_sheet(integer customer_id) Get all price sheets assigned to a customer |
| array|boolean | get_session(integer session_id, integer order_id) Get the session data |
| array|boolean | get_session_by_transaction_id(integer transaction_id) Get the session data |
| array | get_session_extras(integer session_id) Get the sessio ndata |
| array|boolean | get_session_order_notes(integer session_id) Get the order notes |
| boolean | is_valid_customer_price_sheet(integer customer_id, integer price_sheet_id) Make sure the customer is actually assigned the said price_sheet_id |
| boolean | is_valid_price_sheet_for_order_form(integer order_form_id, integer price_sheet_id) Do we have a valid price sheet for the order form? |
| boolean | isset_product_in_cart_session(integer session_id, integer product_id, string sku_id, string is_addon) Is the product already in the cart? |
| boolean | isset_product_in_category(integer product_id, integer category_id, integer order_form_id) Is the product already assigned to the category? |
| boolean | isset_session(string session_id) Does the session exist? |
| boolean | lock_session(integer session_id, integer transaction_id) Lock the session |
| integer | Get the default configuration asc |
| boolean | make_pay_gateway_default(integer order_form_id, integer default_pay_gateway_id) Make a pay gateway the default for the order form |
| array | Make a select box suitable for forms::select() |
| array | make_select_caa(array order_forms) Make a select box suitable for forms::select() |
| array | order_complete_summary(string access_key) Remove an item from the cart |
| boolean | product_display_order(integer product_id, integer category_id, integer order_form_id, integer display_order) Change the product display order |
| boolean | remove_from_cart(integer cart_item_id, integer qty) Remove an item from the cart |
| boolean | remove_invoice_from_cart_session(integer session_id, integer invoice_id) Remove the invoice from the cart |
| boolean | remove_pricing(integer order_form_id, integer price_sheet_id) Add pricing to an order form |
| boolean | remove_product_from_category(integer product_id, integer category_id, integer order_form_id) Remove product from the category and order form |
| boolean | remove_promotion_code_to_session(integer session_id) Remove a promotion code from the primary session |
| boolean | save_order_notes_to_session(integer session_id, string order_notes) Save the order notes to the primary session |
| boolean | save_promotion_code_to_session(integer session_id, string promotion_code, string promotion_code_description) Save a promotion code to the primary session |
| array | search(string terms, string sort_by, string order, array link_extras, integer id) Search order forms |
| boolean | session_add_amount_due(integer session_id, decimal amount_due) Add a promotional discount total |
| boolean | session_add_promotion_discounts(integer session_id, decimal promotion_discounts) Add a promotional discount total |
| boolean | session_extras(string session_id, string key, string value) Does the session exist? |
| boolean | session_price_sheet_id(integer session_id, string price_sheet_id) Change the session status |
| boolean | session_status(integer session_id, string status) Change the session status |
| string|boolean | start_session(string session_id) Start a cart session |
| boolean | toggle_product_in_category(mixed product_id, integer category_id, mixed order_form_id, integer set_id) Add product to order form and category |
| boolean | update(integer id, string status, string name, string url, string maintenance_message) Update an order form |
| boolean | update_advanced(integer id, integer price_sheet_id, string can_change_currency, integer email_configuration_id, integer default_customer_area_id, string ion) Update an order form |
| boolean | update_category(integer id, string name, string description, integer parent_id, string status, string is_default, integer order_form_id, string icon) Add a new category |
| boolean | update_gateway_logs(integer session_id, integer order_id, integer customer_id, integer user_id) Update the pay gateway logs |
| boolean | update_order_customer_id(integer session_id, integer order_form_id, integer customer_area_id) Save the order form ID and the customer area id to the session |
| boolean | update_price_sheet_label(string name, integer order_form_id, integer price_sheet_id) Update the price sheet label |
| boolean | update_product_in_cart_session(integer session_id, integer product_id, integer sku_id, integer qty, string is_addon) Add the product to the cart |
| boolean | update_qty(integer cart_item_id, integer qty) Update the item qty |
| boolean | update_session_TOS(integer session_id, string tos) Change the Terms Of Service status for a session |
| array | validate_addons(interger sku_id, array addons) Validate qty of an item in the cart |
| array | validate_qty(array cart) Validate qty of an item in the cart |
public integer|boolean add(string status, integer price_sheet_id, string can_change_currency, string name, string url, string maintenance_message, integer email_configuration_id, integer default_pay_gateway_id, integer default_customer_area_id)
Add a order form
public integer|boolean add_category(integer order_form_id, string name, integer parent_id, string status, string icon)
Add a new category
public boolean add_customer_user_id2session(integer session_id, integer customer_id, integer user_id)
Add the order id to the session
public boolean add_invoice_to_cart_session(integer session_id, integer invoice_id)
Add the invoice to the cart
public boolean add_order_id2session(integer session_id, integer order_id)
Add the order id to the session
public boolean add_pricing(integer order_form_id, integer price_sheet_id, string name)
Add pricing to an order form
public boolean add_product_to_cart_session(integer session_id, integer product_id, integer sku_id, integer qty, string is_addon, integer package_id)
Add the product to the cart
public array apply_discounts(array cart)
Remove an item from the cart
public array apply_taxes(array cart, array taxes, mixed total_due_today, mixed total_order)
Apply taxes to the cart
public string breadcrumb(integer order_form_id, integer parent_id, array buffer)
Convert breadcrumb array to string
public array breadcrumb_array(integer id, array buffer, boolean no_root_category)
Get a breadcrumb array
public string breadcrumb_cart(integer order_form_id, integer parent_id, integer base_category_id)
Convert breadcrumb array to string for order/cart.php
public array cart_contents(mixed session_id)
Get the cart contents
public boolean category_display_order(integer category_id, integer display_order)
Change the category display order
public array category_products(integer order_form_id, integer category_id, mixed status)
Get all product IDs for a category
public array category_tree_select(integer parent_id, integer tick, string separator)
Category tree for select box
public array change_currency_option(string can_change_currency, integer order_form_id)
Get a list of all price sheets
public array compile_cart(array cart, string session)
Compile the cart into a usable array
public integer|boolean currency_changer(string session_id, integer price_sheet_id, integer order_form_id, integer customer_id)
Change the session status
public array customer_price_sheet(string session, mixed customer_session)
Add the customer & user ID to the session if logged and determine assigned price sheet, if any.
public boolean delete(integer id)
Delete an order form
public boolean delete_category(integer category_id)
Delete a category and all of it's children
public boolean delete_order_form_jcategories(integer category_id)
Delete a category and all of it's children from the join table
public boolean delete_price_sheets(integer order_form_id)
Delete the price sheets for an order form
public string download_conf(integer order_form_id)
Download the order form configuration file
public array excluded_addons(integer sku_id)
Get all excluded addons for a price tier
public boolean fix_qty(integer id, integer qty)
The qty in the cart is out of bounds with the min/max order limits
public array|boolean get(integer id)
Get the order form data
public array get_agreements(mixed id, integer order_form_id)
Get an agreements assigned to the order form
public array get_all()
Get a list of all order forms
public array get_all_pricing(integer order_form_id)
Get a list of all price sheets
public array get_all_pricing_wp(integer order_form_id, string sort, array link_extras)
Get a list of all price sheets with pagination.
public array get_all_wp(string sort, array link_extras)
Get a list of all order forms with pagination.
public array|boolean get_by(string api_key)
Get the order form data using the api key
public array get_categories(integer order_form_id, integer parent_id, mixed status)
Get all categories
public array|boolean get_category(integer id)
Get category details
public array|boolean get_customer_price_sheet(integer customer_id)
Get all price sheets assigned to a customer
public array|boolean get_session(integer session_id, integer order_id)
Get the session data
public array|boolean get_session_by_transaction_id(integer transaction_id)
Get the session data
public array get_session_extras(integer session_id)
Get the sessio ndata
public array|boolean get_session_order_notes(integer session_id)
Get the order notes
public boolean is_valid_customer_price_sheet(integer customer_id, integer price_sheet_id)
Make sure the customer is actually assigned the said price_sheet_id
public boolean is_valid_price_sheet_for_order_form(integer order_form_id, integer price_sheet_id)
Do we have a valid price sheet for the order form?
public boolean isset_product_in_cart_session(integer session_id, integer product_id, string sku_id, string is_addon)
Is the product already in the cart?
public boolean isset_product_in_category(integer product_id, integer category_id, integer order_form_id)
Is the product already assigned to the category?
public boolean isset_session(string session_id)
Does the session exist?
public boolean lock_session(integer session_id, integer transaction_id)
Lock the session
public integer make_default()
Get the default configuration asc
public boolean make_pay_gateway_default(integer order_form_id, integer default_pay_gateway_id)
Make a pay gateway the default for the order form
public array make_select()
Make a select box suitable for forms::select()
public array make_select_caa(array order_forms)
Make a select box suitable for forms::select()
public array order_complete_summary(string access_key)
Remove an item from the cart
public boolean product_display_order(integer product_id, integer category_id, integer order_form_id, integer display_order)
Change the product display order
public boolean remove_from_cart(integer cart_item_id, integer qty)
Remove an item from the cart
public boolean remove_invoice_from_cart_session(integer session_id, integer invoice_id)
Remove the invoice from the cart
public boolean remove_pricing(integer order_form_id, integer price_sheet_id)
Add pricing to an order form
public boolean remove_product_from_category(integer product_id, integer category_id, integer order_form_id)
Remove product from the category and order form
public boolean remove_promotion_code_to_session(integer session_id)
Remove a promotion code from the primary session
public boolean save_order_notes_to_session(integer session_id, string order_notes)
Save the order notes to the primary session
public boolean save_promotion_code_to_session(integer session_id, string promotion_code, string promotion_code_description)
Save a promotion code to the primary session
public array search(string terms, string sort_by, string order, array link_extras, integer id)
Search order forms
public boolean session_add_amount_due(integer session_id, decimal amount_due)
Add a promotional discount total
public boolean session_add_promotion_discounts(integer session_id, decimal promotion_discounts)
Add a promotional discount total
public boolean session_extras(string session_id, string key, string value)
Does the session exist?
public boolean session_price_sheet_id(integer session_id, string price_sheet_id)
Change the session status
public boolean session_status(integer session_id, string status)
Change the session status
public string|boolean start_session(string session_id)
Start a cart session
public boolean toggle_product_in_category(mixed product_id, integer category_id, mixed order_form_id, integer set_id)
Add product to order form and category
public boolean update(integer id, string status, string name, string url, string maintenance_message)
Update an order form
public boolean update_advanced(integer id, integer price_sheet_id, string can_change_currency, integer email_configuration_id, integer default_customer_area_id, string ion)
Update an order form
public boolean update_category(integer id, string name, string description, integer parent_id, string status, string is_default, integer order_form_id, string icon)
Add a new category
public boolean update_gateway_logs(integer session_id, integer order_id, integer customer_id, integer user_id)
Update the pay gateway logs
public boolean update_order_customer_id(integer session_id, integer order_form_id, integer customer_area_id)
Save the order form ID and the customer area id to the session
public boolean update_price_sheet_label(string name, integer order_form_id, integer price_sheet_id)
Update the price sheet label
public boolean update_product_in_cart_session(integer session_id, integer product_id, integer sku_id, integer qty, string is_addon)
Add the product to the cart
public boolean update_qty(integer cart_item_id, integer qty)
Update the item qty
public boolean update_session_TOS(integer session_id, string tos)
Change the Terms Of Service status for a session
public array validate_addons(interger sku_id, array addons)
Validate qty of an item in the cart
public array validate_qty(array cart)
Validate qty of an item in the cart
SPBAS Order Forms