store.module
Version
1.125.2.23.2.17.2.50.2.148 (checked in on 2008/06/12 at 17:34:03 by brmassa)
Description
store.module The store module provides the core e-Commerce functionality. It provides many pages for transaction and general e-Commerce site management.
@todo: Add a store_set_workflow($txnid, $state) and store_get_workflow($txnid). Function must use store_transaction_save(array('txnid' => $txnid, 'workflow' => N)) to ensure hooks are called properly. See payment_set_status() for more information.
Constants
Name | Description |
|---|---|
| ECMAIL_TYPE_ASK_CUSTOMER | |
| ECMAIL_TYPE_CANCEL_TXN | |
| ECMAIL_TYPE_CUSTOMER_INVOICE | @name e-Commerce Mail Types |
| ECMAIL_TYPE_PROCESSING_ERROR | |
| EC_ALLOC_COMPLETED | |
| EC_ALLOC_PART | |
| EC_ALLOC_PENDING | @name Transaction allocation statuses |
| EC_WORKFLOW_CANCELED | |
| EC_WORKFLOW_COMPLETED | |
| EC_WORKFLOW_INVOICED | |
| EC_WORKFLOW_PACKAGED | |
| EC_WORKFLOW_RECEIVED | @name Workflow statuses |
| EC_WORKFLOW_SECURITY_VIOLATION | |
| EC_WORKFLOW_SHIPPED | |
| EC_WORKFLOW_WAITING_RESPONSE | |
| MAILVAR_ASK_CUSTOMER | |
| MAILVAR_CANCEL_TXN | |
| MAILVAR_CUSTOMER_INVOICE | @name e-Commerce Mail Callbacks |
| MAILVAR_PROCESSING_ERROR | |
| STORE_TOKEN_TYPE | e-Commerce token type used to define tokens.See alsostore_token_list(), store_token_values() |
Functions
| Name | Description |
|---|---|
| store_adjust_misc | Add all the invisible miscellaneous transaction to an item |
| store_allocation_info | Implementation of hook_allocation_info() |
| store_alloc_allocation | |
| store_alloc_build_items | |
| store_alloc_get_address | Get the billing or shipping address from a transaction |
| store_alloc_get_currency | |
| store_alloc_get_customer | Get all customer data from a transaction |
| store_alloc_get_customer_names | Get the customer name from a given transaction. If it was not previously defined into first and last names, it must be extracted thru Regex |
| store_alloc_get_invoice_no | |
| store_alloc_get_items | |
| store_alloc_get_payment_data | Implementation of hook_alloc_get_payment_data() |
| store_alloc_get_payment_form | Implmentation of hook_alloc_get_payment_form() |
| store_alloc_get_payment_type | Implmentation of hook_alloc_get_payment_type() |
| store_alloc_get_total | Implmentation of hook_alloc_get_total() |
| store_alloc_load | Implementation of hook_alloc_load() |
| store_alloc_set_payment_data | Implementation of hook_alloc_set_payment_data() |
| store_cron | Implementation of hook_cron(). |
| store_ec_transactionapi | Implementation of hook_ec_transactionapi(). |
| store_ec_transaction_post | Implementation of hook_ec_transaction_post() |
| store_ec_txn_workflow | Implementation of hook_ec_txn_workflow() |
| store_ec_widgets | Implementation of hook_ec_widgets(). |
| store_form_alter | Implementation of hook_form_alter() |
| store_get_country | Get the country name from the Id |
| store_get_country_id | Search for the Id of a country. |
| store_help | Implementation of hook_help(). |
| store_invoice | A wrapper for theme('store_invoice') |
| store_invoiceapi | Implementation of hook_invoiceapi() |
| store_invoke_ec_transactionapi | Invoke a hook_ec_transactionapi() operation in all modules. |
| store_link | Implementation of hook_link() |
| store_menu | Implementation of hook_menu(). |
| store_name_measure | Get a currently configured measure label. Pass 'weight' and KG to get Kilograms If you leave $measure empty, the saved value is used. |
| store_quicklist_header | Get a quick html header for printable pages. |
| store_recalc_transaction | Recalc product prices and associated charges on the transaction. |
| store_search_misc | Look for a miscellaneous items on a transaction. |
| store_token_list | Implements hook_token_list() from the token module. |
| store_token_values | Implements hook_token_values() from the token module. |
| store_transaction_address_fields | Return the fields of the transaction_address table. |
| store_transaction_allocation | Returns an array of allocation status IDs and corresponding descriptions. |
| store_transaction_cache | store_transaction_cache() |
| store_transaction_calc_gross | Calculate the total of the invoice |
| store_transaction_cancel | |
| store_transaction_fields | Return the fields of the transaction table. |
| store_transaction_load | Load a transaction. |
| store_transaction_misc_fields | Return the fields of the transaction_misc table. |
| store_transaction_product_fields | Return the fields of the transaction_product table. |
| store_transaction_save | Save a transaction to the database. |
| store_transaction_save_misc | Save Miscellaneous transactions |
| store_transaction_workflow | Returns an array of workflow status IDs and corresponding descriptions. |
| transaction_get_allocation | Get the descriptive name of an allocation ID. |
| transaction_get_workflow | Get the descriptive name of an workflow ID. |
| transaction_get_workflow_id | Legacy, get a workflow ID by descriptive name. |
| transaction_set_workflow | Sets the workflow state of the given transation to the state given. This function accepts both the textual state and the numeric state. If a textual state (valid values are in store_transaction_workflow()) is given it will be converted to the... |
| transaction_valid_workflow | Legacy; determine if a passed workflow id is valid. |