Codebird-PHP 技术文档

1. 安装指南

环境要求

• PHP 7.1.0 或更高版本
• OpenSSL 扩展

安装方式

你可以通过 Composer 安装 Codebird-PHP：

composer require jublonet/codebird-php

安装完成后，在你的 PHP 项目中引入 Codebird：

require_once 'vendor/autoload.php';

2. 项目的使用说明

初始化 Codebird

首先，你需要初始化 Codebird 并设置你的 Twitter API 密钥：

require_once 'vendor/autoload.php';
\Codebird\Codebird::setConsumerKey('YOURKEY', 'YOURSECRET');

$cb = \Codebird\Codebird::getInstance();

认证流程

Codebird 支持 OAuth 1.0a 认证和应用级别的认证。

OAuth 1.0a 认证

以下是 OAuth 1.0a 认证的步骤：

session_start();

if (! isset($_SESSION['oauth_token'])) {
  // 获取请求令牌
  $reply = $cb->oauth_requestToken([
    'oauth_callback' => 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']
  ]);

  // 存储令牌
  $cb->setToken($reply->oauth_token, $reply->oauth_token_secret);
  $_SESSION['oauth_token'] = $reply->oauth_token;
  $_SESSION['oauth_token_secret'] = $reply->oauth_token_secret;
  $_SESSION['oauth_verify'] = true;

  // 重定向到认证页面
  $auth_url = $cb->oauth_authorize();
  header('Location: ' . $auth_url);
  die();

} elseif (isset($_GET['oauth_verifier']) && isset($_SESSION['oauth_verify'])) {
  // 验证令牌
  $cb->setToken($_SESSION['oauth_token'], $_SESSION['oauth_token_secret']);
  unset($_SESSION['oauth_verify']);

  // 获取访问令牌
  $reply = $cb->oauth_accessToken([
    'oauth_verifier' => $_GET['oauth_verifier']
  ]);

  // 存储访问令牌
  $_SESSION['oauth_token'] = $reply->oauth_token;
  $_SESSION['oauth_token_secret'] = $reply->oauth_token_secret;

  // 重定向到当前页面，不带 oauth GET 参数
  header('Location: ' . basename(__FILE__));
  die();
}

// 在每次页面加载时分配访问令牌
$cb->setToken($_SESSION['oauth_token'], $_SESSION['oauth_token_secret']);

应用级别认证

应用级别认证适用于不需要用户登录的 API 调用：

$reply = $cb->oauth2_token();
$bearer_token = $reply->access_token;

\Codebird\Codebird::setBearerToken('YOURBEARERTOKEN');

3. 项目API使用文档

API 方法映射

Codebird 将 Twitter API 方法映射到 PHP 函数调用。规则如下：

1. 每个斜杠 / 替换为下划线 _。
2. 每个下划线 _ 替换为驼峰命名法。
3. 每个参数模板替换为大写。

例如：

• statuses/update 映射到 Codebird::statuses_update()
• statuses/home_timeline 映射到 Codebird::statuses_homeTimeline()
• statuses/show/:id 映射到 Codebird::statuses_show_ID('id=12345')

使用示例

以下是一些常见的 API 调用示例：

获取主页时间线

$reply = (array) $cb->statuses_homeTimeline();
print_r($reply);

发布推文

$reply = $cb->statuses_update('status=Whohoo, I just Tweeted!');

搜索推文

$reply = $cb->search_tweets('q=Twitter', true);

4. 项目安装方式

通过 Composer 安装

composer require jublonet/codebird-php

手动安装

你可以从 GitHub 下载代码并手动引入：

require_once 'path/to/codebird.php';

5. 上传图片和视频

上传图片

$media_files = ['bird1.jpg', 'bird2.jpg', 'bird3.jpg'];
$media_ids = [];

foreach ($media_files as $file) {
  $reply = $cb->media_upload([
    'media' => $file
  ]);
  $media_ids[] = $reply->media_id_string;
}

$media_ids = implode(',', $media_ids);
$reply = $cb->statuses_update([
  'status' => 'These are some birds',
  'media_ids' => $media_ids
]);

上传视频

上传视频需要分块发送数据，具体方法请参考项目 Wiki。

---

通过以上文档，你应该能够顺利安装和使用 Codebird-PHP 来访问 Twitter API。如果有任何问题，请参考项目 Wiki 或联系支持团队。