nanosch/twitter

Laravel的Twitter API – fork自thujohn/twitter

维护者

详细信息

github.com/nanosch/twitter

源代码

安装次数: 4,677

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 290

2.2.7 2017-08-16 10:46 UTC

Requires

Requires (Dev)

MIT 474d0fbaf20c508f8b23481f121e736803b7da64

  • thujohn <jonathan.thuau.woop@gmail.com>

twitterlaravellaravel4laravel5

This package is auto-updated.

Last update: 2024-09-08 23:29:36 UTC

README

Laravel 4/5的Twitter API

您需要在应用管理中创建应用并创建访问令牌。

Build Status

安装

将thujohn/twitter添加到composer.json。

"thujohn/twitter": "~2.0"

运行composer update以拉取Twitter的最新版本。

或者运行

composer require thujohn/twitter

现在打开/config/app.php并将服务提供者添加到providers数组中。

'providers' => [
	Thujohn\Twitter\TwitterServiceProvider::class,
]

现在添加别名。

'aliases' => [
	'Twitter' => Thujohn\Twitter\Facades\Twitter::class,
]

从1.x.x升级

该包现在需要PHP >= 5.4.0

门面已更改（Thujohn\Twitter\Facades\Twitter）

配置文件已更新（debug、UPLOAD_URL、ACCESS_TOKEN_URL、REQUEST_TOKEN_URL）

set_new_config()已重命名为reconfig()

配置

Laravel 4

运行php artisan config:publish thujohn/twitter并使用您自己的信息修改配置文件。

/app/config/packages/thujohn/twitter/config.php

此外，请确保在配置文件中删除.env并替换为您的信息。

Laravel 5

运行php artisan vendor:publish --provider="Thujohn\Twitter\TwitterServiceProvider"并使用您自己的信息修改配置文件。

/config/ttwitter.php

在Laravel 5中，编辑config.php文件很简单——实际上您甚至不需要触摸它！只需将以下内容添加到您的.env文件中，然后您就可以开始了

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=

特殊参数

format : object|json|array (default:object)

函数

账户

  • getSettings() - 返回认证用户的设置（包括当前趋势、地理和睡眠时间信息）。
  • getCredentials()
  • postSettings() - 更新认证用户的设置。
  • postSettingsDevice() - 设置Twitter为认证用户发送更新的设备。将设备参数发送为空将禁用短信更新。
  • postProfile() - 设置用户可以在设置页面的“账户”选项卡下设置的某些值。只有指定的参数将被更新。
  • postBackground() - 更新认证用户的个人资料背景图片。此方法还可以用于启用或禁用个人资料背景图片。
  • postProfileImage() - 更新认证用户的个人资料图片。注意，此方法期望接收原始的多部分数据，而不是图片的URL。
  • destroyUserBanner() - 删除认证用户的上传个人资料横幅。成功时返回HTTP 200。
  • postUserBanner() - 代表认证用户上传个人资料横幅。为了获得最佳效果，请在上传个人资料横幅对象中上传一个profile_banner_url节点。

阻止

  • getBlocks() - 返回一个用户对象集合，该集合包含认证用户正在阻止的用户。
  • getBlocksIds() - 返回一个包含认证用户正在阻止的数字用户ID的数组。
  • postBlock() - 阻止指定的用户关注认证用户。除了被阻止的用户不会出现在认证用户的提及或时间轴上（除非被其他用户转发）之外，如果存在关注或朋友关系，则会将其销毁。
  • destroyBlock() - 为认证用户取消阻止在ID参数中指定的用户。成功时返回请求格式的取消阻止用户。如果在阻止之前存在关系，则不会恢复这些关系。

直接消息

  • getDmsOut() - 返回认证用户发送的最近的20条直接消息。包括发送者和接收者用户的详细信息。您可以请求每次调用最多200条直接消息，最多800条出站DM。
  • getDm() - 根据ID参数返回一个直接消息。类似于/1.1/direct_messages.format请求，此方法将包括发送者和接收者的用户对象。
  • getDmsIn() - 返回认证用户收到的最近的20条直接消息。包括发送者和接收者用户的详细信息。每次调用可以请求最多200条直接消息，并且只能使用此端点获取最近的200条DM。
  • destroyDm() - 销毁在所需ID参数中指定的直接消息。认证用户必须是该直接消息的接收者。
  • postDm() - 从认证用户向指定用户发送新的直接消息。需要用户和文本参数，并且必须是POST请求。如果成功，则返回请求格式的已发送消息。

收藏

  • getFavorites() - 返回认证用户或指定用户最近20条收藏的推文。
  • destroyFavorite() - 作为认证用户取消收藏ID参数中指定的状态。如果成功，则返回请求格式的取消收藏状态。
  • postFavorite() - 作为认证用户收藏ID参数中指定的状态。如果成功，则返回收藏状态。

