mhinspeya/inspeya-hyva-kampagnen

Magento 2 module for displaying and managing campaigns with filtering, pagination, and Hyva compatibility

1.0.2 2026-07-23 09:23 UTC

Requires

• mhinspeya/backend-mod: ^1.0

Suggests

• mhinspeya/backend-mod: Support Configuration

OSL-3.0

• MHinspeya

• magento
• magento 2
• hyva
• MHinspeya

Published on Packagist.org on 2026-07-23 09:24 UTC

README

modehaus/module-kampagnen

Compatibility

Platform	Supported versions
Magento Open Source / Adobe Commerce	2.4.8 (framework ^103.0)
PHP	8.2, 8.3, 8.4
Frontend	Hyvä Theme (list/detail templates)

Main Functionalities

Kampagnen listing, detail, search/filter, and pagination via App Campaigns API.

Installation

* = in production please use the --keep-generated option

Type 1: Zip file

• Unzip the zip file in app/code/MHinspeya
• Enable the module by running php bin/magento module:enable MHinspeya_Kampagnen
• Apply database updates by running php bin/magento setup:upgrade*
• Flush the cache by running php bin/magento cache:flush

Type 2: Composer

• Make the module available in a composer repository for example:
  • private repository repo.magento.com
  • public repository packagist.org
  • public github repository as vcs
• Add the composer repository to the configuration by running composer config repositories.repo.magento.com composer https://repo.magento.com/
• Install the module composer by running composer require modehaus/module-kampagnen
• enable the module by running php bin/magento module:enable MHinspeya_Kampagnen
• apply database updates by running php bin/magento setup:upgrade*
• Flush the cache by running php bin/magento cache:flush

Configuration

Enable App Campaigns and set the Campaigns GC API under:

Stores → Configuration → App Campaigns → App Campaigns

• Enable App Campaigns — master switch; when Off, listing/detail are hidden and no API calls are made
• Enable Frontend Search — show/hide the search form on the listing page (requires App Campaigns enabled)
• Campaigns GC API — API endpoint for campaign data
• API Bearer Token — optional; when set, API requests include Authorization: Bearer …. Leave empty for APIs without token auth.

Translations

Frontend and admin labels use English source strings with Magento __() and CSV translations under i18n/:

• i18n/de_DE.csv
• i18n/de_CH.csv
• i18n/de_AT.csv

After changing translations, run bin/magento cache:flush (and bin/magento i18n:collect-phrases only if regenerating phrase lists).

Live API data (no cache flush needed)

Kampagnen data is loaded from the external API on each request. Only this module's list and detail pages are excluded from Magento Full Page Cache / Varnish and send Cache-Control: no-cache headers. All other website pages stay fully cached — SEO and sales pages are not affected.

Scope (list + detail only):

• CMS URL keys: kampagnen, kampagnendetail
• CMS content that embeds MHinspeya\Kampagnen\Block\KampagnenList with the list/detail templates
• Layout updates mhinspeya_kampagnen_list / mhinspeya_kampagnen_detail

Optional Layout Update XML on the list CMS page:

<update handle="mhinspeya_kampagnen_list"/>

or on the detail CMS page:

<update handle="mhinspeya_kampagnen_detail"/>

After deploying this module version once, flush cache once so plugins/layout are registered. After that, new API events show without further cache clears.

Specifications

Attributes