WordPress at Your Fingertips
class is not described

WC_Importer_Interface{} WC 1.0

WC_Importer_Interface class.

No Hooks.

Return

null. Nothing.

Usage

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

Methods

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

Code of WC_Importer_Interface{} WC 5.5.2

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