Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joetannenbaum/phpushbullet
A PHP library for the Pushbullet API
https://github.com/joetannenbaum/phpushbullet
Last synced: about 1 month ago
JSON representation
A PHP library for the Pushbullet API
- Host: GitHub
- URL: https://github.com/joetannenbaum/phpushbullet
- Owner: joetannenbaum
- License: mit
- Created: 2014-08-24T18:45:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-15T18:22:50.000Z (over 8 years ago)
- Last Synced: 2024-10-20T10:08:38.783Z (2 months ago)
- Language: PHP
- Size: 47.9 KB
- Stars: 32
- Watchers: 9
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHPushbullet
[](https://github.com/joetannenbaum/phpushbullet/releases)
[](LICENSE.md)
[](https://travis-ci.org/joetannenbaum/phpushbullet)
[](https://scrutinizer-ci.com/g/joetannenbaum/phpushbullet/code-structure)
[](https://scrutinizer-ci.com/g/joetannenbaum/phpushbullet)
[](https://packagist.org/packages/joetannenbaum/phpushbullet)
A PHP library for the [Pushbullet](https://www.pushbullet.com/) API.
## Table of Contents
+ [Installation](#installation)
+ [Listing Devices](#listing-devices)
+ [Pushing](#pushing)
+ [To Devices](#to-devices)
+ [To Users](#to-users)
+ [Types](#types)
+ [Notes](#notes)
+ [Links](#links)
+ [Addresses](#addresses)
+ [Lists](#lists)
+ [Files](#files)
## Installation
Using [composer](https://packagist.org/packages/joetannenbaum/phpushbullet):
```
{
"require": {
"joetannenbaum/phpushbullet": "~1.0"
}
}
```
PHPushbullet takes one optional parameter, your [Pushbullet access token](https://www.pushbullet.com/account):
```php
require_once('vendor/autoload.php');
$pushbullet = new PHPushbullet\PHPushbullet('YOUR_ACCESS_TOKEN_HERE');
```
If you do not wish to put your access token in your code (understandable), simply set it to the environment variable `pushbullet.access_token` and PHPushbullet will automatically pick it up.
## Listing Devices
To list the available devices on your account:
```php
$pushbullet->devices();
```
This will return an array of objects with all of the device information.
## Pushing
### To Devices
When pushing a to a device, simply use the device's `nickname` or their `iden` from the list above.
To push to a single device:
```php
$pushbullet->device('Chrome')->note('Remember', 'Buy some eggs.');
```
To push to multiple devices:
```php
$pushbullet->device('Chrome')->device('Galaxy S4')->note('Remember', 'Buy some eggs.');
// or
$pushbullet->device('Chrome', 'Galaxy S4')->note('Remember', 'Buy some eggs.');
// or
$pushbullet->device(['Chrome', 'Galaxy S4'])->note('Remember', 'Buy some eggs.');
```
### To Users
When pushing a to a user, simply use the user's email address:
To push to a single user:
```php
$pushbullet->user('[email protected]')->note('Remember', 'Buy some eggs.');
```
To push to multiple users:
```php
$pushbullet->user('[email protected]')->user('[email protected]')->note('Remember', 'Buy some eggs.');
// or
$pushbullet->user('[email protected]', '[email protected]')->note('Remember', 'Buy some eggs.');
// or
$pushbullet->user(['[email protected]', '[email protected]'])->note('Remember', 'Buy some eggs.');
```
## Types
### Notes
Arguments:
+ Title
+ Body
```php
$pushbullet->device('Chrome')->note('Musings', 'Why are fudgy brownies better than cakey brownies?');
```
### Links
Arguments:
+ Title
+ URL
+ Body (optional)
```php
$pushbullet->device('Chrome')->link('Look It Up', 'http://google.com', 'I hear this is a good site for finding things.');
```
### Addresses
Arguments:
+ Name
+ Address
```php
$pushbullet->device('Chrome')->address('The Hollywood Sign', '4059 Mt Lee Drive Hollywood, CA 90068');
```
Alternatively, you can pass in an associative array:
```php
$address = [
'address' => '4059 Mt Lee Drive',
'city' => 'Hollywood',
'state' => 'CA',
'zip' => '90068',
];
$pushbullet->device('Chrome')->address('The Hollywood Sign', $address);
```
### Lists
Arguments:
+ Title
+ Items (array)
```php
$items = [
'Socks',
'Pants',
'Keys',
'Wallet',
];
$pushbullet->device('Chrome')->list('Do Not Forget', $items);
```
### Files
Arguments:
+ File Name
+ File URL (must be publicly available)
+ Body (optional)
```php
$pushbullet->device('Chrome')->file('The Big Presentation', 'http://example.com/do-not-lose-this.pptx', 'Final version of slides.');
```