Download the PHP package spatie/twitter-streaming-api without Composer
On this page you can find all versions of the php package spatie/twitter-streaming-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/twitter-streaming-api
More information about spatie/twitter-streaming-api
Files in spatie/twitter-streaming-api
Package twitter-streaming-api
Short Description Easily work with the Twitter Streaming API
License MIT
Homepage https://github.com/spatie/twitter-streaming-api
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 twitter-streaming-api
Easily work with the Twitter Streaming API
Twitter provides a streaming API with which you can do interesting things such as listening for tweets that contain specific strings or actions a user might take (e.g. liking a tweet, following someone,...). This package makes it very easy to work with the API.
Here's a quick example:
There's no polling involved. The package will keep an open https connection with Twitter, events will be delivered in real time.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Postcardware
You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
The best postcards will get published on the open source page on our website.
Installation
You can install the package via composer:
Getting credentials
In order to use this package you'll need to get some credentials from Twitter. Head over to the Developer Portal on Twitter to create an application.
Once you've created your application, click on the Keys and tokens tab to retrieve your bearer_token
, api_key, api_secret_key.
Usage
Currently, this package works with the public stream and the user stream. Both the PublicStream and UserStream
classes provide a startListening function that kicks of the listening process. Unless you cancel it your PHP process
will execute that function forever. No code after the function will be run.
The public stream
The public stream can be used to listen for specific words that are being tweeted, receive Tweets that are being sent from specific locations or to follow one or more users tweets.
Listen for Tweets containing specific words
The first parameter of whenHears must be a string or an array containing the word or words you want to listen for. The
second parameter should be a callable that will be executed when one of your words is used on Twitter.
Listen for Tweets from specific locations
The first parameter of whenFrom must be an array containing one or more bounding boxes, each as an array of 4 element
lon/lat pairs (looking
like [<south-west point longitude>, <south-west point latitude>, <north-east point longitude>, <north-east point latitude>])
. The second parameter should be a callable that will be executed when a Tweet from one of your tracked locations is
being sent.
Track all tweets from San Francisco or New York:
Track all tweets with a location (from all over the world):
Listen for Tweets from specific users
The first parameter of whenTweets must be a string or an array containing the Twitter user ID or IDs you wish to
follow. The second parameter should be a callable that will be executed when one of your followed users tweets. Only
public information relating to the Twitter user will be available.
The user stream
A word to the wise
These APIs work in realtime, so they could report a lot of activity. If you need to do some heavy work processing that activity, it's best to put that work in a queue to keep your listening process fast.
If you need more advanced functionalities, consider checking out redwebcreation/twitter-streaming-api.
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
Credits
- Freek Van der Herten
- All Contributors
About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
License
The MIT License (MIT). Please see License File for more information.
