README

mhinspeya/module-campaign

This module provides a robust campaign management system for Magento 2. It allows administrators to create marketing campaigns, manage participants, and provides a customizable frontend registration form.

Main Functionalities

• Admin Management: Create and edit campaigns with detailed descriptions, images, and date ranges.
• Role-Based Access: Full ACL integration for secure admin operations.
• Frontend Registration: AJAX-powered registration forms for users to sign up for contests or campaigns.
• DACH Localization: Complete German translations (de_DE, de_AT, de_CH) for all admin and frontend components.
• Hyvä Compatibility: Optimized for Hyvä Themes with Alpine.js based form handling.
• Magento 2.4.8 Compatible: Fully refactored for PHP 8.1 - 8.4 and latest Magento 2.4.x standards.

Installation

Via Composer (Recommended)

1. Add the module to your project:

   composer require mhinspeya/mhinspeya-hyva-campaign
   

2. Enable the module:

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

3. (Optional) Compile and deploy static content:

   bin/magento setup:di:compile
   bin/magento setup:static-content:deploy
   

Via Zip File

1. Extract the zip into app/code/MHinspeya/Campaign.
2. Follow the enablement steps above.

Configuration

Configure the module settings under: Stores > Configuration > MHinspeya > Campaign Settings

Localization

The module includes full German translations. To use them:

1. Ensure your store view or admin locale is set to German.
2. The translations are located in i18n/*.csv.

Specifications

• Controllers:
  • mhcampaign/index/index: Main campaign list.
  • mhcampaign/index/view: Campaign detail page.
  • mhcampaign/index/post: AJAX form submission handler.
• API:
  • MHinspeya\Campaign\Api\CampaignRepositoryInterface
• Tables:
  • mh_campaign_record_list: Stores participants and registration data.
  • mh_campaign_list: Stores campaign definitions.

Support

For support, please contact info@mhinspeya.com.