webiny/twitter-oauth

Webiny Twitter OAuth 组件

v1.6.1 2017-09-29 08:13 UTC

README

本组件提供的是一个 Twitter OAuth 服务器的包装器。

安装组件

安装组件的最佳方式是使用 Composer。

composer require webiny/twitter-oauth

要查看该软件包的附加版本,请访问 Packagist 页面

配置组件

要使用该组件,您首先需要对其进行配置。配置是通过定义以下参数来完成的

  • ClientId - Twitter 客户端 ID
  • ClientSecret - Twitter 客户端密钥
  • RedirectUri - 用户授权后 OAuth 服务器将重定向到的位置

示例配置

    TwitterOAuth:
        MyTwitterApp:
            ClientOd: AJmIXgXfaasdasaULBmnygIiGA
            ClientSecret: JE5dpb0a891ciisasdMOu7ELF9SI0TazR3hDAirft0Y
            RedirectUri: /security/login-tw/
        Bridge: \Webiny\Component\TwitterOAuth\Bridge\TwitterOAuth\TwitterOAuth

依赖

该库需要 abraham/twitteroauth TwitterOAuth 组件。如果您使用 Composer 安装了 TwitterOAuth Webiny 组件,它将被自动安装,但是,在使用组件之前,您需要将此文件包含在您的应用程序中的某个位置 /path/to/abraham/twitteroauth/twitteroauth.php

使用方法

一旦您已配置组件,如果您有访问令牌,其使用方法相当简单。如果您没有访问令牌,获取令牌的最佳方式是使用带有 TwitterOAuth 作为身份验证提供者的 Security 组件来验证用户。

$tw = TwitterOAuthLoader::getInstance('MyTwitterApp');

$tw->setAccessToken(...);

// get user details for current access token
$user = $tw->getUserDetails(); // returns TwitterOAuthUser object

// perform any other API operation
$tw->get($url, $params);
$tw->post($url, $params);
$tw->delete($url, $params);

资源

要运行单元测试,您需要使用以下命令

$ cd path/to/Webiny/Component/TwitterOAuth/
$ composer.phar install
$ phpunit