73 lines
1.1 KiB
PHP
73 lines
1.1 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* WooCommerce Importer Interface
|
||
|
|
*
|
||
|
|
* @package WooCommerce\Interface
|
||
|
|
* @version 3.1.0
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* WC_Importer_Interface class.
|
||
|
|
*/
|
||
|
|
interface WC_Importer_Interface {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Process importation.
|
||
|
|
* Returns an array with the imported and failed items.
|
||
|
|
* 'imported' contains a list of IDs.
|
||
|
|
* 'failed' contains a list of WP_Error objects.
|
||
|
|
*
|
||
|
|
* 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();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get file mapped headers.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_mapped_keys();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get raw data.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_raw_data();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get parsed data.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function get_parsed_data();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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();
|
||
|
|
}
|