WC_Importer_Interface{} │ interface │ WC 1.0

WC_Importer_Interface class.

No Hooks.

Usage

$WC_Importer_Interface = new WC_Importer_Interface();
// use class methods

Methods

1. public import()
2. public get_raw_keys()
3. public get_mapped_keys()
4. public get_raw_data()
5. public get_parsed_data()
6. public get_file_position()
7. public get_percent_complete()

WC_Importer_Interface{} WC Importer Interface{} code ^{WC 9.9.4}

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();
}