README

Laravel 5和Lumen的Twitter API

您需要在应用管理中创建一个应用程序并创建您的访问令牌。

安装

将sofwar/twitter添加到composer.json。

"sofwar/twitter": "~1.0"

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

或者运行

composer require sofwar/twitter

配置

Laravel 5

运行php artisan vendor:publish --provider="SofWar\Twitter\TwitterServiceProvider"并修改配置文件以添加您的信息。

/config/ttwitter.php

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

TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=

Lumen

将以下片段添加到 providers 部分的 bootstrap/app.php 文件中，如下所示

$app->register(SofWar\Twitter\TwitterServiceProvider::class);

特殊参数

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

函数

账户

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

阻止

getBlocks() - 返回认证用户正在阻止的用户对象集合。
getBlocksIds() - 返回认证用户正在阻止的数字用户ID数组。
postBlock() - 阻止指定的用户关注认证用户。此外，被阻止的用户将不会在认证用户的提及或时间线中显示（除非被其他用户转发）。如果存在关注或朋友关系，则将其销毁。
destroyBlock() - 为认证用户取消阻止在ID参数中指定的用户。成功时返回请求格式的取消阻止用户。如果阻止实施之前存在关系，则不会恢复。

直接消息

getDmsOut() - 返回认证用户发送的最近的20条直接消息。包括发送者和接收者用户的详细信息。您可以在每次调用中请求最多200条直接消息，最多800条出站消息。
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的slug不是用户名、最大照片分辨率和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() - 返回每条请求最多100条推文的完整推文对象，如通过id参数传递的逗号分隔值指定。

趋势

getTrendsPlace() - 如果有趋势信息，则返回特定WOEID的前10个热门话题。
getTrendsAvailable() - 返回Twitter有趋势话题信息的地点。
getTrendsClosest() - 返回Twitter有趋势话题信息的、最接近指定位置的地点。

用户

getUsersLookup() - 返回每条请求最多100个用户的完整用户对象，如通过user_id和/或screen_name参数传递的逗号分隔值指定。
getUsers() - 返回由必需的user_id或screen_name参数指定的用户的各种信息。如果可能，将返回作者的最新推文。
getUsersSearch() - 提供一个基于相关性的简单搜索界面，用于Twitter上的公共用户账户。尝试通过主题兴趣、全名、公司名称、位置或其他标准进行查询。不支持精确匹配搜索。
getUserBanner() - 返回指定用户个人资料横幅的可用尺寸变体映射。如果用户未上传个人资料横幅，将提供HTTP 404。此方法可以替代在用户对象中返回的profile_banner_url上的字符串操作，如Profile Images and Banners中所述。
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/string生成指向特定用户的链接。

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);

sofwar / twitter

维护者

详细信息