Download the PHP package locomotivemtl/charcoal-contrib-notification without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-notification. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-notification
More information about locomotivemtl/charcoal-contrib-notification
Files in locomotivemtl/charcoal-contrib-notification
Package charcoal-contrib-notification
Short Description Admin notification module.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-notification/
Informations about the package charcoal-contrib-notification
Charcoal FooBar
Admin notification service.
Table of Contents
- Installation
- Dependencies
- Service Provider
- Parameters
- Services
- Configuration
- Usage
- Development
- API Documentation
- Development Dependencies
- Coding Style
- Credits
- License
Installation
The preferred (and only supported) method is with Composer:
Dependencies
Required
- PHP 5.6+: PHP 7 is recommended.
- locomotivemtl/charcoal-admin >=0.15.7
PSR
- PSR-7: Common interface for HTTP messages. Fulfilled by Slim.
- PSR-11: Common interface for dependency containers. Fulfilled by Pimple.
Configuration
In your project's config file, require the notification module :
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:
Development
To install the development environment:
To run the scripts (phplint, phpcs, and phpunit):
API Documentation
- The auto-generated
phpDocumentorAPI documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-notification/docs/master/ - The auto-generated
apigenAPI documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-notification/master/
Development Dependencies
- [php-coveralls/php-coveralls][phpcov]
- [phpunit/phpunit][phpunit]
- [squizlabs/php_codesniffer][phpcs]
Coding Style
The charcoal-contrib-notification module follows the Charcoal coding-style:
- PSR-1
- PSR-2
- PSR-4, autoloading is therefore provided by Composer.
- phpDocumentor comments.
- .editorconfig for coding standards.
Coding style validation / enforcement can be performed with
composer phpcs. An auto-fixer is also available withcomposer phpcbf.
Credits
License
Charcoal is licensed under the MIT license. See LICENSE for details.