https://github.com/noweh/laravel-twitter

Laravel Wrapper for Twitter API V2.
https://github.com/noweh/laravel-twitter

api laravel php twitter twitter-api

Last synced: 21 days ago
JSON representation

Laravel Wrapper for Twitter API V2.

• Host: GitHub
• URL: https://github.com/noweh/laravel-twitter
• Owner: noweh
• License: mit
• Created: 2021-12-07T19:23:56.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-17T21:11:37.000Z (over 1 year ago)
• Last Synced: 2024-09-19T03:15:35.189Z (about 2 months ago)
• Topics: api, laravel, php, twitter, twitter-api
• Language: PHP
• Homepage:
• Size: 4.88 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Twitter API V2 for Laravel

![Laravel](https://img.shields.io/badge/Laravel-v6/7/8-828cb7.svg?style=flat-square&logo=Laravel&color=FF2D20)

![PHP](https://img.shields.io/badge/PHP-v7.4-828cb7.svg?style=flat-square)

[![Badge Twitter](https://img.shields.io/badge/Twitter%20API-v2-828cb7.svg?style=flat-square&logo=twitter&color=1DA1F2)](https://developer.twitter.com/en/docs/twitter-api)

[![last version](https://img.shields.io/packagist/v/noweh/laravel-twitter)](https://packagist.org/packages/noweh/laravel-twitter)

[![Run Tests](https://github.com/noweh/twitter-api-v2-php/actions/workflows/run-tests.yml/badge.svg)](https://github.com/noweh/twitter-api-v2-php/actions/workflows/run-tests.yml)

[![MIT Licensed](https://img.shields.io/github/license/noweh/laravel-twitter)](licence.md)

A Laravel Wrapper for the Twitter REST API V2 endpoints.

This package is an extension of [noweh/twitter-api-v2-php](https://github.com/noweh/twitter-api-v2-php), for a simplified integration in Laravel with the Facades.

## Installation

First you need to add the component to your composer.json

```

composer require noweh/laravel-twitter

```

Update your packages with *composer update* or install with *composer install*.

Laravel uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

### Laravel without auto-discovery

    Noweh\Twitter\TwitterServiceProvider::class,

To use the facade, add this in app.php:

    'Twitter' => Noweh\Twitter\TwitterFacade::class,

### Service Provider

After updating composer, add the ServiceProvider to the providers array in config/app.php

## Configuration file

Next, you must migrate config :

    php artisan vendor:publish --provider="Noweh\Twitter\TwitterServiceProvider"

And add your settings in the new file created in `config/twitter.php`.

### To search specific tweets

Example:

    use Twitter;

    $return = Twitter::tweetSearch()

        ->showMetrics()

        ->addFilterOnLocales(['fr', 'en'])

        ->addFilterOnKeywordOrPhrase(['avengers', 'assemble'], \Noweh\TwitterApi\Client::OPERATORS['AND'])

        ->showUserDetails()

        ->performRequest()

    ;

### To find Twitter Users

`findByIdOrUsername()` expects either an array, or a string.

You can specify the search mode as a second parameter (`\Noweh\TwitterApi\Client::MODES['USERNAME']` OR `\Noweh\TwitterApi\Client::MODES['ID']`)

Example:

    use Twitter;

    

    $return = Twitter::userSearch()

        ->findByIdOrUsername('twitterdev', \Noweh\TwitterApi\Client::MODES['USERNAME'])

        ->performRequest()

    ;

### To Post a new Tweet

Example:

    use Twitter;

    $return = Twitter::tweet()->performRequest('POST', ['text' => 'This is a test....']);

### To Retweet

Example:

    $return = Twitter::retweet()->performRequest('POST', ['tweet_id' => $tweet->id]);