Download the PHP package php-notify/notify-symfony without Composer

## Table of Contents - [About PHPFlasher Symfony Adapter](#about-phpflasher-symfony-adapter) - [Features](#features) - [Supported Versions](#supported-versions) - [Installation](#installation) - [Core Package](#core-package) - [Adapters](#adapters) - [Configuration](#configuration) - [Configuration File](#configuration-file) - [Configuration Options](#configuration-options) - [Quick Start](#quick-start) - [Usage Examples](#usage-examples) - [Adapters Overview](#adapters-overview) - [Official Documentation](#official-documentation) - [Contributors and Sponsors](#contributors-and-sponsors) - [Contact](#contact) - [License](#license) ## About PHPFlasher Symfony Adapter **PHPFlasher Symfony Adapter** is an open-source package that seamlessly integrates PHPFlasher’s robust flash messaging capabilities into your **Symfony** applications. It streamlines the process of adding flash messages, offering an intuitive API to enhance user experience with minimal configuration. With PHPFlasher Symfony Adapter, you can effortlessly display success, error, warning, and informational messages to your users, ensuring clear communication of application states and actions. ## Features - **Seamless Symfony Integration**: Designed specifically for Symfony, ensuring compatibility and ease of use. - **Multiple Notification Libraries**: Supports various frontend libraries like Toastr, Noty, SweetAlert, and Notyf. - **Flexible Configuration**: Customize the appearance and behavior of flash messages to fit your application's needs. - **Intuitive API**: Simple methods to create and manage flash messages without boilerplate code. - **Extensible**: Easily add or create new adapters for different frontend libraries. ## Supported Versions | PHPFlasher Symfony Adapter Version | PHP Version | Symfony Version | |------------------------------------|-------------|-----------------| | **v2.x** | ≥ 8.2 | ≥ 7.0 | | **v1.x** | ≥ 5.3 | ≥ 2.0 | > **Note:** Ensure your project meets the PHP and Symfony version requirements for the PHPFlasher Symfony Adapter version you intend to use. For older PHP or Symfony versions, refer to [PHPFlasher v1.x](https://github.com/php-flasher/flasher-symfony/tree/1.x). ## Installation ### Core Package Install the PHPFlasher Symfony Adapter via Composer: After installation, set up the necessary assets: > **Note:** PHPFlasher automatically injects the necessary JavaScript and CSS assets into your Blade templates. No additional steps are required for asset injection. ### Adapters PHPFlasher provides various adapters for different notification libraries. Below is an overview of available adapters for Symfony: - [flasher-toastr-symfony](https://github.com/php-flasher/flasher-toastr-symfony) - Symfony Adapter - [flasher-noty-symfony](https://github.com/php-flasher/flasher-noty-symfony) - Symfony Adapter - [flasher-notyf-symfony](https://github.com/php-flasher/flasher-notyf-symfony) - Symfony Adapter - [flasher-sweetalert-symfony](https://github.com/php-flasher/flasher-sweetalert-symfony) - Symfony Adapter For detailed installation and usage instructions for each adapter, refer to their respective `README.md`. ## Configuration After installing the PHPFlasher Symfony Adapter, you can configure it by publishing the configuration file or by modifying it directly. ### Configuration File If you need to customize the default settings, publish the configuration file using the following command: This will create a file at `config/packages/flasher.yaml` with the following content: ### Configuration Options | **Option** | **Description** | |------------------|---------------------------------------------------------------------------------------------------------------------------| | `default` | **String**: The default notification library to use (e.g., `'flasher'`, `'toastr'`, `'noty'`, `'notyf'`, `'sweetalert'`). | | `main_script` | **String**: Path to the main PHPFlasher JavaScript file. | | `styles` | **Array**: List of CSS files to style your notifications. | | `options` | **Array** (Optional): Global options for all notifications (e.g., `'timeout'`, `'position'`). | | `inject_assets` | **Boolean**: Whether to automatically inject JavaScript and CSS assets into your HTML pages. | | `translate` | **Boolean**: Enable message translation using Symfony’s translation service. | | `excluded_paths` | **Array**: URL patterns to exclude from asset injection and flash_bag conversion. | | `flash_bag` | **Array**: Map Symfony flash message keys to notification types. | | `filter` | **Array** (Optional): Criteria to filter which notifications are displayed (e.g., `'limit'`). | | `presets` | **Array** (Optional): Define notification presets to simplify notification creation. | ## Quick Start To display a notification message, you can either use the `flash()` helper function or obtain an instance of `flasher` from the service container. Then, before returning a view or redirecting, call the desired method (`success()`, `error()`, etc.) and pass in the message to be displayed. ### Using the `flash()` Helper ### Using the `flasher` Service ## Usage Examples ### Success Message ### Error Message ### Info Message ### Warning Message ### Passing Options ### Using presets Define a preset in your `config/packages/flasher.yaml`: Use the preset in your controller: ## Adapters Overview PHPFlasher supports various adapters to integrate seamlessly with different frontend libraries. Below is an overview of available adapters for Symfony: | Adapter Repository | Description | |-----------------------------------------------------------------------------------------|--------------------------------| | [flasher-symfony](https://github.com/php-flasher/flasher-symfony) | Symfony framework adapter | | [flasher-toastr-symfony](https://github.com/php-flasher/flasher-toastr-symfony) | Toastr adapter for Symfony | | [flasher-noty-symfony](https://github.com/php-flasher/flasher-noty-symfony) | Noty adapter for Symfony | | [flasher-notyf-symfony](https://github.com/php-flasher/flasher-notyf-symfony) | Notyf adapter for Symfony | | [flasher-sweetalert-symfony](https://github.com/php-flasher/flasher-sweetalert-symfony) | SweetAlert adapter for Symfony | > **Note:** Each adapter has its own repository. For detailed installation and usage instructions, please refer to the [Official Documentation](https://php-flasher.io). ## Official Documentation Comprehensive documentation for PHPFlasher is available at [https://php-flasher.io](https://php-flasher.io). Here you will find detailed guides, API references, and advanced usage examples to help you get the most out of PHPFlasher. ## Contributors and sponsors Join our team of contributors and make a lasting impact on our project! We are always looking for passionate individuals who want to contribute their skills and ideas. Whether you're a developer, designer, or simply have a great idea, we welcome your participation and collaboration. Shining stars of our community:

Younes ENNAJI 💻 📖 🚧	Salma Mourad 💵	Nashwan Abdullah 💵	Arvid de Jong 💵	Ash Allen 🎨	Tony Murray 💻	Stéphane P 📖
Lucas Maciel 🎨	Ahmed Gamal 💻 📖

## Contact PHPFlasher is being actively developed by yoeunes. You can reach out with questions, bug reports, or feature requests on any of the following: - [Github Issues](https://github.com/php-flasher/php-flasher/issues) - [Github](https://github.com/yoeunes) - [Twitter](https://twitter.com/yoeunes) - [Linkedin](https://www.linkedin.com/in/younes--ennaji/) - [Email me directly](mailto:[email protected]) ## License PHPFlasher is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

Made with ❤️ by Younes ENNAJI