https://github.com/secit-pl/signal-notifier-bundle

Symfony Notifier Signal support
https://github.com/secit-pl/signal-notifier-bundle

Last synced: about 1 month ago
JSON representation

Symfony Notifier Signal support

• Host: GitHub
• URL: https://github.com/secit-pl/signal-notifier-bundle
• Owner: secit-pl
• License: mit
• Created: 2020-07-14T12:31:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-21T01:19:34.000Z (almost 4 years ago)
• Last Synced: 2024-04-19T11:21:38.423Z (9 months ago)
• Language: PHP
• Size: 6.84 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Symfony Signal Notifier Bundle

Signal support for Symfony Notifier 5.1+.

This bundle wraps [signal-cli](https://github.com/AsamK/signal-cli) into symfony notifier transport. 

To make it work you need to have possibility to execute [signal-cli](https://github.com/AsamK/signal-cli) command.

## Installation

From the command line run

```

$ composer require secit-pl/signal-notifier-bundle

```

## Configuration

First of all you should have properly set up the [signal-cli](https://github.com/AsamK/signal-cli). If it's working you are ready to proceed.

#### config/packages/notifier.yaml

```yaml

framework:

    notifier:

        texter_transports:

            signal: '%env(SIGNAL_DSN)%' # add Signal support

        channel_policy:

            urgent: ['sms/signal'] # setup it for specified channel

            high: ['email']

            medium: ['email']

            low: ['email']

```

#### .env

Configure the Signal DSN using the following format:

```dotenv

SIGNAL_DSN=signal://localhost?cli=SIGNAL_CLI_PATH&user=USER_NAME

```

Remember to properly encode the phone number. 

The + sign should be encoded as %2b so the number +481234567890 should be written as %2b481234567890!

For example:

```dotenv

SIGNAL_DSN=signal://localhost?cli=/usr/local/Cellar/signal-cli/0.6.8/bin/signal-cli&user=%2b48123456789

```

## Usage

You can now send the signal messages using Symfony Notifier.

If you'd like to send the message directly using Singal transport you can do it as follows:

```php

send((new SmsMessage(

            '+481234567890',

            'Hello :)'

        ))->transport('signal'));

        // ...

    }

}

```