好友关系

  • getNoRters() - 返回当前认证用户不想接收转发的用户ID集合。
  • getFriendsIds() - 返回每名关注指定用户的用户的用户ID集合。
  • getFollowersIds() - 返回关注指定用户的每名用户的用户ID集合。
  • getFriendshipsIn() - 返回每名对认证用户有待处理关注请求的用户的数字ID集合。
  • getFriendshipsOut() - 返回认证用户对有待处理关注请求的每名受保护用户的数字ID集合。
  • postFollow() - 允许认证用户关注ID参数中指定的用户。
  • postUnfollow() - 允许认证用户取消关注ID参数中指定的用户。
  • postFollowUpdate() - 允许启用或禁用来自指定用户的转发和设备通知。
  • getFriendships() - 返回任意两个用户之间关系的详细信息。
  • getFriends() - 返回指定用户关注的每名用户（也称为他们的“朋友”）的用户对象集合。
  • getFollowers() - 返回关注指定用户的用户对象集合。
  • getFriendshipsLookup() - 返回认证用户与其提供的逗号分隔的最多100个screen_names或user_ids之间的关系。连接值可以是：following、following_requested、followed_by、none、blocking、muting。

地理信息

  • getGeo() - 返回已知地点的所有信息。
  • getGeoReverse() - 给定纬度和经度，搜索最多20个可以作为更新状态时place_id使用的地点。
  • getGeoSearch() - 搜索可以附加到statuses/update的地点。给定纬度和经度对、IP地址或名称，此请求将返回所有有效的地点列表，这些地点可以用作更新状态时的place_id。
  • getGeoSimilar() - 定位给定坐标附近名称相似的地点。概念上，您将使用此方法首先获取一个已知地点列表进行选择。然后，如果所需的地点不存在，请发送POST geo/place请求创建一个新地点。响应中包含的令牌是创建新地点所需的令牌。

帮助

  • postSpam() - 将指定的用户报告为Twitter的垃圾邮件账户。此外，代表认证用户执行POST blocks / create。
  • getHelpConfiguration() - 返回Twitter当前使用的配置，包括不是用户名的twitter.com别名、最大照片分辨率和t.co URL长度。
  • getHelpLanguages() - 返回Twitter支持的语言列表以及Twitter支持的语言代码。
  • getHelpPrivacy() - 返回Twitter的隐私政策。
  • getHelpTos() - 返回Twitter的服务条款。注意：这些条款与开发者政策不同。
  • getAppRateLimit() - 返回指定资源家族中方法的当前速率限制。

列表

  • getLists() - 返回认证用户或指定用户订阅的所有列表，包括他们的自己的列表。用户通过user_id或screen_name参数指定。如果没有提供用户，则使用认证用户。
  • getListStatuses() - 返回指定列表成员创作的推文的时间线。默认包含转发。使用include_rts=false参数省略转发。
  • destroyListMember() - 从列表中删除指定的成员。认证用户必须是列表的所有者才能从列表中删除成员。
  • getListsMemberships() - 返回指定的用户被添加到的列表。如果没有提供user_id或screen_name，则返回认证用户的成员资格。
  • getListsSubscribers() - 返回指定列表的订阅者。如果认证用户拥有指定的列表，则仅显示私有列表的订阅者。
  • postListSubscriber() - 将认证用户订阅到指定的列表。
  • getListSubscriber() - 返回指定列表的订阅者。如果认证用户拥有指定的列表，则仅显示私有列表的订阅者。
  • destroyListSubscriber() - 将认证用户从指定的列表中取消订阅。
  • postListCreateAll() - 通过指定逗号分隔的成员id或screen_name列表，将多个成员添加到列表中。认证用户必须是列表的所有者才能将成员添加到列表中。注意，列表不能有超过5,000个成员，并且使用此方法一次最多只能添加100个成员到列表中。
  • getListMember() - 检查指定的用户是否是指定列表的成员。
  • getListMembers() - 返回指定列表的成员。如果认证用户拥有指定的列表，则仅显示私有列表的成员。
  • postListMember() - 将成员添加到列表中。认证用户必须是列表的所有者才能将成员添加到列表中。注意，列表不能有超过5,000个成员。
  • destroyList() - 删除指定的列表。认证用户必须是列表的所有者才能删除它。
  • postListUpdate() - 更新指定的列表。认证用户必须是列表的所有者才能更新它。
  • postList() - 为认证用户创建一个新的列表。注意，每个账户最多可以创建20个列表。
  • getList() - 返回指定的列表。如果认证用户拥有指定的列表，则仅显示私有列表。
  • getListSubscriptions() - 获取指定用户订阅的列表集合，默认每页20个列表。不包括用户的自己的列表。
  • destroyListMembers() - 通过指定逗号分隔的成员id或screen_name列表，从列表中删除多个成员。认证用户必须是列表的所有者才能从列表中删除成员。注意，列表不能有超过500个成员，并且使用此方法一次最多只能删除100个成员到列表中。
  • getListOwnerships() - 返回指定Twitter用户的列表。如果认证用户也是列表的所有者，则将仅显示私有列表。

