Download the PHP package ably/ably-php-laravel without Composer
On this page you can find all versions of the php package ably/ably-php-laravel. 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 ably-php-laravel
Ably PHP Laravel Wrapper
Warning If you're using Laravel and want to support realtime broadcasting and events, it is recommended to use ably/laravel-broadcaster instead.
Ably is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale. For more information, see the Ably documentation.
This is a simple Laravel wrapper / bridge for the Ably PHP library. It provides a Facade and an injectable AblyService that both act as a wrapper for a singleton Ably instance. The instance gets its parameters automatically from your config file or environment variables. You can also use AblyFactory for creating new Ably instances with (optional) custom parameters.
The PHP client library currently targets the Ably 1.1 client library specification. You can jump to the 'view our client library SDKs feature support matrix to see the list of all the available features.
Supported Platforms
This SDK supports PHP 7.2+ and 8.0
We regression-test the library against a selection of PHP versions (which will change over time, but usually consists of the versions that are supported upstream). Please refer to the travis config for the set of versions that currently undergo CI testing.
We'll happily support (and investigate reported problems with) any reasonably-widely-used PHP version. If you find any compatibility issues, please do raise an issue in this repository or contact Ably customer support for advice.
Note
If you're using Laravel and want to support realtime broadcasting and events, you may want to check out laravel-broadcaster.
Known Limitations
-
Currently, this SDK only supports Ably REST. However, if you want to subscribe to events in PHP, you can use the MQTT adapter to implement Ably's Realtime features in PHP.
- This wrapper has limited use-cases and laravel-broadcaster is recommended for most cases.
This SDK is not compatible with some of the Ably features:
| Feature |
|---|
| Remember fallback host during failures |
| MsgPack Binary Protocol |
Installation
Add this package to your project, with Composer
Add the service provider in config/app.php to the providers array.
Optionally add a reference to the facade in config/app.php to the aliases array.
Configuration
After adding the service provider, run the following command to have Laravel set up a configuration file for you.
Update the created file config/ably.php with your key or other options. You can also set the key using an environment variable named ABLY_KEY.
Usage
Facade
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. Note that properties must be called like functions (i.e. Ably::auth()), this is a limitation of PHP.
Dependency injection
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.
Documentation
Visit https://www.ably.com/docs for a complete API reference and more examples.
Release Process
This library uses semantic versioning. For each release, the following needs to be done:
- Update the dependency on ably-php within composer.json to the latest version, commit this change and push to
origin. - Create a new branch for the release, named like
release/1.0.0(where1.0.0is what you're releasing, being the new version). - Run
github_changelog_generatorto automate the update of the CHANGELOG. Once theCHANGELOGupdate has completed, manually change theUnreleasedheading and link with the current version number such as1.0.0. Also ensure that theFull Changeloglink points to the new version tag instead of theHEAD. - Commit generated CHANGELOG.md file.
- Make a PR against
main. - Once the PR is approved, merge it into
main. - Add a tag and push to origin such as
git tag 1.0.0 && git push origin 1.0.0. - Visit https://github.com/ably/ably-php-laravel/tags and add release notes for the release including links to the changelog entry.
- Visit https://packagist.org/packages/ably/ably-php-laravel, log in to Packagist, and click the "Update" button.
License
Copyright (c) 2022 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to LICENSE for the license terms.
