README

A fluent and type-safe toolkit for working with Shopware's Data Abstraction Layer (DAL)

About

Shopware DAL Toolkit provides a clean, type-safe abstraction layer for working with Shopware Data Abstraction Layer using PHP. It simplifies common operations like entity management and media handling while maintaining strong typing and best practices.

Very useful for programmatically integrating third party systems e.g synchronize with ERP or any other system.

Key Features:

Type-safe entity operations with proper generic types
Simplified media handling for both URLs and base64 images
First-or-create pattern for common entities
Comprehensive test coverage

Installation

Install this package as a dependency using Composer.

composer require panakour/shopware-dal-toolkit

Usage

Basic Entity Operations

use Panakour\ShopwareDALToolkit\Dal;

// Create or retrieve the Dal service from the container
$dal = $container->get(Dal::class);
$currency = $dal->getCurrencyByIsoCode($context, 'EUR');

// Create a tax
$taxName = 'Custom Tax 19%';
$taxRate = 19.0;
$dal->createTax($context, $taxName, $taxRate);

// Create or retrieve a category
$categoryName = 'My Custom Category';
$categoryId = $dal->firstOrCreateCategory($context, $categoryName);
echo $categoryId; // newly generated or existing ID

// Create or retrieve a manufacturer
$manufacturerName = 'My Manufacturer';
$manufacturerId = $dal->firstOrCreateManufacturer($context, $manufacturerName);
echo $manufacturerId; // newly generated or existing ID

Media Handling

use Panakour\ShopwareDALToolkit\MediaServiceHelper;

// Retrieve the MediaServiceHelper from the container
$mediaHelper = $container->get(MediaServiceHelper::class);

// Assign media from a list of URLs and/or base64-encoded images
$images = [
    'https://placehold.co/100x110',
    'https://placehold.co/300x300',
    'data:image/png;base64,' . base64_encode($myRawPngContents),
];
$results = $mediaHelper->assignMedia($context, $images);

// Each item in $results has a 'mediaId' key
foreach ($results as $ref) {
    echo $ref['mediaId']; // Newly created media ID
}

More usage:

View the Integration tests
Look directly to the classes Dal.php and MediaServiceHelper.php

Requirements

PHP 8.3+
Shopware 6.6+

For contribution

🧹 Keep a modern codebase with Pint:

composer lint

✅ Run refactors using Rector

composer refactor

⚗️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PHPUnit

composer test:unit

🚀 Run the entire test suite:

composer test

panakour / shopware-dal-toolkit

Maintainers

Details