Download the PHP package locomotivemtl/charcoal-contrib-communicator without Composer
On this page you can find all versions of the php package locomotivemtl/charcoal-contrib-communicator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download locomotivemtl/charcoal-contrib-communicator
More information about locomotivemtl/charcoal-contrib-communicator
Files in locomotivemtl/charcoal-contrib-communicator
Package charcoal-contrib-communicator
Short Description Charcoal Communicator standardizes email communications destined for users and administors.
License MIT
Homepage https://locomotivemtl.github.io/charcoal-contrib-communicator/
Informations about the package charcoal-contrib-communicator
Charcoal Communicator
A Charcoal service for easy email template presets.
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-email: ^0.3
Service Provider
Services
- communicator: Instance of
Charcoal\Communicator\Communicator
.
Configuration
The Communicator uses scenarios (such as a enquiry confirmation) grouped into channels (such as for a user or an administrator). These can be defined from the application configset:
See communicator.sample.json
for a thorough example.
Usage
The Communicator can prepare and send emails based on the selected scenario, channel, and any custom data:
By default, the Communicator will use the email address from email.default_from
from your application configset.
Development
To install the development environment:
To run the scripts (phplint, phpcs, and phpunit):
API Documentation
- The auto-generated
phpDocumentor
API documentation is available at:
https://locomotivemtl.github.io/charcoal-contrib-communicator/docs/master/ - The auto-generated
apigen
API documentation is available at:
https://codedoc.pub/locomotivemtl/charcoal-contrib-communicator/master/
Development Dependencies
Coding Style
The charcoal-contrib-communicator 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.