BatteryIncluded Symfony Bundle

The Symfony integration of the BatteryIncluded PHP SDK. It configures the SDK from the environment, exports your catalog with one command, keeps the collection in sync when your entities change and puts every API call into the Symfony web profiler.

// config/bundles.php
Batteryincluded\BatteryincludedBundle\BatteryincludedBundle::class => ['all' => true],

#[Route('/search')]
public function search(BrowseSearchStruct $searchStruct, BrowseService $browseService): Response
{
    // q, filters, sorting, page, locale and availability are taken from the request
    return $this->render('search.html.twig', ['result' => $browseService->browse($searchStruct)]);
}

bin/console bi:export --force     # full import of all data providers
bin/console bi:sync PRODUCT-5     # update a single document
bin/console bi:status             # check configuration and connection

What’s inside

Topic	Content
Getting started	Installation, credentials, first search
Configuration	All options, several collections, Symfony http client, cache, logging
Export	Data providers, bi:export, full import and its safety nets
Single documents	bi:sync, bi:delete, DocumentSynchronizer, Messenger
Doctrine	#[BatteryIncludedDocument]: sync entities after flush
Events & extension points	All events, interfaces, attributes, messages and services
Search in controllers	BrowseSearchStruct arguments, #[MapSearchStruct], availability
Console commands	Reference of all bi:* commands
Profiler & logging	Web profiler panel, timeline, log channel
Demo shop	A complete storefront inside the bundle
Test application	The Symfony app used to develop the bundle
Development	Tests, code style, static analysis, this documentation

For AI coding agents

Let your agent read llms-full.txt: installation, configuration, export, sync, search and a verification checklist in one file. llms.txt lists all pages of this documentation.

Requirements

• PHP 8.2 or higher, Symfony 7 or 8
• A BatteryIncluded collection and its API key

Optional packages unlock more features, nothing of it is required:

Package	Feature
symfony/twig-bundle	Demo shop and profiler panel
symfony/web-profiler-bundle	API calls in the toolbar and profiler
symfony/messenger	Asynchronous sync and delete
doctrine/doctrine-bundle	Sync entities after flush
symfony/http-client	Timeouts, retries, proxies and mocking of the API calls
symfony/cache	Cache for rarely changing responses
symfony/lock	Lock of the application for bi:export
symfony/monolog-bundle	Own batteryincluded log channel