APP_Order
Represents a purchase order made up of items.
Package
Contents
Description Description
Methods Methods
- __construct — Sets up the order objects
- add_data — Adds data to the Order.
- add_item — Adds an item to the order.
- clear_gateway — Clears this order from being assocaited with a gateway.
- get_author — Returns the User ID of the creator of the order
- get_cancel_url — Returns the URL to redirect to for selecting a new gateway
- get_currency — Returns the current currency's code. See APP_Currency
- get_data — Retrieves a piece of data added to the order via add_data()
- get_description — Returns the Order description
- get_display_status
- get_gateway — Returns the gateway that should be used to process this order
- get_id — Returns the Order ID
- get_info
- get_ip_address — Returns the IP Address used to create the order
- get_item — Returns the first item in an order, or another as specified
- get_items — Returns an array of all the items in an order that match a given type, or all items in the order.
- get_log — Retrieves log messages
- get_meta_field
- get_parent — Returns the id of the parent post
- get_return_url — Returns the URL to redirect to for processing the order
- get_status — Returns the current state of the order
- get_status_identifier
- get_total — Returns the total price of the order
- get_url — Returns the URL for an order. Useful for getting the URL without building the order.
- is_escrow — Returns true if the order recurrs.
- is_recurring — Returns true if the order recurrs
- log — Log a message concerning this order
- refresh_total — Recalculates the total of the order.
- remove_item — Removes an item or items from the order. Removes all items that match the criteria Use remove_item_by_index for super-specific removal.
- remove_item_by_id
- schedule_payment — Schedules the order to attempt be completed at a certain time
- set_author
- set_currency — Sets the currency to be used in this order.
- set_description
- set_gateway — Sets the gateway this order should be processed with
- set_status — Sets the order statues and sends out correct action hooks.
- update_meta — Updates the meta fields for the post
- update_post — Updates the order's post data
