Settings
Provides various screens and settings for BigCommerce.
This class is responsible for registering settings screens, handling API credentials, and managing various onboarding steps in the BigCommerce plugin.
- Full name:
\BigCommerce\Container\Settings
- Parent class:
Provider
Constants
Constant | Visibility | Type | Value |
---|---|---|---|
SETTINGS_SCREEN | public | string | ’settings.screen.settings’ |
WELCOME_SCREEN | public | string | ’settings.screen.welcome’ |
CREATE_SCREEN | public | string | ’settings.screen.create’ |
STORE_TYPE_SCREEN | public | string | ’settings.screen.store_type’ |
CHANNEL_SCREEN | public | string | ’settings.screen.channel’ |
PENDING_SCREEN | public | string | ’settings.screen.pending’ |
CREDENTIALS_SCREEN | public | string | ’settings.screen.credentials’ |
MENU_SETUP_SCREEN | public | string | ’settings.screen.nav_menu’ |
COMPLETE_SCREEN | public | string | ’settings.screen.onboarding_complete’ |
RESOURCES_SCREEN | public | string | ’settings.screen.resources’ |
API_SECTION | public | string | ’settings.section.api’ |
CONNECT_ACCOUNT_SECTION | public | string | ’settings.section.connect_account’ |
CART_SECTION | public | string | ’settings.section.cart’ |
GIFT_CERTIFICATE_SECTION | public | string | ’settings.section.gift_certificates’ |
CURRENCY_SECTION | public | string | ’settings.section.currency’ |
IMPORT_SECTION | public | string | ’settings.section.import’ |
ACCOUNTS_SECTION | public | string | ’settings.section.accounts’ |
ANALYTICS_SECTION | public | string | ’settings.section.analytics’ |
REVIEWS_SECTION | public | string | ’settings.section.reviews’ |
NEW_ACCOUNT_SECTION | public | string | ’settings.section.new_account’ |
SELECT_CHANNEL_SECTION | public | string | ’settings.section.select_channel’ |
IMPORT_SETTINGS_SECTION | public | string | ’settings.section.import_settings’ |
CHANNEL_SECTION | public | string | ’settings.section.channel’ |
DIAGNOSTICS_SECTION | public | string | ’settings.section.diagnostics’ |
MENU_OPTIONS_SECTION | public | string | ’settings.section.nav_menu_options’ |
NEXT_STEPS_SECTION | public | string | ’settings.section.next_steps’ |
API_STATUS | public | string | ’settings.api_status’ |
IMPORT_NOW | public | string | ’settings.import_now’ |
IMPORT_STATUS | public | string | ’settings.import_status’ |
IMPORT_LIVE_STATUS | public | string | ’settings.import_status_live’ |
START_OVER | public | string | ’settings.start_over’ |
ONBOARDING_PROGRESS | public | string | ’settings.onboarding.progress_bar’ |
SITE_URL_SYNC | public | string | ’settings.site_url_sync’ |
ABORT_IMPORT | public | string | ’settings.abort_product_import’ |
FLUSH_CACHE | public | string | ’settings.flush_cache’ |
HEADLESS | public | string | ’settings.headless_processing’ |
CONFIG_STATUS | public | string | ’settings.configuration_status’ |
CONFIG_DISPLAY_MENUS | public | string | ’settings.configuration_display_menus’ |
STATUS_NEW | public | string | 0 |
STATUS_ACCOUNT_PENDING | public | string | 10 |
STATUS_API_CONNECTED | public | string | 20 |
STATUS_CHANNEL_CONNECTED | public | string | 40 |
STATUS_STORE_TYPE_SELECTED | public | string | 50 |
STATUS_MENUS_CREATED | public | string | 70 |
STATUS_COMPLETE | public | string | 1000 |
Methods
register
Registers settings and screens in the container.
public register(\Pimple\Container $container): void
Parameters:
Parameter | Type | Description |
---|---|---|
$container | \Pimple\Container | Dependency injection container. |
Automatically generated on 2025-01-21