README

Copper PDF 文書変換サーバーに接続するためのPHPドライバです。

API ドキュメント

オンライン: https://zamasoftnet.github.io/cti.php/

インストール

Composer（GitHub VCS / Packagist）

GitHub リポジトリから直接インストールする場合は、先に VCS リポジトリを登録してください。

composer config repositories.zamasoftnet-cti-php vcs https://github.com/zamasoftnet/cti.php
composer require zamasoft/cti-php

Packagist に登録済みの環境では、composer require zamasoft/cti-php だけでもインストールできます。

composer.json の repositories に直接追加する場合の例:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/zamasoftnet/cti.php"
    }
  ],
  "require": {
    "zamasoft/cti-php": "*"
  }
}

手動インストール

src/CTI/ ディレクトリをプロジェクトにコピーし、require_once で読み込んでください。

require_once 'path/to/CTI/DriverManager.php';

動作環境

PHP 5.6 以降

基本的な使い方

<?php
require_once 'vendor/autoload.php';

// セッションを取得
$session = cti_get_session('http://localhost:8099/');

// ソースを設定
$session->set_source_uri('http://example.com/document.html');

// 出力先を設定して変換
$session->start_main('./output.pdf');
?>

API概要

Session クラスの主要メソッド

メソッド	説明
`set_output_as_file($file)`	PDFをファイルに出力
`set_output_as_resource($fp)`	PDFをストリームリソースに出力
`set_output_as_variable(&$var)`	PDFを変数に出力
`set_output_as_directory($dir, $prefix, $suffix)`	PDFをディレクトリに連番で出力
`set_message_func($func)`	メッセージコールバックを設定
`set_progress_func($func)`	進捗コールバックを設定
`set_resolver_func($func)`	リソース解決コールバックを設定
`property($name, $value)`	プロパティを設定
`start_main($uri, $opts)`	メイン文書の送信を開始
`end_main()`	メイン文書の送信を完了
`start_resource($uri, $opts)`	リソースの送信を開始
`end_resource()`	リソースの送信を完了
`transcode($uri)`	サーバー側リソースを変換
`set_continuous($continuous)`	連続モードの設定
`join()`	結果の結合
`reset()`	セッションのリセット
`close()`	セッションのクローズ

テストの実行方法

テストにはCopper PDFサーバーへの接続が必要な統合テストと、接続不要なユーティリティ単体テストがあります。

test-config.json を作成:

{
  "host": "localhost",
  "port": 8099,
  "user": "user",
  "password": "kappa"
}

PHPUnit でテストを実行:

./vendor/bin/phpunit

サーバーが起動していない場合、統合テストは自動的にスキップされ、HelpersTest は単体で実行されます。

Ant から実行する場合:

ant test

ドキュメント

ドキュメント生成

phpDocumentorを使用してAPIドキュメントを生成できます:

./vendor/bin/phpdoc

または Ant を使用:

ant doc

Ant で配布アーカイブを作る場合:

ant dist

ライセンス

Apache License Version 2.0 に基づいてライセンスされます。

詳細は LICENSE ファイルを参照してください。

変更履歴

v2.2.0 (2025/12/30)

Composer対応

v2.1.4 (2021/11/15)

'Only variables should be passed by reference' 警告が出ないように対応

v2.1.3 (2014/08/11)

Session->start_main関数のデフォルトの引数を'.'に変更
画像を標準出力に出力時のヘッダ警告問題に対応

v2.1.2 (2013/04/24)

コールバック関数を参照渡しから値渡しに修正

v2.1.1 (2011/03/16)

PHP 5.1.6 以降に対応
Content-Length ヘッダの不具合を修正

v2.1.0 (2011/03/03)

複数文書から1つのPDFを生成する機能に対応
TLS通信に対応

v2.0.0 (2010/11/02)

最初のリリース

zamasoft / cti-php

Maintainers

Package info

Statistics

Security