https://github.com/slunak/pushover-php
Light, simple and fast wrapper for the Pushover API
https://github.com/slunak/pushover-php
api-wrapper pushover pushover-api pushover-notifications pushover-php
Last synced: 11 months ago
JSON representation
Light, simple and fast wrapper for the Pushover API
- Host: GitHub
- URL: https://github.com/slunak/pushover-php
- Owner: slunak
- License: mit
- Created: 2020-06-04T04:15:21.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T06:30:41.000Z (over 1 year ago)
- Last Synced: 2025-04-09T15:05:36.655Z (11 months ago)
- Topics: api-wrapper, pushover, pushover-api, pushover-notifications, pushover-php
- Language: PHP
- Homepage: https://pushover.net/api
- Size: 431 KB
- Stars: 23
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Pushover PHP API Wrapper
[](https://github.com/slunak/pushover-php/actions)
[](https://packagist.org/packages/serhiy/pushover)
[](https://packagist.org/packages/serhiy/pushover)
[](LICENSE)
Light, simple and fast, yet comprehensive wrapper for the [Pushover](https://pushover.net/) API.
### Features
- Message API ([Example](examples/CompleteNotificationExample.php))
- Image attachment
- User's device name(s)
- Message's title
- HTML messages
- Supplementary URL and its title
- Notification priority
- Notification sound (including custom sound)
- Message time
- Time to live
- User/Group Validation API ([Example](examples/UserGroupValidationExample.php))
- Validation by user or group key
- Validation by user and device
- Receipt API ([Example](examples/ReceiptExample.php))
- Query emergency priority receipt
- Cancel emergency priority retry
- Groups API ([Example](examples/GroupsExample.php))
- Create a group
- List groups
- Retrieve information about the group
- Add / Remove users
- Enable / Disable users
- Rename the group
- Glances API ([Example](examples/GlancesExample.php))
- Title
- Text
- Subtext
- Count
- Percent
- Licensing API ([Example](examples/LicensingExample.php))
- Check remaining credits
- Assign license (not tested)
- Subscription API ([Example](examples/SubscriptionExample.php))
- User Key Migration
## Getting Started
These instructions will get you a copy of the project up and running.
### Installing
```
composer require serhiy/pushover
```
### Requirements
I aim to keep the project as simple as possible. All you need to run it is a PHP supported version,
plus its curl and json extensions. See below the `require` section of project's composer.json file:
```json
{
"require": {
"php": ">=8.2",
"ext-curl": "*",
"ext-json": "*"
}
}
```
## Pushing Messages
Instantiate pushover application and recipient of the notification:
```php
use Serhiy\Pushover\Application;
use Serhiy\Pushover\Recipient;
$application = new Application('replace_with_pushover_application_api_token');
$recipient = new Recipient('replace_with_pushover_user_key');
```
Or use Dependency Injection to inject them into the services of your app.
Compose a message:
```php
use Serhiy\Pushover\Api\Message\Message;
$message = new Message('This is a test message', 'This is a title of the message');
```
Create notification:
```php
use Serhiy\Pushover\Api\Message\Notification;
$notification = new Notification($application, $recipient, $message);
```
Push it:
```php
/** @var \Serhiy\Pushover\Client\Response\MessageResponse $response */
$response = $notification->push();
```
> [!TIP]
> For more code examples, see [examples](examples) folder in the root of the project.
## Working with response
Client returns Response object. Checking if the message was accepted is easy:
```php
if ($response->isSuccessful()) {
// ...
}
```
One can get status and token returned by Pushover:
```php
$response->getRequestStatus();
$response->getRequestToken();
```
Or even unmodified json response from the API (json_decode into an array if needed):
```php
$response->getCurlResponse();
```
Response also contains original Request object:
```php
/** @var \Serhiy\Pushover\Client\Request\Request $request */
$request = $response->getRequest();
```
Request contains array for CURLOPT_POSTFIELDS curl argument and full API URL.
```php
$request->getCurlPostFields();
$request->getApiUrl();
```
> [!TIP]
> For complete example refer to [ResponseExample.php](examples/ResponseExample.php).
## Contributing
Contributions are very welcome. If you would like to add functionality, before starting your work,
please open an issue to discuss the feature you would like to work on.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
There are many PHP wrappers for Pushover API. However, most of them seem abandoned, missing features
or require extra libraries to work. Nevertheless, many of them inspired me to work on this project.