aligent/orocommerce-announcement-bundle

OroCommerce Bundle to display Announcement Messages on Storefront

v5.1.0 2023-12-12 05:04 UTC

Requires

• oro/commerce: 5.1.*

Requires (Dev)

• friendsofphp/php-cs-fixer: ~3.13.1
• phpmd/phpmd: ~2.13.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ~9.5.27
• squizlabs/php_codesniffer: ~3.7.1
• symfony/phpunit-bridge: ~5.4.17

GPL-3.0-only

README

This bundle adds the ability to display a custom Announcement Message on the OroCommerce storefront.

Example Use Cases

• Shipping Delays
• Public Holiday closures
• Promotional Messages
• Upcoming Website Maintenance

Features

• Select custom Background Colour for Announcement
• Set optional Start/End Date for Announcement
• Restrict Announcement to one or more Customer Groups

Requirements

• OroCommerce 5.0

Installation and Usage

NOTE: Adjust instructions as needed for your local environment

Installation

Install via Composer

composer require aligent/orocommerce-announcement-bundle

Once installed, run platform update to perform the installation:

php bin/console oro:platform:update --env=prod

Configuration Settings

Database Modifications

This Bundle does not directly modify the database schema in any way

All configuration is stored in System Configuration (oro_config_value).

Templates

Resources/views/layouts/default/page/alert_bar.html.twig

This includes a single _alert_bar_widget block which can be customized/overridden in OroCommerce themes if needed.

Roadmap / Remaining Tasks

• Ability to restrict Announcement to one or more Customer Groups
• OroCommerce 5.0 Support
• Implement Unit Tests
• Refactor AnnouncementDataProvider
• Consistent naming of color (deprecate colour)
• Reset hideAlert session variable when new Announcements are added
• Ability to block dismissal of Announcement Message (hides the 'X' button)
• Ability to only display on Homepage
• Ability to configure multiple messages for different scenarios
• (TBC) Move away from Content Blocks to WYSIWYG configuration fields