媒体

  • uploadMedia() - 将媒体（图片）上传到Twitter，用于推文或Twitter托管卡片。

搜索

  • getSearch() - 返回与指定查询匹配的相关推文集合。
  • getSavedSearches() - 返回认证用户的已保存搜索查询。
  • getSavedSearch() - 获取由给定id表示的已保存搜索的信息。请求已保存搜索ID的认证用户必须是所有者。
  • postSavedSearch() - 为认证用户创建一个新的已保存搜索。用户最多只能有25个已保存搜索。
  • destroySavedSearch() - 销毁认证用户的已保存搜索。请求销毁的已保存搜索ID的认证用户必须是所有者。

状态

  • getMentionsTimeline() - 返回认证用户最近的20条提及（包含用户的 @screen_name 的推文）。
  • getUserTimeline() - 返回由 screen_name 或 user_id 参数指定的用户发布的最近推文的集合。
  • getHomeTimeline() - 返回认证用户及其所关注的用户最近发布的推文和转推文的集合。主页是大多数用户与Twitter服务互动的核心。
  • getRtsTimeline() - 返回认证用户创作的最近推文，这些推文已被其他人转推。
  • getRts() - 返回由 id 参数指定的推文最近100条转推的集合。
  • getTweet() - 返回由 id 参数指定的单个推文。推文的作者也将嵌入到推文中。
  • destroyTweet() - 销毁由必需的 ID 参数指定的状态。认证用户必须是所指定状态的作者。如果成功，则返回销毁的状态。
  • postTweet() - 更新认证用户的当前状态，也称为推文。
  • postRt() - 转推一条推文。返回带有转推详情的原始推文。
  • getOembed() - 以oEmbed兼容的格式返回由推文web URL或推文ID指定的单个推文。当页面上包含Twitter的widget JavaScript时，返回的HTML片段将自动识别为嵌入的推文。
  • getRters() - 返回最多100个属于转推id参数指定的推文的推文的用户ID的集合。
  • getStatusesLookup() - 根据逗号分隔的值通过id参数传递，返回每个请求最多100个推文的完整 hydrated 推文对象。

趋势

  • getTrendsPlace() - 如果有趋势信息可用，则返回特定WOEID的前10个趋势主题。
  • getTrendsAvailable() - 返回Twitter有趋势主题信息的地点。
  • getTrendsClosest() - 返回Twitter有趋势主题信息的，最接近指定地点的地点。

用户

  • getUsersLookup() - 根据用户_id 和/或 screen_name 参数传递的逗号分隔值，返回每个请求最多100个用户的完整 hydrated 用户对象。
  • getUsers() - 返回由必需的 user_id 或 screen_name 参数指定的用户的各种信息。如果可能，将返回作者的最近推文。
  • getUsersSearch() - 提供一个简单的基于相关性的搜索界面，用于Twitter上的公共用户帐户。尝试按主题兴趣、全名、公司名称、位置或其他标准进行查询。不支持精确匹配搜索。
  • getUserBanner() - 返回指定用户个人资料横幅的可用尺寸变体映射。如果用户未上传个人资料横幅，将返回 HTTP 404。此方法可以替代在《个人资料图片和横幅》中描述的 user 对象返回的 profile_banner_url 上的字符串操作。
  • muteUser() - 将 ID 参数中指定的用户对认证用户静音。
  • unmuteUser() - 对 ID 参数中指定的用户解除静音，使其对认证用户不再静音。
  • mutedUserIds() - 返回认证用户已静音的数值用户 ID 数组。
  • mutedUsers() - 返回认证用户已静音的用户对象数组。
  • getSuggesteds() - 访问 Twitter 建议用户列表中给定类别的用户。
  • getSuggestions() - 访问 Twitter 的建议用户列表。此方法返回建议用户类别列表。可以使用此类别在 GET users / suggestions / :slug 中获取该类别的用户。
  • getSuggestedsMembers() - 访问 Twitter 建议用户列表中给定类别的用户，如果他们不是受保护用户，则返回其最新状态。

辅助函数

Linkify : 将 URL、@用户名、标签转换为链接。$tweet 的类型可以是对象、数组或文本。通过发送对象或数组，方法将展开链接（t.co）。

Twitter::linkify($tweet);

Ago : 将日期转换为差异（2小时前）

Twitter::ago($timestamp);

LinkUser : 通过用户对象（例如 $tweet->user）或 ID/字符串生成特定用户的链接。

Twitter::linkUser($user);

