2017-05-15 22:49:53 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WooCommerce Importer Interface
|
|
|
|
*
|
2018-03-06 08:19:31 +00:00
|
|
|
* @package WooCommerce/Interface
|
2017-05-15 22:49:53 +00:00
|
|
|
* @version 3.1.0
|
|
|
|
*/
|
2018-03-06 08:19:31 +00:00
|
|
|
|
2017-05-15 22:49:53 +00:00
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
|
|
exit;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* WC_Importer_Interface class.
|
|
|
|
*/
|
|
|
|
interface WC_Importer_Interface {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Process importation.
|
2017-05-15 23:11:16 +00:00
|
|
|
* Returns an array with the imported and failed items.
|
|
|
|
* 'imported' contains a list of IDs.
|
|
|
|
* 'failed' contains a list of WP_Error objects.
|
2017-05-15 22:49:53 +00:00
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
* ['imported' => [], 'failed' => []]
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function import();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get file raw keys.
|
|
|
|
*
|
|
|
|
* CSV - Headers.
|
|
|
|
* XML - Element names.
|
|
|
|
* JSON - Keys
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_raw_keys();
|
|
|
|
|
2017-05-16 04:43:15 +00:00
|
|
|
/**
|
|
|
|
* Get file mapped headers.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_mapped_keys();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get raw data.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_raw_data();
|
|
|
|
|
2017-05-15 22:49:53 +00:00
|
|
|
/**
|
|
|
|
* Get parsed data.
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_parsed_data();
|
2017-05-18 23:18:46 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get file pointer position from the last read.
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function get_file_position();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get file pointer position as a percentage of file size.
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function get_percent_complete();
|
2017-05-15 22:49:53 +00:00
|
|
|
}
|