Example Extension

A short introduction to the extension. What it does, who it’s for, and when it’s most useful.

Getting Started

Before you begin, make sure the prerequisites are in place.

Installation

The extension is installed like any Shopware 6 extension — via Composer or the Shopware Store:

composer require becker-enterprises/beispiel-erweiterung
bin/console plugin:refresh
bin/console plugin:install --activate BeispielErweiterung
bin/console cache:clear

Configuration

After installation, configuration options appear in the administration under Settings → System → Plugins.

Option	Default	Description
`apiKey`	empty	API key of the external system
`intervalMinutes`	60	Synchronisation interval in minutes
`dryRun`	false	Dry run without data changes

First Steps

Once configured, you can start using the extension immediately. We recommend running the first sync with dryRun active to check the effects.

Usage

Here you find the main usage areas of the extension.

In the Administration

A new module appears in the admin area where you can perform all relevant actions — check status, trigger manual sync, view logs.

CLI Commands

For automation, the following commands are available:

bin/console becker:example:sync         # one-off synchronisation
bin/console becker:example:status       # show current status
bin/console becker:example:reset        # reset state

Scheduled Tasks

The extension registers a ScheduledTask that runs hourly by default. You can enable or disable the task in the Shopware settings.

Advanced

These sections are aimed at developers who want to integrate more deeply.

API Reference

The extension provides a REST API:

GET /api/_action/becker-enterprises/example
Authorization: Bearer {token}

Returns JSON containing the current state of the synchronisation.

Events & Hooks

You can subscribe to the following events to hook in your own logic:

becker_example.sync.before — before synchronisation
becker_example.sync.after — after a successful run
becker_example.sync.error — on failure

Migrating from 1.x

If you migrate from version 1.x, please note the changed configuration structure. A migration command is included:

bin/console becker:example:migrate-from-1x

Miscellaneous

Frequently Asked Questions

Does the extension work in cluster setups? Yes, all operations are designed to be safe in horizontally scaled environments.

Are updates installed automatically? No, updates go through the regular Composer or Store update process.

Support

For questions or issues, please reach me at info@becker.enterprises.