ClassesBigCommerceAccountsCountries

Countries

Class Countries

Handles loading and retrieving country data from a JSON file, and injecting country data into JavaScript configuration arrays.

  • Full name: \BigCommerce\Accounts\Countries

Methods

__construct

Countries constructor.

public __construct(string $data_file): mixed

Parameters:

ParameterTypeDescription
$data_filestringThe path to the JSON file containing country data.

get_countries

Get a list of countries.

public get_countries(): array

Loads the country data from the JSON file if it hasn’t been loaded yet, and returns the data as an array.

Return Value:

The list of countries loaded from the JSON file.


js_config

Inject country data into JavaScript configuration.

public js_config(array $config): array

Adds the list of countries to the provided JavaScript configuration array under the “countries” key.

Parameters:

ParameterTypeDescription
$configarrayThe JavaScript configuration array to modify.

Return Value:

The modified JavaScript configuration array.



Automatically generated on 2025-01-21