Category_Purge

This class handles the process of purging product categories. It extends the Term_Purge class and uses the CategoriesTrees trait to manage category trees.

The purge process involves fetching category data, identifying remote term IDs, and managing the state of the purge process.

• Full name: \BigCommerce\Import\Processors\Category_Purge
• Parent class: \BigCommerce\Import\Processors\Term_Purge

Methods

taxonomy

Get the taxonomy name for this purge.

protected taxonomy(): string

Return Value:

The taxonomy name for product categories.

running_state

Get the running state for this purge.

protected running_state(): string

Return Value:

The running state constant for purging categories.

completed_state

Get the completed state for this purge.

protected completed_state(): string

Return Value:

The completed state constant for category purge.

get_remote_term_ids

Get remote term IDs for the given category IDs.

protected get_remote_term_ids(array $ids): array

This method fetches the term IDs from the remote BigCommerce API, using either the MSF categories endpoint or the regular categories endpoint based on the store settings. If no IDs are provided or the response is empty, an empty array is returned.

Parameters:

Return Value:

List of remote term IDs.

Inherited methods

get_option

protected get_option(string $option, bool $default = false): mixed

Parameters:

update_option

protected update_option(string $option, mixed $value, bool $autoload = false): bool

Parameters:

add_option

protected add_option(string $option, mixed $value, bool $autoload = false): bool

Parameters:

delete_option

protected delete_option(string $option): bool

Parameters:

__construct

Category_Import constructor.

public __construct(\BigCommerce\Api\v3\Api\CatalogApi $catalog_api, int $batch_size): mixed

Parameters:

taxonomy

Gets the WordPress taxonomy identifier that this purge processor handles.

protected taxonomy(): string

• This method is abstract.

Return Value:

The taxonomy name (e.g., ‘product_category’, ‘product_brand’).

running_state

Gets the status identifier for when this term purge process is running.

protected running_state(): string

• This method is abstract.

Return Value:

The status identifier for the running state.

completed_state

Gets the status identifier for when this term purge process is completed.

protected completed_state(): string

• This method is abstract.

Return Value:

The status identifier for the completed state.

run

Executes the term purge process.

public run(): void

This method handles the deletion of WordPress terms that no longer exist in BigCommerce. It processes terms in batches, comparing local terms with remote BigCommerce data. The process tracks its state to support pagination and can be resumed if interrupted.

Throws:

If there's an error communicating with the BigCommerce API.

• ApiException

get_remote_term_ids

Get the IDs of all terms found in the API that match the known terms

protected get_remote_term_ids(int[] $ids): int[]

• This method is abstract.

Parameters:

Throws:

• ApiException

get_msf_categories

Get the categories in the MSF category tree.

public get_msf_categories(\BigCommerce\Api\v3\Api\CatalogApi $api, array $params = []): \BigCommerce\Api\v3\Model\CategoryCollectionResponse|array

This method retrieves categories within the MSF category tree by fetching the tree ID, then requesting a batch of categories from the BigCommerce API.

Parameters:

Return Value:

A collection of categories or an empty array.

Throws:

Throws an exception if the API request fails.

• ApiException

get_trees

Get all category trees associated with a given channel.

public get_trees(\BigCommerce\Api\v3\Api\CatalogApi $api): array

This method fetches category trees from BigCommerce by retrieving the channel ID associated with the primary connection and querying the BigCommerce API for available category trees.

Parameters:

Return Value:

An array of category trees.

Throws:

Throws an exception if the API request fails.

• ApiException

Automatically generated on 2025-01-21