Understanding Core Class

Bagisto provides a comprehensive helper system built around the Core class to streamline development and provide easy access to essential functionality. These helpers eliminate the need for repetitive code patterns and offer a consistent API for common operations across channels, currencies, locales, and configuration management.

Introduction

The Core class (Webkul\Core\Core) serves as Bagisto's central utility hub, providing a unified interface for accessing system-wide functionality. It acts as a facade that abstracts complex operations into simple, memorable method calls.

Architecture Overview

The Core class is designed around Bagisto's multi-tenant architecture, where:

• Channels represent different storefronts or websites
• Locales handle internationalization and language settings
• Currencies manage multi-currency operations
• Configuration provides centralized settings management

Accessing the Core Class

Bagisto provides a global core() helper function that returns the Core class instance:

// Direct access to Core class methods
$version = core()->version();
$currentChannel = core()->getCurrentChannel();
$allCurrencies = core()->getAllCurrencies();

Global Helper Function

The core() function is globally available throughout your Bagisto application, making it accessible in controllers, views, service providers, and custom classes without any imports.

Core Class Benefits

• Consistency: Standardized API across all Bagisto operations
• Simplicity: Complex operations reduced to single method calls
• Context Awareness: Automatically handles current channel/locale context
• Performance: Optimized caching and lazy loading for frequently accessed data

Internal Architecture

The Core class maintains several protected properties for caching and performance:

protected $currentChannel;    // Cached current channel
protected $defaultChannel;    // Cached default channel  
protected $currentCurrency;   // Cached current currency
protected $baseCurrency;      // Cached base currency
protected $currentLocale;     // Cached current locale
protected $guestCustomerGroup; // Cached guest customer group
protected $exchangeRates = []; // Cached exchange rates
protected $taxCategoriesById = []; // Cached tax categories
protected $singletonInstances = []; // Cached singleton instances

Caching Strategy

The Core class implements intelligent caching to minimize database queries. Once a channel, currency, or locale is loaded, it's stored in memory for the request lifecycle.

Core Helper Methods

The following sections detail the various helper methods available through the Core class, organized by functionality area.

System Information

Get the version number of Bagisto

To get the version number of your Bagisto application, you can use the core()->version() method:

$version = core()->version();
// Returns: "v2.3.6"

Channel Management

Channels in Bagisto represent different storefronts or websites, enabling multi-channel retailing from a single installation.

Get all channels

The core()->getAllChannels() method retrieves all available channels in the application, useful for channel selection interfaces and multi-channel operations:

$channels = core()->getAllChannels();
// Returns: Collection of channel models

Get current channel model

The core()->getCurrentChannel() method retrieves the current channel being accessed:

$currentChannel = core()->getCurrentChannel();
// Returns: Current channel model with all properties

Set the current channel

Dynamically change the active channel:

core()->setCurrentChannel($channel);

Get current channel code

Retrieve just the code of the currently active channel:

$channelCode = core()->getCurrentChannelCode();
// Returns: "default", "mobile", etc.

Get default channel model

Access the default channel configuration:

$defaultChannel = core()->getDefaultChannel();

Get default channel code

Retrieve the default channel code from configuration:

$defaultCode = core()->getDefaultChannelCode();

Get default locale code from default channel

Get the locale code for the default language in the default channel:

$defaultLocaleCode = core()->getDefaultLocaleCodeFromDefaultChannel();

Get channel from request

Retrieve the channel based on the current HTTP request:

$requestedChannel = core()->getRequestedChannel();

Get channel code from request

Get just the channel code from the current request:

$requestedCode = core()->getRequestedChannelCode();

Get channel name

Retrieve the display name of the current channel:

$channelName = core()->getChannelName($channel);
// Note: Requires passing a channel object as parameter

Parameter Required

Unlike other channel methods, getChannelName() requires a channel object as a parameter. It handles translation fallbacks automatically.

Locale Management

Locales handle internationalization, language settings, and regional preferences.

Get all locales

Retrieve all available locales in the system:

$locales = core()->getAllLocales();
// Returns: Collection of locale models

Get current locale

Get the currently active locale:

$currentLocale = core()->getCurrentLocale();

Get locale from request

Retrieve the locale from the current request:

$requestedLocale = core()->getRequestedLocale();

Get locale code from request

Get the locale code with optional fallback:

$localeCode = core()->getRequestedLocaleCode($localeKey = 'locale', $fallback = true);

Parameters:

• $localeKey: The key to look for in the request (default: 'locale')
• $fallback: Whether to provide a fallback locale if not found (default: true)

Get locale code in requested channel

Ensure the locale code is valid for the requested channel:

$validLocaleCode = core()->getRequestedLocaleCodeInRequestedChannel();

If not found, this method sets the channel's default locale code.

Currency Management

Bagisto's currency helpers facilitate multi-currency operations and conversions.

Get all currencies

Retrieve all available currencies:

$currencies = core()->getAllCurrencies();

Get base currency model

Get the application's base currency:

$baseCurrency = core()->getBaseCurrency();

Get base currency code

Retrieve the base currency code:

$baseCurrencyCode = core()->getBaseCurrencyCode();

Get channel's base currency

Get the base currency model for the current channel:

$channelBaseCurrency = core()->getChannelBaseCurrency();

Get channel's base currency code

Retrieve the base currency code for the current channel:

$channelBaseCurrencyCode = core()->getChannelBaseCurrencyCode();

Set current currency

Change the active currency:

core()->setCurrentCurrency($currencyCode);

Get current currency model

