class-wc-abstract-order-data-store-interface.php
4 years ago
class-wc-coupon-data-store-interface.php
4 years ago
class-wc-customer-data-store-interface.php
4 years ago
class-wc-customer-download-data-store-interface.php
4 years ago
class-wc-customer-download-log-data-store-interface.php
4 years ago
class-wc-importer-interface.php
4 years ago
class-wc-log-handler-interface.php
4 years ago
class-wc-logger-interface.php
4 years ago
class-wc-object-data-store-interface.php
4 years ago
class-wc-order-data-store-interface.php
4 years ago
class-wc-order-item-data-store-interface.php
3 years ago
class-wc-order-item-product-data-store-interface.php
4 years ago
class-wc-order-item-type-data-store-interface.php
4 years ago
class-wc-order-refund-data-store-interface.php
4 years ago
class-wc-payment-token-data-store-interface.php
4 years ago
class-wc-product-data-store-interface.php
4 years ago
class-wc-product-variable-data-store-interface.php
4 years ago
class-wc-queue-interface.php
4 years ago
class-wc-shipping-zone-data-store-interface.php
4 years ago
class-wc-webhooks-data-store-interface.php
4 years ago
class-wc-importer-interface.php
73 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Importer Interface |
| 4 | * |
| 5 | * @package WooCommerce\Interface |
| 6 | * @version 3.1.0 |
| 7 | */ |
| 8 | |
| 9 | /** |
| 10 | * WC_Importer_Interface class. |
| 11 | */ |
| 12 | interface WC_Importer_Interface { |
| 13 | |
| 14 | /** |
| 15 | * Process importation. |
| 16 | * Returns an array with the imported and failed items. |
| 17 | * 'imported' contains a list of IDs. |
| 18 | * 'failed' contains a list of WP_Error objects. |
| 19 | * |
| 20 | * Example: |
| 21 | * ['imported' => [], 'failed' => []] |
| 22 | * |
| 23 | * @return array |
| 24 | */ |
| 25 | public function import(); |
| 26 | |
| 27 | /** |
| 28 | * Get file raw keys. |
| 29 | * |
| 30 | * CSV - Headers. |
| 31 | * XML - Element names. |
| 32 | * JSON - Keys |
| 33 | * |
| 34 | * @return array |
| 35 | */ |
| 36 | public function get_raw_keys(); |
| 37 | |
| 38 | /** |
| 39 | * Get file mapped headers. |
| 40 | * |
| 41 | * @return array |
| 42 | */ |
| 43 | public function get_mapped_keys(); |
| 44 | |
| 45 | /** |
| 46 | * Get raw data. |
| 47 | * |
| 48 | * @return array |
| 49 | */ |
| 50 | public function get_raw_data(); |
| 51 | |
| 52 | /** |
| 53 | * Get parsed data. |
| 54 | * |
| 55 | * @return array |
| 56 | */ |
| 57 | public function get_parsed_data(); |
| 58 | |
| 59 | /** |
| 60 | * Get file pointer position from the last read. |
| 61 | * |
| 62 | * @return int |
| 63 | */ |
| 64 | public function get_file_position(); |
| 65 | |
| 66 | /** |
| 67 | * Get file pointer position as a percentage of file size. |
| 68 | * |
| 69 | * @return int |
| 70 | */ |
| 71 | public function get_percent_complete(); |
| 72 | } |
| 73 |