class-wc-abstract-order-data-store-interface.php 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * Order Data Store Interface
  4. *
  5. * @version 3.0.0
  6. * @package WooCommerce/Interfaces
  7. */
  8. if ( ! defined( 'ABSPATH' ) ) {
  9. exit;
  10. }
  11. /**
  12. * WC Order Data Store Interface
  13. *
  14. * Functions that must be defined by order store classes.
  15. *
  16. * @version 3.0.0
  17. */
  18. interface WC_Abstract_Order_Data_Store_Interface {
  19. /**
  20. * Read order items of a specific type from the database for this order.
  21. *
  22. * @param WC_Order $order Order object.
  23. * @param string $type Order item type.
  24. * @return array
  25. */
  26. public function read_items( $order, $type );
  27. /**
  28. * Remove all line items (products, coupons, shipping, taxes) from the order.
  29. *
  30. * @param WC_Order $order Order object.
  31. * @param string $type Order item type. Default null.
  32. */
  33. public function delete_items( $order, $type = null );
  34. /**
  35. * Get token ids for an order.
  36. *
  37. * @param WC_Order $order Order object.
  38. * @return array
  39. */
  40. public function get_payment_token_ids( $order );
  41. /**
  42. * Update token ids for an order.
  43. *
  44. * @param WC_Order $order Order object.
  45. * @param array $token_ids Token IDs.
  46. */
  47. public function update_payment_token_ids( $order, $token_ids );
  48. }