Retrieve the current channel's currency:

$currentCurrency = core()->getCurrentCurrency();

Get current currency code

Get the current channel's currency code:

$currentCurrencyCode = core()->getCurrentCurrencyCode();

Get exchange rates

Retrieve exchange rate information by target currency ID:

$exchangeRate = core()->getExchangeRate($targetCurrencyId);
// Returns: ExchangeRate model or null

Parameter Type

This method expects a currency ID (integer), not a currency code. Use the currency model's ID property.

Convert price

Convert an amount to a target currency:

$amount = 100;
$targetCurrencyCode = 'EUR';
$convertedAmount = core()->convertPrice($amount, $targetCurrencyCode);

Convert to base price

Convert an amount from a specific currency to the base currency:

$amount = 200;
$targetCurrencyCode = 'EUR';
$baseAmount = core()->convertToBasePrice($amount, $targetCurrencyCode);

Format and convert price with currency

The currency() method formats and converts a price with automatic currency conversion:

$formattedPrice = core()->currency($amount);
// Converts to current currency and formats with symbol

Format price with currency

Format and display a price with currency symbol:

$price = 100;
$currencyCode = 'USD'; // Optional, uses current currency if not provided
$formattedPrice = core()->formatPrice($price, $currencyCode);

Format base price

Format a price with the base currency symbol:

$formattedBasePrice = core()->formatBasePrice($price, $isEncoded = false);

The $isEncoded parameter controls whether to encode the currency symbol.

Date and Time Helpers

Check if date is in interval

Verify if the current channel date falls within a specified range:

$isInRange = core()->isChannelDateInInterval($dateFrom = null, $dateTo = null);

Get channel timestamp

Get a timestamp adjusted for the channel's timezone:

$timestamp = core()->channelTimeStamp($channel);

Check if SQL date is empty

Validate whether a SQL date field is empty:

$isEmpty = core()->is_empty_date($date);

Format date using current channel

Format a date according to channel timezone and locale:

$formattedDate = core()->formatDate($date = null, $format = 'd-m-Y H:i:s');

Configuration Management

Retrieve configuration data

Get specific configuration values with channel and locale context:

$configValue = core()->getConfigData($field, $channelCode = null, $localeCode = null);
// Delegates to system_config()->getConfigData()

Get configuration field

Access a specific configuration field structure:

$fieldStructure = core()->getConfigField($fieldName);
// Returns: Configuration field definition array

System Config Integration

The Core class delegates configuration operations to the system configuration manager, providing a unified interface for accessing settings.

Geographic Data Helpers

Get all countries

Retrieve all available countries:

$countries = core()->countries();

Get country name by code

Get country name using ISO 3166-1 alpha-2 code:

$countryName = core()->country_name($code);

Get country states

Retrieve all states/provinces for a country:

$states = core()->states($countryCode);

Get grouped states by countries

Get all states organized by country:

$groupedStates = core()->groupedStatesByCountries();

Find state by country code

Get specific state information:

$state = core()->findStateByCountryCode($countryCode = null, $stateCode = null);

Check field requirements

Verify if address fields are required:

$isCountryRequired = core()->isCountryRequired();
$isStateRequired = core()->isStateRequired();
$isPostCodeRequired = core()->isPostCodeRequired();

Customer Management

Get guest customer group

Retrieve the guest customer group configuration:

$guestGroup = core()->getGuestCustomerGroup();

Utility Methods

Get maximum upload size

Retrieve the maximum file upload size from PHP configuration:

$maxSize = core()->getMaxUploadSize();
// Returns: Value from ini_get('upload_max_filesize')

Week range calculation

Calculate week start or end dates:

$weekStart = core()->xWeekRange($date, 0); // Week start (Sunday)
$weekEnd = core()->xWeekRange($date, 1);   // Week end (Saturday)

Parameters:

• $date: Date string to calculate from
• $day: 0 for week start, 1 for week end

Convert empty strings to null

Clean up array data by converting empty strings to null:

$cleanedArray = core()->convertEmptyStringsToNull($array);

Create singleton instance

Get singleton instances through the service container:

$instance = core()->getSingletonInstance($className);

Tax-related helpers

Generate tax rate identifiers for view elements:

$taxIdentifier = core()->taxRateAsIdentifier($taxRate);
// Returns: Tax rate with dots replaced by underscores

Get tax category by ID with caching:

$taxCategory = core()->getTaxCategoryById($id);

Email configuration helpers

Retrieve email sender details:

$shopEmailDetails = core()->getSenderEmailDetails();
$adminEmailDetails = core()->getAdminEmailDetails();
$contactEmailDetails = core()->getContactEmailDetails();

Each method returns an array with 'name' and 'email' keys, with automatic fallbacks to configuration defaults.

Performance and Advanced Features

Get speculation rules

Retrieve browser speculation rules for performance optimization:

$speculationRules = core()->getSpeculationRules();
// Returns: Array of prerender and prefetch rules based on configuration

This method generates speculation rules for browser performance optimization, including prerender and prefetch configurations.

Best Practices

When using Bagisto's Core helpers, consider these recommendations:

Performance

• Cache results of expensive operations like getAllChannels() when used repeatedly
• Use specific methods rather than general ones when possible (e.g., getCurrentChannelCode() vs getCurrentChannel()->code)

Context Awareness

• Always consider the current channel/locale context when using helpers
• Be aware that some methods may return different results based on the current request context

Error Handling

• Many Core methods return null or empty collections when data is not found
• Always validate return values, especially when working with optional parameters