README

注意： 已不再支持。请查看官方 Box View PHP SDK。

由 Daniel Pepin 创建，@ CommonPlaces, Inc
由 LawJacked 赞助

文档

有关通用 API 文档，请参阅 Box View API 文档。

要开始使用，请包含所需的类

require 'lib/box-view-api.php';
require 'lib/box-view-document.php';

初始化 API 类

$api_key = 'YOUR_API_KEY';
$box = new Box_View_API($api_key);

创建要上传的文档

$doc = new Box_View_Document();
$doc->name = 'My Awesome Document';
$doc->file_url = 'http://my-public-url';
$doc->thumbnails = '128×128,256×256'; // Comma-separated list of thumbnail dimensions of the format {width}x{height} e.g. 128×128,256×256
$doc->non_svg = false; // boolean (default=false)

将文档上传到 API

$box->upload($doc);

您也可以通过 API 上传本地文件

$doc = new Box_View_Document(array(
  'name' => 'My Local File',
  'file_path' => '/path/to/file/CV_Template1.doc',
));
$box->upload($doc);

将文档数组上传到 API

// Create array of Box_View_Document objects.
$docs[] = new Box_View_Document(array('file_url' => 'http://foo.bar/why-cats-purrrr.pdf'));
$docs[] = new Box_View_Document(array('file_url' => 'http://foo.bar/10-ways-to-love-your-cat.docx'));
$docs[] = new Box_View_Document(array('file_url' => 'http://foo.bar/funny-cat-links.xlsx'));

// Wrap API calls in try/catch.
try
{
  $box->uploadMultiple($docs);
}
catch(Exception $e)
{
  log('error', $e->getMessage());
}

经过一段时间，文档将被处理并可查看

$box->view($doc);
echo $doc->session->url; // Links to the HTML5 document.

在 iframe 中嵌入文档。

<iframe src="<?= $doc->session->url ?>"></iframe>

检索文档第一页的缩略图。缩略图的宽度在 16 到 1024 像素之间，高度在 16 到 768 像素之间。

$img = $box->getThumbnail($doc, $width, $height);
<img src="data:image/png;base64,<?= base64_encode($img) ?>"/>

显示文件的 PDF 版本。

$box->getPDF($doc);
header('Content-Type: application/pdf');
print $doc->content->pdf;

获取包含文档 HTML5 文件的 Zip 文件夹

$box->getZip($doc);
file_put_contents($doc->name . '.zip', $doc->content->zip);
// Unzip the file.

删除文档

$box->delete($doc);

####异常处理 当 API 调用遇到错误时，将抛出 Box_View_Exception 实例。
您应该用 try/catch 包裹您的 API 调用。

try
{
  $box->upload($doc);
}
catch(Exception $e)
{
  log('error', $e->getMessage(), $http_code = $e->getCode());
}