Import_Products

Handles the import process for products from BigCommerce.

This class defines a WP-CLI command to import products from a connected BigCommerce store. It provides functionality for full or partial imports, the option to force a refresh of products, and hooks for tracking the progress of the import. Additionally, it manages logging for the import process and allows for managing product data through various stages of the import.

• Full name: \BigCommerce\CLI\Import_Products
• Parent class: \BigCommerce\CLI\Command

Methods

command

Declare command name

protected command(): string

Return Value:

The command name for importing products.

description

Add a command description

protected description(): string|void

Return Value:

A description of the import products command.

arguments

Declare command arguments

protected arguments(): array[]

Return Value:

Command arguments for the import products command.

run

Execute the import process.

public run(array $args, array $assoc_args): void

Parameters:

Inherited methods

register

Register the command with WP-CLI.

public register(): void

This method checks if WP-CLI is defined and active. If so, it registers the command with WP-CLI, using the specific command name defined in the child class.

command

Get the command name.

protected command(): string

This method must be implemented in the child class to return the specific command name.

• This method is abstract.

Return Value:

The name of the WP-CLI command.

description

Get a short description of the command.

protected description(): string

This method must be implemented in the child class to provide a brief description of the command’s functionality, which will be shown in the WP-CLI help output.

• This method is abstract.

Return Value:

The short description of the command.

arguments

Get the command arguments.

protected arguments(): string

This method must be implemented in the child class to return the arguments required by the command. The arguments will be shown in the WP-CLI help output.

• This method is abstract.

Return Value:

The arguments for the command.

run

Run the command.

public run(array $args, array $assoc_args): void

This method must be implemented in the child class to define the logic for executing the command. It accepts arguments and associative arguments passed to the command via WP-CLI.

• This method is abstract.

Parameters:

Automatically generated on 2025-01-21