Automattic\WooCommerce\Internal\ProductFeed\Integrations

IntegrationInterface{}interfaceWC 10.5.0

IntegrationInterface

No Hooks.

Usage

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

Methods

  1. public activate()
  2. public create_feed()
  3. public deactivate()
  4. public get_feed_validator()
  5. public get_id()
  6. public get_product_feed_query_args()
  7. public get_product_mapper()
  8. public register_hooks()
  9. ERROR: no method name found on line `* Register hooks for the integration.`
  10. ERROR: no method name found on line ``
  11. ERROR: no method name found on line `* Activate the integration.`
  12. ERROR: no method name found on line `* Get the ID of the provider.`
  13. ERROR: no method name found on line ``

Changelog

Since 10.5.0 Introduced.

IntegrationInterface{} code WC 10.5.0

interface IntegrationInterface {
	/**
	 * Get the ID of the provider.
	 *
	 * @return string The ID of the provider.
	 */
	public function get_id(): string;

	/**
	 * Register hooks for the integration.
	 *
	 * @return void
	 */
	public function register_hooks(): void;

	/**
	 * Activate the integration.
	 *
	 * This method is called when the plugin is activated.
	 * If there is ever a setting that controls active integrations,
	 * this method might also be called when the integration is activated.
	 *
	 * @return void
	 */
	public function activate(): void;

	/**
	 * Deactivate the integration.
	 *
	 * This method is called when the plugin is deactivated.
	 * If there is ever a setting that controls active integrations,
	 * this method might also be called when the integration is deactivated.
	 *
	 * @return void
	 */
	public function deactivate(): void;

	/**
	 * Get the query arguments for the product feed.
	 *
	 * @see wc_get_products()
	 * @return array The query arguments.
	 */
	public function get_product_feed_query_args(): array;

	/**
	 * Create a feed that is to be populated.
	 *
	 * @return FeedInterface The feed.
	 */
	public function create_feed(): FeedInterface;

	/**
	 * Get the product mapper for the provider.
	 *
	 * @return ProductMapperInterface The product mapper.
	 */
	public function get_product_mapper(): ProductMapperInterface;

	/**
	 * Get the feed validator for the provider.
	 *
	 * @return FeedValidatorInterface The feed validator.
	 */
	public function get_feed_validator(): FeedValidatorInterface;
}