LinkTweet : 生成特定推文的链接。

Twitter::linkTweet($tweet);

示例

返回根据 screen_name 或 user_id 参数指示的用户发布的最新推文的集合。

Route::get('/userTimeline', function()
{
	return Twitter::getUserTimeline(['screen_name' => 'thujohn', 'count' => 20, 'format' => 'json']);
});

返回认证用户及其所关注的用户发布的最新推文和转推文的集合。

Route::get('/homeTimeline', function()
{
	return Twitter::getHomeTimeline(['count' => 20, 'format' => 'json']);
});

返回认证用户的 X 个最新提及（包含用户的 @screen_name 的推文）。

Route::get('/mentionsTimeline', function()
{
	return Twitter::getMentionsTimeline(['count' => 20, 'format' => 'json']);
});

更新认证用户的当前状态，也称为发推。

Route::get('/tweet', function()
{
	return Twitter::postTweet(['status' => 'Laravel is beautiful', 'format' => 'json']);
});

使用媒体更新认证用户的当前状态。

Route::get('/tweetMedia', function()
{
	$uploaded_media = Twitter::uploadMedia(['media' => File::get(public_path('filename.jpg'))]);
	return Twitter::postTweet(['status' => 'Laravel is beautiful', 'media_ids' => $uploaded_media->media_id_string]);
});

使用电子邮件获取用户凭证。

$credentials = Twitter::getCredentials([
    'include_email' => 'true',
]);

在上文中，您需要将 true 作为字符串传递，而不是作为布尔值。布尔值将被转换为 1，Twitter 会忽略。

这也假设您已正确设置与 Twitter 的权限。您必须在设置 Twitter 应用时选择 '获取用户电子邮件'。仅传递值是不够的。

通过 Twitter 登录

Route::get('twitter/login', ['as' => 'twitter.login', function(){
	// your SIGN IN WITH TWITTER  button should point to this route
	$sign_in_twitter = true;
	$force_login = false;

	// Make sure we make this request w/o tokens, overwrite the default values in case of login.
	Twitter::reconfig(['token' => '', 'secret' => '']);
	$token = Twitter::getRequestToken(route('twitter.callback'));

	if (isset($token['oauth_token_secret']))
	{
		$url = Twitter::getAuthorizeURL($token, $sign_in_twitter, $force_login);

		Session::put('oauth_state', 'start');
		Session::put('oauth_request_token', $token['oauth_token']);
		Session::put('oauth_request_token_secret', $token['oauth_token_secret']);

		return Redirect::to($url);
	}

	return Redirect::route('twitter.error');
}]);

Route::get('twitter/callback', ['as' => 'twitter.callback', function() {
	// You should set this route on your Twitter Application settings as the callback
	// https://apps.twitter.com/app/YOUR-APP-ID/settings
	if (Session::has('oauth_request_token'))
	{
		$request_token = [
			'token'  => Session::get('oauth_request_token'),
			'secret' => Session::get('oauth_request_token_secret'),
		];

		Twitter::reconfig($request_token);

		$oauth_verifier = false;

		if (Input::has('oauth_verifier'))
		{
			$oauth_verifier = Input::get('oauth_verifier');
			// getAccessToken() will reset the token for you
			$token = Twitter::getAccessToken($oauth_verifier);
		}

		if (!isset($token['oauth_token_secret']))
		{
			return Redirect::route('twitter.error')->with('flash_error', 'We could not log you in on Twitter.');
		}

		$credentials = Twitter::getCredentials();

		if (is_object($credentials) && !isset($credentials->error))
		{
			// $credentials contains the Twitter user object with all the info about the user.
			// Add here your own user logic, store profiles, create new users on your tables...you name it!
			// Typically you'll want to store at least, user id, name and access tokens
			// if you want to be able to call the API on behalf of your users.

			// This is also the moment to log in your users if you're using Laravel's Auth class
			// Auth::login($user) should do the trick.

			Session::put('access_token', $token);

			return Redirect::to('/')->with('flash_notice', 'Congrats! You\'ve successfully signed in!');
		}

		return Redirect::route('twitter.error')->with('flash_error', 'Crab! Something went wrong while signing you up!');
	}
}]);

Route::get('twitter/error', ['as' => 'twitter.error', function(){
	// Something went wrong, add your own error handling here
}]);

Route::get('twitter/logout', ['as' => 'twitter.logout', function(){
	Session::forget('access_token');
	return Redirect::to('/')->with('flash_notice', 'You\'ve successfully logged out!');
}]);

调试

首先在配置文件中激活调试。

然后您可以访问 logs() 方法。

try
{
	$response = Twitter::getUserTimeline(['count' => 20, 'format' => 'array']);
}
catch (Exception $e)
{
	// dd(Twitter::error());
	dd(Twitter::logs());
}

dd($response);