PHPackages locomotivemtl/charcoal-contrib-notification - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. locomotivemtl/charcoal-contrib-notification ActiveLibrary[Mail & Notifications](/categories/mail) locomotivemtl/charcoal-contrib-notification =========================================== Admin notification module. 0.1.3(6y ago)0126MITPHPPHP >=5.6.0 || >=7.0 Since Apr 23Pushed 6y ago13 watchersCompare [ Source](https://github.com/locomotivemtl/charcoal-contrib-notification)[ Packagist](https://packagist.org/packages/locomotivemtl/charcoal-contrib-notification)[ Docs](https://locomotivemtl.github.io/charcoal-contrib-notification/)[ RSS](/packages/locomotivemtl-charcoal-contrib-notification/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependencies (4)Versions (7)Used By (0) Charcoal FooBar =============== [](#charcoal-foobar) [![License](https://camo.githubusercontent.com/c6d988c2c57d8fa209b4f001e950dbc69ea70843f349ec21219257e27c2446e7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6c6f636f6d6f746976656d746c2f63686172636f616c2d636f6e747269622d6e6f74696669636174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/locomotivemtl/charcoal-contrib-notification)[![Latest Stable Version](https://camo.githubusercontent.com/584876af8f5fac3da500885b56255a8be6de7a5a7a40373d540c8d09eff8a0b5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6c6f636f6d6f746976656d746c2f63686172636f616c2d636f6e747269622d6e6f74696669636174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/locomotivemtl/charcoal-contrib-notification)[![Code Quality](https://camo.githubusercontent.com/172fa221a11061566a638ba77bddd28ac5bfa3ca9ce3252453d7cbd56a827ca5/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f6c6f636f6d6f746976656d746c2f63686172636f616c2d636f6e747269622d6e6f74696669636174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/locomotivemtl/charcoal-contrib-notification/)[![Coverage Status](https://camo.githubusercontent.com/2ee2ddb564fc3ecda937778f34f8b8ba4c9795c4d7e5a7a34e804c6ff4fe0cfa/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f6c6f636f6d6f746976656d746c2f63686172636f616c2d636f6e747269622d6e6f74696669636174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/locomotivemtl/charcoal-contrib-notification)[![Build Status](https://camo.githubusercontent.com/f952e2d4b43b9b7dcd8a6c2d296969a0ac497d2791d8dcd3e4cfcda6da6cc50e/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f6c6f636f6d6f746976656d746c2f63686172636f616c2d636f6e747269622d6e6f74696669636174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/locomotivemtl/charcoal-contrib-notification) Admin notification service. Table of Contents ----------------- [](#table-of-contents) - [Installation](#installation) - [Dependencies](#dependencies) - [Service Provider](#service-provider) - [Parameters](#parameters) - [Services](#services) - [Configuration](#configuration) - [Usage](#usage) - [Development](#development) - [API Documentation](#api-documentation) - [Development Dependencies](#development-dependencies) - [Coding Style](#coding-style) - [Credits](#credits) - [License](#license) Installation ------------ [](#installation) The preferred (and only supported) method is with Composer: ``` $ composer require locomotivemtl/charcoal-contrib-notification ``` ### Dependencies [](#dependencies) #### Required [](#required) - [**PHP 5.6+**](https://php.net): *PHP 7* is recommended. - [**locomotivemtl/charcoal-admin**](https://github.com/locomotivemtl/charcoal-admin) >=0.15.7 #### PSR [](#psr) - [**PSR-7**](https://www.php-fig.org/psr/psr-7/): Common interface for HTTP messages. Fulfilled by Slim. - [**PSR-11**](https://www.php-fig.org/psr/psr-11/): Common interface for dependency containers. Fulfilled by Pimple. Configuration ------------- [](#configuration) In your project's config file, require the notification module : ``` { "modules": { "charcoal/notification/notification": {} } } ``` Usage ----- [](#usage) Define notifiable objects with `object/collection?obj_type=charcoal/notification/notification-target` Setup your notifications via `object/collection?obj_type=charcoal/notification/notification` Set the cron jobs as follow: ``` // Daily (8 stands for 8am) 0 8 * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/daily // Hourly 0 * * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/hourly // Every minute * * * * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/minute // Monthly (8 stands for 8am) 0 8 1 * * cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/montly // Weekly (8 stands for 8am, 1 stands for monday) 0 8 * * 1 cd /[project]/web && /usr/local/bin/php /[project]/web/vendor/bin/charcoal admin/notification/weekly ``` Development ----------- [](#development) To install the development environment: ``` $ composer install ``` To run the scripts (phplint, phpcs, and phpunit): ``` $ composer test ``` ### API Documentation [](#api-documentation) - The auto-generated `phpDocumentor` API documentation is available at: - The auto-generated `apigen` API documentation is available at: [https://codedoc.pub/locomotivemtl/charcoal-contrib-notification/master/](https://codedoc.pub/locomotivemtl/charcoal-contrib-notification/master/index.html) ### Development Dependencies [](#development-dependencies) - \[php-coveralls/php-coveralls\]\[phpcov\] - \[phpunit/phpunit\]\[phpunit\] - \[squizlabs/php\_codesniffer\]\[phpcs\] ### Coding Style [](#coding-style) The charcoal-contrib-notification module follows the Charcoal coding-style: - [*PSR-1*](https://www.php-fig.org/psr/psr-1/) - [*PSR-2*](https://www.php-fig.org/psr/psr-2/) - [*PSR-4*](https://www.php-fig.org/psr/psr-4/), autoloading is therefore provided by *Composer*. - [*phpDocumentor*](http://phpdoc.org/) comments. - [phpcs.xml.dist](phpcs.xml.dist) and [.editorconfig](.editorconfig) for coding standards. > Coding style validation / enforcement can be performed with `composer phpcs`. An auto-fixer is also available with `composer phpcbf`. Credits ------- [](#credits) - [Locomotive](https://locomotive.ca/) License ------- [](#license) Charcoal is licensed under the MIT license. See [LICENSE](LICENSE) for details. ### Health Score 25 — LowBetter than 37% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community14 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 66.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~10 days Total 5 Last Release 2535d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/4229f19eecd12c2b651b6502dcc5adfba48c5770db3d2dbea55fc92c7a246b2b?d=identicon)[BeneRoch](/maintainers/BeneRoch) --- Top Contributors [![BeneRoch](https://avatars.githubusercontent.com/u/3017380?v=4)](https://github.com/BeneRoch "BeneRoch (6 commits)")[![veve40](https://avatars.githubusercontent.com/u/7537381?v=4)](https://github.com/veve40 "veve40 (2 commits)")[![JoelAlphonso](https://avatars.githubusercontent.com/u/10762266?v=4)](https://github.com/JoelAlphonso "JoelAlphonso (1 commits)") --- Tags notificationcharcoal ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/locomotivemtl-charcoal-contrib-notification/health.svg) ``` [![Health](https://phpackages.com/badges/locomotivemtl-charcoal-contrib-notification/health.svg)](https://phpackages.com/packages/locomotivemtl-charcoal-contrib-notification) ``` ### Alternatives [symfony/notifier Sends notifications via one or more channels (email, SMS, ...) 80640.3M290](/packages/symfony-notifier)[jolicode/jolinotif Send desktop notifications on Windows, Linux, MacOS. 1.4k11.6M41](/packages/jolicode-jolinotif)[duccio/apns-php Apple Push Notification & Feedback Provider 1.4k2.5M13](/packages/duccio-apns-php)[laravel-notification-channels/telegram Telegram Notifications Channel for Laravel 1.1k3.4M35](/packages/laravel-notification-channels-telegram)[mckenziearts/laravel-notify Flexible flash notifications for Laravel 1.7k1.1M5](/packages/mckenziearts-laravel-notify)[laravel-notification-channels/twilio Provides Twilio notification channel for Laravel 2587.7M12](/packages/laravel-notification-channels-twilio) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)