Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scaytrase/symfony-sms-interface
SMS Sender service
https://github.com/scaytrase/symfony-sms-interface
php sms symfony-bundle symony transport
Last synced: 29 days ago
JSON representation
SMS Sender service
- Host: GitHub
- URL: https://github.com/scaytrase/symfony-sms-interface
- Owner: scaytrase
- License: mit
- Created: 2014-06-30T12:51:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-29T09:02:02.000Z (over 7 years ago)
- Last Synced: 2024-03-15T18:08:42.003Z (8 months ago)
- Topics: php, sms, symfony-bundle, symony, transport
- Language: PHP
- Homepage:
- Size: 96.7 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scaytrase/symfony-sms-delivery-bundle
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
[](https://packagist.org/packages/scaytrase/symfony-sms-interface)
This Symfony bundle provides basic service for sending short messages. This bundle does not provide you any finished
implementation for communicating the SMS gateway. To use it you have use some transport implementation or
implement a transport on your own. See [usage section](#usage) for known implementations
## Features
### Current features
- [x] Service and configurable transports
- [x] Ability to disable delivery via config for testing purposes
- [x] Ability to force redirect messages for testing purposes
- [x] Profiling via Sf2 Toolbar
- [x] Spooling and delayed sending
### Planned features
- [ ] Bulk sending
## Installation
This bunde could be installed via Composer
```
composer require scaytrase/symfony-sms-delivery-bundle:~2.0
```
### app/AppKernel.php
update your kernel bundle requirements as follows:
```php
$bundles = array(
//....
new ScayTrase\SmsDeliveryBundle\SmsDeliveryBundle(),
//....
);
```
## Configuration
Below is the configuration example and their default values
```yaml
sms_delivery:
spool: sms_delivery.spool.instant
transport: sms_delivery.dummy_sender # @id of the transport service
disable_delivery: false # disable delivery overrides spool with disabled spool
delivery_recipient: null # delivery recipient overrides recipient when sending
```
## Usage
To use this interface you must create a message class implementing ``ShortMessageInterface`` and create the implementation of the
``TransportInterface`` that delivers your message to end point sms gateway.
You can refer my [WebSMS](https://github.com/scaytrase/symfony-websms-bundle) gateway implementation as a reference.
### Example
```php
class MyMessage implements ShortMessageInterface { /*...*/ }
class SmsController extends Controller {
public function sendSmsAction()
{
$message = new MyMessage('5552368','Help!')
$sender = $this->get('sms_delivery.sender');
$sender->spoolMessage($message);
$result = $sender->flush();
return new Response('Delivery '. $result ? 'successful' : 'failed');
}
}
```
### Standalone usage
Despite of the fact that this library is designed as Symfony bundle it could be used as standalone library for sending
short messages. You should just instantiate sender service on your own.
```php
class MyProviderSmsTransport implements TransportInterface { /*...*/ }
class MyMessage implements ShortMessageInterface { /*...*/ }
$transport = new MyProviderSmsTransport();
$sender = new MessageDeliveryService($transport);
$sender->spoolMessage(new MyMessage('Message body'));
$sender->flush(); // Default InstantSpool does not actually needs flushing but you can use another spool instead
```