mhinspeya/mhinspeya-hyva-campaign

MHinspeya Campaign Management Module for Magento 2. Enables creation and management of marketing campaigns with frontend registration forms.

1.0.0 2026-07-20 12:26 UTC

Requires

• php: ^8.1 || ^8.2 || ^8.3 || ^8.4
• magento/framework: ^103.0.0
• magento/module-backend: *
• magento/module-customer: *
• magento/module-store: *
• magento/module-ui: *

GPL-3.0

• MHinspeya

Published on Packagist.org on 2026-07-20 12:29 UTC

README

mhinspeya/mhinspeya-hyva-campaign

The MHinspeya Campaign Module provides a complete, feature-rich campaign management solution for Magento 2. It enables store administrators to easily create and manage marketing campaigns, contests, and promotional sign-ups with dynamic frontend registration forms, interactive calendar pickers, and automated email notifications for both administrators and participants.

Key Features

• Admin Campaign Management: Easily create, edit, and delete campaigns with banner images, custom date ranges, store-view targeting, and terms & conditions.
• Participant Submissions Grid: Admin grid to view, filter, export, and manage all campaign registrants (MHinspeya > Campaign > Campaign Form List).
• Hyvä Theme Compatibility: Native Alpine.js integration for sleek, responsive frontend forms and smooth AJAX submissions.
• Interactive Calendar Picker: Built-in Date of Birth calendar picker (<input type="date">) with age validation and intuitive user interaction.
• Automated Email Notifications: Customizable email templates sent automatically to participants (confirmation) and admins (new registration alert).
• German DACH Localization: Complete German translation dictionary (i18n/de_DE.csv) included.
• PHP 8.1 - 8.4 & Magento 2.4.x Compatible: Built according to latest Magento standards and strict type declarations.

Installation Methods

Method 1: Via Composer (Recommended)

1. Add the package to your Magento repository:

   composer require mhinspeya/mhinspeya-hyva-campaign
   

   Or if using a local repository in app/code:

   composer config repositories.mhinspeya-campaign path app/code/MHinspeya/Campaign
   composer require mhinspeya/mhinspeya-hyva-campaign:*
   

2. Enable the module and run Magento setup upgrade:

   bin/magento module:enable MHinspeya_Campaign
   bin/magento setup:upgrade
   

3. Compile code and deploy static assets:

   bin/magento setup:di:compile
   bin/magento setup:static-content:deploy -f
   bin/magento cache:clean
   

Method 2: Via Direct app/code Directory

1. Copy or extract the module source files into the following path:

   app/code/MHinspeya/Campaign/
   

2. Verify that registration.php and composer.json are present in app/code/MHinspeya/Campaign/.

3. Enable the module and execute deployment commands:

   bin/magento module:enable MHinspeya_Campaign
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento setup:static-content:deploy -f
   bin/magento cache:clean
   

Configuration

Navigate to Stores > Configuration > MHinspeya.de > Campaign in the Magento Admin Panel.

General Settings

Field	Description	Default Value
Enable Campaign Module	Enable or disable the frontend campaign functionality storewide.	Yes / No
Campaign List Page Name	Custom URL key for the campaign listing page.	campaigns.html
Admin Name	Admin contact name used in correspondence.	Admin
Admin Email	Email address that receives participant signup alerts.	[e-mail]
Sender Admin Name	Sender name displayed in outgoing emails.	Campaign Team
Sender Admin Email	Sender email address for outgoing system emails.	[e-mail]
Admin Email Template	Select email template sent to store admin upon registration.	Campaign Admin Registration Internal
User Confirmation Email Template	Select email template sent to registrant upon signing up.	Campaign Candidate Confirmation

Admin Usage & Sample Data Setup

1. Creating & Managing Campaigns

Go to MHinspeya > Campaign > Manage Campaign:

1. Click Add New Campaign.
2. Campaign Information:
   • Campaign Name: Enter campaign title (e.g., Summer Splash Contest 2026).
   • Status: Set to Enable or Disable.
   • Valid From & Valid To: Choose campaign start and end dates (Y-m-d format).
   • Banner Image: Upload a promotional banner image.
   • Terms & Conditions: Enter contest terms text displayed next to agreement checkbox.
   • Store Views: Select applicable store views.
3. Click Save Campaign.

2. Viewing Participant Registrations

Go to MHinspeya > Campaign > Campaign Form List:

• Displays all submitted contest entries with details:
  • Participant Name (First & Last Name)
  • Gender / Salutation
  • Email Address
  • Date of Birth
  • Postal Code & Location / City
  • Campaign Name & Submission Date

Frontend Form & Integration

The frontend form is optimized for Hyvä Themes and accessible via the campaign detail page:

• Template Path: app/code/MHinspeya/Campaign/view/frontend/templates/index/detail.phtml
• Form Fields:
  • Salutation / Gender (Herr, Frau, Divers)
  • First Name (first_name)
  • Last Name (last_name)
  • Email Address (email)
  • Postal Code (postal_code)
  • Location / City (ort)
  • Date of Birth (dateofbirth - with native calendar picker popup)
  • Terms & Conditions Agreement (check)
• Submission Endpoint: mhcampaign/index/post (AJAX handler)

Localization

German DACH translations are included out of the box:

• Location: app/code/MHinspeya/Campaign/i18n/de_DE.csv
• Automatically translates all form labels, buttons, error messages, and success notifications when store locale is set to German (de_DE, de_AT, de_CH).

Database Architecture

• mhinspeya_campaign_list: Stores campaign configurations, banners, dates, terms, and store views.
• mhinspeya_campaign_data: Stores participant submissions (Name, Email, DOB, Postal Code, Ort, Gender, Registration Timestamp).

Support

For technical support or customization requests, please contact:

• Email: [e-mail]
• Website: https://www.mhinspeya.com