Event Subscriber

Die Erweiterung feuert diverse Events die gelauscht werden kann.

Höre auf einen EventSubscriber

Hier erfährst du wie du einen EventSubscriber in deinem Custon Theme oder Erweiterung anlegst, um mit den Events der Configuratorware Integration zu interagieren.

Listening to Events | Shopware Documentationdeveloper.shopware.com

ConfigurationLineItemEvent

Das ConfigurationLineItemEvent wird nur gefeuert, wenn ein Extra LineItem für das Konfigurationsprodukt hinzugefügt wird. Siehe dazu Extra Produkt in den Einstellungen

Das Event enthält das LineItem , welches manipuliert werden kann. Im nachfolgenden Beispiel wie die quantity des LineItems geändert.

    public static function getSubscribedEvents(): array
    {
        return [
            ConfigurationLineItemEvent::class => ['onConfigurationLineItemEvent', 0]
        ];
    }

    public function onConfigurationLineItemEvent(ConfigurationLineItemEvent $configurationLineItemEvent)
    {

        $configurationLineItem = $configurationLineItemEvent->getConfigurationLineItem();
        $lineItem = $configurationLineItem->getLineItem();
        $payload = $lineItem->getPayload();
        $numberOfPieces = $this->getNumberOfPieces($payload);

        if($numberOfPieces !== null) {
            $lineItem->setQuantity($numberOfPieces);
        }

        $configurationLineItem->setLineItem($lineItem);
        $configurationLineItemEvent->setConfigurationLineItem($configurationLineItem);
    }

ConfigurationProductEvent

Das ConfigurationLineItemEvent wird nur gefeuert, wenn ein Extra LineItem für das Konfigurationsprodukt hinzugefügt wird. Siehe dazu Extra Produkt in den Einstellungen

Mithilfe des ConfigurationProductEvent, kann das Extra Produkt überschrieben werden. Im Standard kann ein statisches Extra Produkt in den Einstellungen der Erweiterung definiert werden. Falls es notwendig ist, das Extra Produkt, welches die Konfiguration enthält durch eine eigene Logik zu bestimmten, kann dieses Event genutzt werden.

public static function getSubscribedEvents(): array
{
    return [
        ConfigurationProductEvent::class => 'onConfigurationProductEvent'
    ];
}

public function onConfigurationProductEvent(ConfigurationProductEvent $event): ConfigurationProductEvent
{
    $configuration = $event->getConfiguration();
    $configurationProduct = $event->getConfiguratorProduct();

    if (isset($configuration['customdata']['designData']['designAreaIdentifier'])) {
        $designAreaIdentifier = $configuration['customdata']['designData']['designAreaIdentifier'];
        $newConfigurationProduct = $this->getConfigurationProduct($designAreaIdentifier);
        if ($newConfigurationProduct !== null) {
            $configurationProduct->setProductId($newConfigurationProduct->getProductId());
            $event->setConfiguratorProduct($configurationProduct);
        }
    }
    return $event;
}

ConfigurationPayloadEvent

Das ConfigurationPayloadEvent wird gefeuert, wenn ein neues Konfigurationsprodukt zum Warenkorb hinzugefügt wird. In manchen Integrationen ist notwendig, das Payload der Konfiguration, welches dem LineItem hinzugefügt wird zu manipulieren. Über eine weitere Endpunkte der configuratorware API können zusätzliche Informationen zur Konfiguration abgerufen werden. Diese können über das Event em Payload hinzugefügt werden.

Im Nachfolgenden Beispiel werden die item.attributes zum Payload hinzugefügt.

public static function getSubscribedEvents(): array
{
    return [
        ConfigurationPayloadEvent::class => 'onConfigurationPayloadEvent'
    ];
}

public function onConfigurationPayloadEvent(ConfigurationPayloadEvent $event): ConfigurationPayloadEvent
{
    $payload = $event->getConfigurationPayload();
    $payloadArray = $payload->getPayload();
    $newPayload = $this->getConfigurationByCode($payloadArray['code']);
    if(isset($newPayload['item']['attributes'])) {
        $payloadArray['itemAttributes'] = $newPayload['item']['attributes'];
        $payload->setPayload($payloadArray);
    }

    $event->setConfigurationPayload($payload);
    return $event;
}

ConfigurationQuantityPriceEvent

Dieses Event ermöglich es die QuantityPriceDefinition des LineItems zu manipulieren und somit Preis und Menge zu beinflussen.

public static function getSubscribedEvents(): array
{
    return [
        ConfigurationQuantityPriceEvent::class => 'onConfigurationQuantityPriceEvent'
    ];
}

public function onConfigurationQuantityPriceEvent(ConfigurationQuantityPriceEvent $event): ConfigurationProductEvent
{
    $quantityPriceDefinition = $event->getQuantityPriceDefinition();
    
    // ...
    
    $quantityPriceDefinition = new QuantityPriceDefinition(
        $newPrice,
        $product->getPrice()->getTaxRules(),
        $product->getQuantity()
    );
    $quantityPriceDefinition->setIsCalculated(false);
    
    $event->setQuantityPriceDefinition($quantityPriceDefinition);
    return $event;
}