Download the PHP package nikapps/ortc-laravel without Composer

ORTC-Laravel (ORTC client for Laravel)

An Easy-To-Use ORTC API Client for Laravel Framework (Laravel 5.1 and 5.2)

If you're using Laravel 4.2.x, please check branch l4

This package is based on nikapps/ortc-php.

Installation

You can install this package by simply run this composer command:

Then, add this service provider in your providers array [app/config/app.php]:

Nikapps\OrtcLaravel\OrtcLaravelServiceProvider::class,

Then, add this Facade to your aliases array [app/config/app.php]:

'Ortc' => Nikapps\OrtcLaravel\Facades\Ortc::class

Next you have to copy the configuration to your connections array [app/config/broadcasting.php]:

'realtime' => [
    'driver' => 'realtime',
    'credentials' => [

        /*
         * your application key
         */
        'application_key' => 'YOUR_APPLICATION_KEY',
        /*
         * your private key
         */
        'private_key'     => 'YOUR_PRIVATE_KEY',

    ],
    /*
    |--------------------------------------------------------------------------
    | Real-time REST API Options
    |--------------------------------------------------------------------------
    | you can change default options of api.
    |
    */
    'api'         => [
        /*
         * send message
         */
        'send_message'   => [
            'path'               => '/send', //api path
            'max_chunk_size'     => 700, //maximum size of each message in bytes
            'batch_pool_size'    => 5, //pool size for concurrent requests
            'pre_message_string' => '{RANDOM}_{PART}-{TOTAL_PARTS}_' //pre message string format
        ],
        /*
         * authentication
         */
        'authentication' => [
            'path' => '/authenticate' //api path
        ],
        /*
         * url to fetch balancer url
         */
        'balancer_url'   => 'https://ortc-developers.realtime.co/server/2.1?appkey={APP_KEY}',
        /*
         * verify ssl/tls certificate
         */
        'verify_ssl'     => true
    ]
]

Configuration

Get Application Key & Private Key

First of all, you should register on realtime.co and get your api keys.

• Login/Register at https://accounts.realtime.co

• Create new Subscription

• You can see your Application Key and Private Key

• If you want to use authentication, you should enable it in your panel.

Update config file

Edit app/config/broadcasting.php:

/*
* set default broadcasting driver to realtime
*/
'default' => env('BROADCAST_DRIVER', 'realtime'),

'credentials' => [

    /*
     * your application key
     */
    'application_key' => 'YOUR_APPLICATION_KEY',
    /*
     * your private key
     */
    'private_key'     => 'YOUR_PRIVATE_KEY',

],

Done!

Usage

Get Balancer URL (Manually)

This package automatically get balancer url (best available server), but if you want fetch a new balancer url manually:

$balancerUrl = Ortc::getBalancerUrl();

echo 'Balancer Url: ' . $balancerUrl->getUrl();

Authentication

In order to authenticate a user:

$channels = [
    'channel_one' => 'w',
    'channel_two' => 'r'
];

Ortc::authenticate(
    $authToken, //authentication token
    $channels,
    $ttl, //(optional) default: 3600
    $isPrivate //(optional) default: false
);

Send Message via broadcasting service (recommend) (Push)

See laravel/Events - Marking Events For Broadcast

Below a short example:

Create a new Event

Open up app/Events/TestEvent.php and edit

To fire the event:

$value = 'test 123';
event(new TestEvent($user, $value));

The result will be:

{
    "event": "testEvent",
    "payload": {
        "value": "test 123"
    }
}

Send Message manually (Push)

In order to push a message to a channel:

Ortc::send(
    $channel, //channel name
    $authToken, //authentication token
    $message //message (string)
);

If you are using UTF-8 messages, It's better to use base64_encode().

Exceptions

See nikapps/ortc-php - Exceptions

Dependencies

• nikapps/ortc-php (1.x)

Ortc Documentation

This package is based on ORTC REST API. You can download REST service documentation from this url:

TODO

• add UnitTest (codeception or phpunit)
• subscribe channel(s) by Ratchet/Nodejs
• support mobile push notification (ios & android)
• support presence channels
• Anything else?!

Credits

• Thanks to realtime.co teams for their amazing platform
• Thanks to João Parreira for his php library
• Thanks to rdarda for sending the pull request to support Laravel 5.1

Contribute

Wanna contribute? simply fork this project and make a pull request!

License

This project released under the MIT License.

Donation