get-stream/stream

A PHP client for Stream (https://getstream.io)

Official PHP SDK for Stream Feeds

, _(*1)

, _(*2)

Official PHP API client for Stream Feeds, a web service for building scalable newsfeeds and activity streams.
Explore the docs »

Laravel Feeds Library · Report Bug · Request Feature , _(*3)

📝 About Stream

💡 Note: this is a library for the Feeds product. The Chat SDKs can be found here., _(*4)

You can sign up for a Stream account at our Get Started page., _(*5)

You can use this library to access Feeds API endpoints server-side., _(*6)

For the client-side integrations (web and mobile) have a look at the JavaScript, iOS and Android SDK libraries (docs)., _(*7)

💡 Note: there is also a higher level Laravel integration which hooks into the Eloquent ORM., _(*8)

⚙️ Installation

$ composer require get-stream/stream

Composer will install our latest version automatically., _(*9)

PHP compatibility

Current releases require PHP 8.0 or higher, and depends on Guzzle version ^7.5.0., _(*10)

If you need to use the client with an old PHP or earlier versions of Guzzle, you can grab an earlier version of this package, for example:, _(*11)

$ composer require get-stream/stream:"~5.0.0"

See the action for details of how it is built and tested against different PHP versions., _(*12)

📚 Documentation

Our full documentation for this package is available at https://getstream.io/docs/php/., _(*13)

✨ Getting started

First, signup here for a free account and grab your API key and secret., _(*14)

Initiating a Client and a Feed object:, _(*15)

// Instantiate a new client, find your API keys in the dashboard.
$client = new GetStream\Stream\Client('YOUR_API_KEY', 'YOUR_API_SECRET');

// Instantiate a feed object
$userFeed = $client->feed('user', '1');

// If you want, you can set a custom http handler
$handler = new \GuzzleHttp\HandlerStack();
$stack->push(Middleware::mapRequest(function (RequestInterface $r) {
    echo 'Sending request to Stream Feeds API: ' . $r->getUri() . PHP_EOL;
    return $r;
}));
$client->setCustomHttpHandler($handler);

By default, the Client will target the GetStream REST API at stream-io-api.com/api. If you want to change this for some reason you can set the STREAM_BASE_URL environment variable., _(*16)

Activities in a feed:, _(*17)

// Create a new activity
$data = [
    'actor' => '1',
    'verb' => 'like',
    'object' => '3',
    'foreign_id' => 'like:42',
];

$response = $userFeed->addActivity($data);

// The response will include Stream's internal ID:
// {"id": "e561...", "actor": "1", ...}

// Get the latest activities for this user's personal feed, based on who they are following.
$response = $userFeed->getActivities();

// Get activities directly by their ID or combination of foreign ID and time.
$response = $client->getActivitiesById(['74b9e88a-a684-4197-b30c-f5e568ef9ae2', '965f7ba5-8f1d-4fd1-a9ee-22d1a2832645']);
$response = $client->getActivitiesByForeignId(['fid:123', '2006-01-02T15:04:05.000000000'], ['fid:456', '2006-01-02T16:05:06.000000000']);

// The response will be the json decoded API response.
// {"duration": 45ms, "next": "/api/v1.0/feed/...", "results": [...]}

// Remove an activity by its ID
$userFeed->removeActivity('e561de8f-00f1-11e4-b400-0cc47a024be0');

// To remove activities by their foreign_id, set the "foreign id" flag to true.
$userFeed->removeActivity('like:42', true);

Following/follower relations of a feed:, _(*18)

// When user 1 starts following user 37's activities
$userFeed->follow('user', '37');

// When user 1 stops following user 37's activities
$userFeed->unfollow('user', '37');

// Retrieve followers of a feed
$userFeed->followers();

// Retrieve feeds followed by $userFeed
$userFeed->following();

Advanced activity operations:, _(*19)

// Create a bit more complex activity with custom fields
$data = [
    'actor' => 1,
    'verb' => 'run',
    'object' => 1,
    'foreign_id' => 'run:42',

    // Custom fields:
    'course' => [
        'name'=> 'Golden Gate park',
        'distance'=> 10,
    ],
    'participants' => ['Thierry', 'Tommaso'],
    'started_at' => new DateTime('now', new DateTimeZone('Pacific/Nauru'),
];

// Add an activity and push it to other feeds too using the `to` field
$data = [
    'actor' => '1',
    'verb' => 'like',
    'object' => '3',
    'to' => [
        'user:44',
        'user:45',
    ],
];

$userFeed->addActivity($data);

// Batch adding activities
$activities = [
    ['actor' => '1', 'verb' => 'tweet', 'object' => '1'],
    ['actor' => '2', 'verb' => 'like', 'object' => '3'],
];

$userFeed->addActivities($activities);

Advanced batching:, _(*20)

// Batch operations (batch activity add, batch follow)
$batcher = $client->batcher();

// Add one activity to many feeds
$activity = ['actor' => '1', 'verb' => 'tweet', 'object' => '1'];
$feeds = ['user:1', 'user:2'];

$batcher->addToMany($activity, $feeds);

// Create many follow relations
$follows = [
    ['source' => 'user:b1', 'target' => 'user:b2'],
    ['source' => 'user:b1', 'target' => 'user:b3'],
];

$batcher->followMany($follows);

Generating tokens for client-side usage:, _(*21)

// Generating a user token
$userToken = $client->createUserSessionToken("the-user-id");

RateLimits:, _(*22)

If your app hits a ratelimit, a StreamFeedException is thrown. You can get additional info by catching the exception and calling the following methods:, _(*23)

try {
    $client->updateActivity($activity);
}catch(StreamFeedException $e){
    $limit = $e->getRateLimitLimit();
    $remaining = $e->getRateLimitRemaining();
    $reset = $e->getRateLimitReset(); // a unix timestamp
}

Reactions:, _(*24)

The reactions module has the following methods., _(*25)

- add(string $kind, string $activityId, string $userId, array $data=null, array $targetFeeds=null)
- addChild(string $kind, string $parentId, string $userId, array $data=null, array $targetFeeds=null)
- delete(string $reactionId)
- filter(string $lookupField, string $lookupValue, string $kind=null, array $params=null)
- get(string $reactionId)
- update(string $reactionId, array $data=null, array $targetFeeds=null)

Also see documention on the reactions endpoint, _(*26)

$reaction = $client->reactions()->add('like', $activity_id, 'bob');

$bob_likes = $client->reactions()->filter('user_id', 'bob', 'like');

$client->reactions()->delete($reaction['id']);

Users:, _(*27)

The users module has the following methods., _(*28)

- add(string $userId, array $data=null, bool $getOrCreate=false)
- createReference(string $userId)
- delete(string $userId)
- get(string $userId)
- update(string $userId, array $data=null)

Also see documention on the users endpoint, _(*29)

$user = $client->users()->add('42');

$user =  $client->users()->update('42', array('name' => 'Arthur Dent');

$client->users()->delete('42');

Again, our full documentation with all options and methods, is available at https://getstream.io/docs/php/., _(*30)

☯️ Framework integration

Laravel

There's a higher level integration with Laravel called get-stream/stream-laravel. The stream-laravel integration helps you to hook into the Laravel's Eloquent ORM to sync data to Stream., _(*31)

✍️ Contributing

Project is licensed under the BSD 3-Clause., _(*32)

We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our Contributor License Agreement (CLA) first. See our license file for more details., _(*33)

🧑‍💻 We are hiring!

We've recently closed a $38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world., _(*34)

Check out our current openings and apply via Stream's website., _(*35)