https://github.com/ably/ably-php-laravel
PHP Laravel framework client library SDK for Ably realtime messaging service
https://github.com/ably/ably-php-laravel
client-library laravel php sdk
Last synced: 5 months ago
JSON representation
PHP Laravel framework client library SDK for Ably realtime messaging service
- Host: GitHub
- URL: https://github.com/ably/ably-php-laravel
- Owner: ably
- License: apache-2.0
- Created: 2016-07-06T14:31:59.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T02:30:25.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T09:48:57.719Z (over 1 year ago)
- Topics: client-library, laravel, php, sdk
- Language: PHP
- Homepage: https://ably.com/download
- Size: 85 KB
- Stars: 28
- Watchers: 26
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/ably/ably-php-laravel)
[](https://github.com/ably/ably-php-laravel/blob/main/LICENSE)
---
# Ably Pub/Sub PHP Laravel SDK
Build using Ably’s Pub/Sub PHP Laravel SDK, supported on all popular platforms and frameworks.
This Laravel package provides a clean integration with the [Ably PHP](https://github.com/ably/ably-php) SDK. It includes a Facade and an injectable `AblyService` that wrap a singleton Ably instance, with configuration automatically loaded from your environment variables or config files. Additionally, the `AblyFactory` class lets you create new Ably instances with custom parameters when needed.
This SDK provides REST-only functionality for Laravel. For full-featured Laravel integration including real-time capabilities, Ably recommend using [Ably's Laravel Broadcaster](https://github.com/ably/laravel-broadcaster).
Ably Pub/Sub provides flexible APIs that deliver features such as pub-sub messaging, message history, presence, and push notifications. Utilizing Ably’s realtime messaging platform, applications benefit from its highly performant, reliable, and scalable infrastructure.
Find out more:
* [Ably Pub/Sub docs.](https://ably.com/docs/basics)
* [Ably Pub/Sub examples.](https://ably.com/examples?product=pubsub)
---
## Getting started
Everything you need to get started with Ably:
* [Getting started in Pub/Sub using PHP.](https://ably.com/docs/getting-started/php?lang=php)
* [SDK Setup for PHP.](https://ably.com/docs/getting-started/setup?lang=php)
---
## Supported platforms
Ably aims to support a wide range of platforms. If you experience any compatibility issues, open an issue in the repository or contact [Ably support](https://ably.com/support).
The PHP client library currently targets the [Ably 1.1 client library specification](https://www.ably.com/docs/client-lib-development-guide/features/).
> [!NOTE]
> See [laravel-broadcaster](https://packagist.org/packages/ably/laravel-broadcaster/), if you're using Laravel and want to support Realtime broadcasting and events.
> [!IMPORTANT]
> PHP SDK versions < 1.1.9 will be [deprecated](https://ably.com/docs/platform/deprecate/protocol-v1) from November 1, 2025.
---
## Installation
Install the package using [Composer](https://getcomposer.org/):
```bash
composer require ably/ably-php-laravel
```
Add the service provider in `config/app.php` to the `providers` array.
```php
Ably\Laravel\AblyServiceProvider::class
```
Optionally add a reference to the facade in `config/app.php` to the `aliases` array.
```php
'Ably' => Ably\Laravel\Facades\Ably::class
```
---
### Configuration
After registering the service provider, publish the configuration file using Artisan:
```bash
php artisan vendor:publish
```
Update the created file `config/ably.php` with your key or [other options](https://www.ably.com/docs/rest/usage#client-options). You can also set the key using an environment variable named `ABLY_KEY`.
## Usage
The following sections demonstrates two ways to use Ably in Laravel: via a [Facade](#facade) or through [dependency injection](#dependency-injection).
## Facade
Use the Laravel facade to access the Ably client.
Facade usage details.
The facade always returns a singleton instance created with options defined in the config file. Any methods available on an AblyRest class are available through the facade. Due to PHP limitations, properties must be accessed as methods, for example `Ably::auth()`):
```php
use Ably;
echo Ably::time(); // 1467884220000
$token = Ably::auth()->requestToken([ 'clientId' => 'client123', ]); // Ably\Models\TokenDetails
Ably::channel('testChannel')->publish('testEvent', 'testPayload', 'testClientId');
```
## Dependency injection
Use the dependency injection to access the Ably client.
Dependency injection usage details.
You can use `Ably\Laravel\AblyService` instead of the facade, which acts as a 1:1 wrapper for an AblyRest singleton instance created with default options. `Ably\Laravel\AblyFactory` lets you instantiate new AblyRest instances with (optional) custom options.
```php
use Ably\Laravel\AblyService;
use Ably\Laravel\AblyFactory;
function ablyExamples(AblyService $ably, AblyFactory $ablyFactory) {
echo $ably->time(); // 1467884220000
echo $ably->auth->clientId; // null
$tokenDetails = $ably->auth->requestToken([ 'clientId' => 'client123', ]); // Ably\Models\TokenDetails
$ably->channel('testChannel')->publish('testEvent', 'testPayload', 'testClientId');
$ablyClient = $ablyFactory->make([ 'tokenDetails' => $tokenDetails ]);
echo $ablyClient->auth->clientId; // 'client123'
}
```
---
## Releases
The [CHANGELOG.md](CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
---
## Contributing
Read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to contribute to Ably.
---
## Support, feedback, and troubleshooting
For help or technical support, visit the [Ably Support page](https://ably.com/support).
### Ably REST API
This SDK currently supports only the [Ably REST API](https://www.ably.com/docs/rest). If you need to subscribe to realtime events in PHP, consider using the [MQTT adapter](https://www.ably.com/docs/mqtt) to leverage [Ably's Realtime features](https://www.ably.com/docs/realtime).