README

Twitter API for Laravel 4/5 最初是从 thujohn/twitter 分支出来的

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

安装

将 rylxes/twitter 添加到 composer.json。

"rylxes/twitter-in-laravel": "~2.0"

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

或者运行

composer require rylxes/twitter-in-laravel

如果您正在安装 Laravel 5.4 或更低版本，您必须导入服务提供者

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

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

现在添加别名。

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

从 1.x.x 升级

该包现在需要 PHP >= 5.4.0

外观已更改 (Rylxes\Twitter\Facades\Twitter)

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

set_new_config() 已重命名为 reconfig()

配置

Laravel 4

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

/app/config/packages/rylxes/twitter/config.php

同时，请确保从配置文件中删除 env 并将其替换为您的信息。

Laravel 5

运行 php artisan vendor:publish --provider="Rylxes\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 为认证用户发送更新的设备。将设备参数发送为 none 将禁用短信更新。
postProfile() - 设置用户可以在其设置页面“账户”选项卡下设置的一些值。只有指定的参数将更新。
postBackground() - 更新认证用户的个人资料背景图片。此方法还可以用于启用或禁用个人资料背景图片。
postProfileImage() - 更新认证用户的个人资料图片。请注意，此方法期望接收原始的多部分数据，而不是图像的 URL。
destroyUserBanner() - 删除上传的个人资料横幅。在成功时返回 HTTP 200。
postUserBanner() - 代表认证用户上传个人资料横幅。为了获得最佳效果，请在上传个人资料对象的 profile_banner_url 节点中上传个人资料横幅 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。如果成功，则以请求的格式返回发送的消息。
getDmAll() - 返回过去30天内所有直接消息事件（已发送和接收）。按逆时间顺序排序。

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或屏幕名称列表，从列表中删除多个成员。认证用户必须拥有要从中删除成员的列表。注意，列表不能有超过500个成员，并且您一次最多可以删除100个成员。
getListOwnerships() - 返回指定Twitter用户拥有的列表。只有当认证用户也是列表的所有者时，才会显示私有列表。

媒体

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

搜索

getSearch() - 返回与指定查询匹配的相关推文集合。
getSearchByUser() - 返回与指定查询匹配的相关用户集合。
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属于已转推id参数指定的推文的用户。
getStatusesLookup() - 根据id参数中传递的逗号分隔的值，返回最多100条推文每请求的完全填充的推文对象。

趋势

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

用户

getUsersLookup() - 根据user_id和/或screen_name参数，返回每请求最多100个用户的完全填充的用户对象。
getUsers() - 返回由必需的user_id或screen_name参数指定的用户的各种信息。如果可能，将返回作者的最近推文。
getUsersSearch() - 提供了一个简单、基于相关性的搜索接口，用于搜索Twitter上的公共用户账户。可以尝试通过主题兴趣、全名、公司名称、位置或其他标准进行查询。不支持精确匹配搜索。
getUserBanner() - 返回指定用户个人资料横幅的可用尺寸变体映射。如果用户没有上传个人资料横幅，则将提供HTTP 404。此方法可以用在用户对象中返回的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/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);

rylxes / twitter-in-laravel

维护者

详细信息