https://github.com/keinos/mastodon_streamingapi_listener

✅ PHP7 class that listens to the Mastodon Streaming API's server-sent messages.
https://github.com/keinos/mastodon_streamingapi_listener

mastodon mastodon-api php7 php8 streaming-api

Last synced: 3 days ago
JSON representation

✅ PHP7 class that listens to the Mastodon Streaming API's server-sent messages.

• Host: GitHub
• URL: https://github.com/keinos/mastodon_streamingapi_listener
• Owner: KEINOS
• License: mit
• Created: 2020-07-25T03:20:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-23T05:41:00.000Z (almost 4 years ago)
• Last Synced: 2024-04-13T21:03:39.977Z (10 months ago)
• Topics: mastodon, mastodon-api, php7, php8, streaming-api
• Language: PHP
• Homepage:
• Size: 83 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![](https://travis-ci.com/KEINOS/Mastodon_StreamingAPI_Listener.svg?branch=master)](https://travis-ci.com/github/KEINOS/Mastodon_StreamingAPI_Listener "View Build Status on Travis")

[![](https://img.shields.io/coveralls/github/KEINOS/Mastodon_StreamingAPI_Listener)](https://coveralls.io/github/KEINOS/Mastodon_StreamingAPI_Listener?branch=master "Code Coverage on COVERALLS")

[![](https://img.shields.io/scrutinizer/quality/g/KEINOS/Mastodon_StreamingAPI_Listener/master)](https://scrutinizer-ci.com/g/KEINOS/Mastodon_StreamingAPI_Listener/?branch=master "Code quality in Scrutinizer")

[![](https://img.shields.io/packagist/php-v/keinos/mastodon-streaming-api-parser)](https://github.com/KEINOS/Mastodon_StreamingAPI_Listener/blob/master/.travis.yml "Version Support")

# Simple Mastodon Streaming API Listener

This is a PHP class that listens to the Mastodon Streaming API's server-sent messages.

## Install

```bash

composer require keinos/mastodon-streaming-api-listener

```

## Usage

```php

 'https://qiitadon.com/',

];

$listener = new \KEINOS\MSTDN_TOOLS\Listener\Listener($conf);

/**

 * $listener ............ The iterator.

 *   $event_name ........ Event name. ("update" or "delete")

 *   $data_payload ...... Data of the event in JSON string.

 */

foreach($listener as $event_name => $data_payload) {

    echo 'Event name: ' . $event_name . PHP_EOL;

    echo 'Data: '. PHP_EOL;

    print_r(json_decode($data_payload));

}

```

```php

 'https://qiitadon.com/',

    // If the server is in "whitelist-mode" then you'll need an access token.

    'access_token' => 'YOUR_ACCESS_TOKEN',

];

$listener = new Listener($conf);

foreach($listener as $event_name => $data_payload) {

    echo 'Event name: ' . $event_name . PHP_EOL;

    echo 'Data: '. PHP_EOL;

    print_r(json_decode($data_payload));

}

```

```php

 'https://qiitadon.com/',

    // To listen the local time line stream set 'local'. 'public' is the default.

    'type_stream' => 'local',

];

$listener = new Listener($conf);

foreach($listener as $event_name => $data_payload) {

    echo 'Event name: ' . $event_name . PHP_EOL;

    echo 'Data: '. PHP_EOL;

    print_r(json_decode($data_payload));

}

```

## Package Information

- Packagist: https://packagist.org/packages/keinos/mastodon-streaming-api-listener

- Source: https://github.com/KEINOS/Mastodon_StreamingAPI_Listener

- Issues: https://github.com/KEINOS/Mastodon_StreamingAPI_Listener/issues

- License: [MIT](https://github.com/KEINOS/Mastodon_StreamingAPI_Listener/blob/master/LICENSE)

- Authors: [KEINOS and the contributors](https://github.com/KEINOS/Mastodon_StreamingAPI_Listener/graphs/contributors)