Download the PHP package satori-com/satori-rtm-sdk-php without Composer

On this page you can find all versions of the php package satori-com/satori-rtm-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package satori-rtm-sdk-php

Satori RTM SDK for PHP

GitHub tag

Use the PHP SDK for the Satori platform to create applications that use the RTM to publish and subscribe.

Requirements

PHP SDK Installation and Usage

Via Composer

To install the PHP SDK from the Central Composer repository use composer:

Highly recommended to use version tag when installing SDK:

Detailed information about the PHP SDK package and a list of available versions can be found here: https://packagist.org/packages/satori-com/satori-rtm-sdk-php

Include the SDK into your PHP file using the Composer autoloader:

Via Source Code

Clone the PHP SDK to your project (or any directory on your computer):

Include the SDK into your PHP file using the SDK autoloader:

Documentation and Examples

https://satori-com.github.io/satori-rtm-sdk-php/

Logging and Debugging

PHP SDK logs information to STDOUT/STDERR. To enable debug level, set DEBUG_SATORI_SDK environment variable to true:

or

Debug level outputs all underlying communication with RTM, in addition to SDK execution info.
Example:

Testing

PHP SDK uses PHPUnit for testing. PHPUnit requires PHP 5.6+. In spite of PHP SDK itself requires PHP 5.4+, you have to upgrade your PHP version to 5.6+.

Tests require a valid RTM endpoint; RTM credentials should be populated in credentials.json.

The credentials.json file must include the following key-value pairs:

You must use DevPortal to create role and set channel permissions.

After setting up credentials.json, run SDK tests with the following commands:

To enable testing verbose mode use:

Binary protocol

RTM supports CBOR protocol to work with a binary data.
In order to use CBOR protocol you must to install PHP SDK via Composer: How to install SDK via Composer

See examples/cbor.php to get more information about establishing a connection using CBOR.

Persistent connections

Persistent connections are good solution to reduce execution time by using an already established connection. PHP does not spend additional time establishing a new connection and authorization.

But this solution has a number of limitations:

Usage:

IMPORTANT NOTICE

Persistent connections work only in the environments that support persistent connections, like PHP-FPM mode, FastCGI mode, Apache mod_php, etc.

Troubleshooting

Unable to Connect to a Secure Endpoint

Symptom:

$ php your_app/index.php
[info] 2017/08/03 15:28:22.512700 Client: Connecting to endpoint: wss://<endpoint>.api.satori.com/v2
[erro] 2017/08/03 15:28:22.535000 Failed establish connection to <endpoint>.api.satori.com:443:  (0)

Solution:


All versions of satori-rtm-sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
2tvenom/cborencode Version dev-master
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package satori-com/satori-rtm-sdk-php contains the following files

Loading the files please wait ....