Download the PHP package midnite81/prowl without Composer
On this page you can find all versions of the php package midnite81/prowl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package prowl
Prowl
A PHP wrapper for using the Prowl API, with a Laravel 5 service provider for integration with Laravel
Installation
This package requires PHP 5.6+, and comes with a Laravel Service Provider and Facade for Laravel integration. Please note, you do not need to have laravel installed to use this package.
To install through composer include the package in your composer.json.
"midnite81/prowl": "^2.0.0"Run composer install or composer update to download the dependencies or you can
run composer require midnite81/prowl.
Http Standards
To adhere to better standards, this package uses the popular and powerful PHP-HTTP library
to make HTTP requests. By default a Guzzle adapter is required when using midnite81\prowl.
This allows you, should you wish, to use your own HTTP Client instead of Guzzle. For more
information on PHP-HTTP, please visit php-http.org
Versioning
| Version | Description |
|---|---|
| v3.* | Support added to use Carbon 1 or 2 as a dependency |
| v2.* | Completely rewritten from the ground up, with no additional prowl dependencies |
| v1.* | Unsupported - Relied on other prowl packages |
Laravel 5 Integration
If you wish to use this package with Laravel, please visit the laravel specific readme.
Standard (Non laravel) implementation
To get started using this Prowl wrapper, you will need to instantiate the prowl class. The construct of the Prowl
object takes an array for configuration. If you don't provide one, it will just use default values. In the example
below I've provided a sample config.
There are four main methods on the Prowl class, which identify the main four api calls you can make.
| Api Method | Prowl Method | Description |
|---|---|---|
| add | $prowl->add(Notification $notification) | Sends a push notification to one or more devices |
| verify | $prowl->verify($apiKey, $providerKey) | Verifies the api key is valid |
| retrieve/token | $prowl->retrieveToken($providerKey) | Get a registration token for use in retrieve/apikey |
| retrieve/apikey | $prowl->retrieveApiKey($providerKey, $token) | Get an API Key from a registration token received in retrieve/token |
To understand what each of these api calls does, you should check out the documentation at https://www.prowlapp.com/api.php
In order to send a notification to a prowl linked device, you will need to create a Notification object. There are a
couple of ways in which to do this. You can either call instantiate a new Notification object or you can call it
from the Prowl object. If you call it from the Prowl object the prowl object will be sent to it so you can call the
send method via chaining. There are a couple of factory methods on the Notification object should you rather use those.
Once the notification object is created you can call methods to add to the Object. For example;
Once the notification has all the parameters it needs you can pass it to the add method to trigger a push notification.
Unless there are any Exceptions thrown you will receive a Response object back. For more information on the response
object please view readme-response.md
All versions of prowl with dependencies
php-http/guzzle6-adapter Version ^1.1
php-http/client-implementation Version ^1
php-http/message Version ^1.5
php-http/discovery Version ^1.2.1
nesbot/carbon Version ^1.3|^2.0
midnite81/xml2array Version ^1.0