Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunaoka/push-notifications-php
Push notifications Library for PHP
https://github.com/sunaoka/push-notifications-php
apns apple-push-notifications fcm firebase-cloud-messaging notifications php php55 php56 php70 php71 php72 php73 php74 php80 php81 push push-notifications
Last synced: about 9 hours ago
JSON representation
Push notifications Library for PHP
- Host: GitHub
- URL: https://github.com/sunaoka/push-notifications-php
- Owner: sunaoka
- License: mit
- Created: 2021-10-11T11:23:25.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-08-09T01:12:21.000Z (about 2 months ago)
- Last Synced: 2024-08-09T02:34:15.905Z (about 2 months ago)
- Topics: apns, apple-push-notifications, fcm, firebase-cloud-messaging, notifications, php, php55, php56, php70, php71, php72, php73, php74, php80, php81, push, push-notifications
- Language: PHP
- Homepage: https://packagist.org/packages/sunaoka/push-notifications-php
- Size: 84 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Push notifications Library for PHP
[](https://packagist.org/packages/sunaoka/push-notifications-php)
[](https://packagist.org/packages/sunaoka/push-notifications-php)
[](composer.json)
[](https://github.com/sunaoka/push-notifications-php/actions/workflows/test.yml)
[](https://codecov.io/gh/sunaoka/push-notifications-php)
---
## Supported Protocols
| Protocol | Supported | Driver | Options |
| -------------------------- | :--------: | ------------------ | ------------------------- |
| APNs ([Token Based]) | ✓ | `APNs\Token` | `APNs\Token\Option` |
| APNs ([Certificate Based]) | ✓ | `APNs\Certificate` | `APNs\Certificate\Option` |
| APNs ([Binary Provider]) | | | |
| FCM ([HTTP v1]) | ✓ | `FCM\V1` | `FCM\V1\Option` |
| FCM ([Legacy JSON]) | Deprecated | `FCM\Json` | `FCM\Json\Option` |
| FCM ([Legacy Plain Text]) | Deprecated | `FCM\PlainText` | `FCM\PlainText\Option` |
| FCM ([XMPP]) | | | |
## Installation
```bash
composer require sunaoka/push-notifications-php
```
## Basic Usage
For example, in the case of APNs [Token Based].
```php
[
'alert' => [
'title' => 'Game Request',
'body' => 'Bob wants to play poker',
],
],
];
$options = new APNs\Token\Option();
$options->payload = $payload;
$options->authKey = '/path/to/key.p8';
$options->keyId = 'ABCDE12345';
$options->teamId = 'ABCDE12345';
$options->topic = 'com.example.app';
$driver = new APNs\Token($options);
$pusher = new Pusher();
$feedback = $pusher->to('Device token')->send($driver);
$result = $feedback->isSuccess('Device token');
if (! $result) {
echo $feedback->failure('Device token');
// BadDeviceToken
}
```
## How to specify options
There are two ways to specify the option.
```php
$options = new APNs\Token\Option();
$options->payload = $payload;
$options->authKey = '/path/to/key.p8';
$options->keyId = 'ABCDE12345';
$options->teamId = 'ABCDE12345';
$options->topic = 'com.example.app';
```
or
```php
$options = new APNs\Token\Option([
'payload' => $payload,
'authKey' => '/path/to/key.p8',
'keyId' => 'ABCDE12345',
'teamId' => 'ABCDE12345',
'topic' => 'com.example.app',
]);
```
## Multicast message
Specify an array of device tokens in `Pusher::to()`.
Then, you can distribute to multiple devices.
```php
$pusher = new Pusher();
$feedback = $pusher->to([
'Device token 1',
'Device token 2',
'Device token 3',
])->send($driver);
```
## How to switch between the production and development environments (only APNs)
This is specified as an argument when creating an instance of `Pusher`.
```php
// Development environment (default)
$pusher = new Pusher(false);
```
```php
// Production environment
$pusher = new Pusher(true);
```
## Feedback
The return value of `Pusher::send()` is a `Feedback` object.
With the `Feedback` object, you can determine whether the notification succeeded or failed.
```php
$pusher = new Pusher();
$feedback = $pusher->to('Device token')->send($driver);
$result = $feedback->isSuccess('Device token');
if ($result) {
echo $feedback->success('Device token');
// 01234567-0123-0123-0123-01234567890A
} else {
echo $feedback->failure('Device token');
// BadDeviceToken
}
```
## HTTP Request Option
You can specify [Guzzle Request Options] as a driver option.
```php
$options = new APNs\Token\Option();
$options->httpOptions = [
'connect_timeout' => 3.14
'timeout' => 3.14,
'debug' => true,
];
```
## More examples
More examples can be found in the [examples](example) directory.
[Token Based]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_token-based_connection_to_apns
[Certificate Based]: https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/establishing_a_certificate-based_connection_to_apns
[Binary Provider]: https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/BinaryProviderAPI.html
[HTTP v1]: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
[Legacy JSON]: https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json
[Legacy Plain Text]: https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-plain-text
[XMPP]: https://firebase.google.com/docs/cloud-messaging/xmpp-server-ref
[Guzzle Request Options]: https://docs.guzzlephp.org/en/stable/request-options.html