CTI Driver for PHP

Session
in package

文書変換を実行するためのセッションです。

Table of Contents

Properties

$builder  : mixed
$encoding  : mixed
$err  : mixed
$fp  : mixed
$mainLength  : mixed
$mainRead  : mixed
$messageFunc  : mixed
$progressFunc  : mixed
$resolverFunc  : mixed
$results  : mixed
$state  : mixed

Methods

__construct()  : mixed
セッションのコンストラクタです。 セッションの作成は通常DriverManager.phpのcti_get_sessionで行うため、 ユーザーがコンストラクタを直接呼び出す必要はありません。
_main_handler()  : string
本体の変換のためのコールバック関数です。
_resource_handler()  : string
リソースの送信のためのコールバック関数です。
abort()  : mixed
変換処理の中断を要求します。
close()  : mixed
セッションを閉じます。
end_main()  : mixed
変換結果を送信し、本体の変換のためのバッファリングを終了します。
end_resource()  : mixed
バッファの内容を送信し、リソース送信のためのバッファリングを終了します。
get_server_info()  : string
サーバー情報を返します。 詳細は<a href="http://sourceforge.jp/projects/copper/wiki/CTIP2.0%E3%81%AE%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC%E6%83%85%E5%A0%B1"> オンラインのドキュメント</a>をご覧下さい。
join()  : mixed
結果を結合します。
property()  : mixed
プロパティを設定します。
reset()  : mixed
全ての状態をリセットします。
set_continuous()  : mixed
複数の結果を結合するモードを切り替えます。 モードが有効な場合、join()の呼び出しで複数の結果を結合して返します。
set_message_func()  : mixed
エラーメッセージ受信のためのコールバック関数を設定します。
set_output_as_directory()  : mixed
変換結果の出力先ディレクトリ名を指定します。
set_output_as_file()  : mixed
変換結果の出力先ファイル名を指定します。
set_output_as_resource()  : mixed
変換結果の出力先リソースを指定します。
set_output_as_variable()  : mixed
変換結果の出力先文字列変数を指定します。
set_progress_func()  : mixed
進行状況受信のためのコールバック関数を設定します。
set_resolver_func()  : mixed
リソース解決のためのコールバック関数を設定します。
set_results()  : mixed
変換結果の出力先を指定します。
start_main()  : mixed
本体の変換のための出力のバッファリングを有効にします。
start_resource()  : mixed
リソース送信のための出力のバッファリングを有効にします。
transcode()  : mixed
サーバー側リソースを変換します。
_build_next()  : mixed
次のビルドタスクを実行します。

Properties

$builder

private mixed $builder = null

$encoding

private mixed $encoding = 'UTF-8'

$mainLength

private mixed $mainLength = null

$mainRead

private mixed $mainRead = null

$messageFunc

private mixed $messageFunc = null

$progressFunc

private mixed $progressFunc = null

$resolverFunc

private mixed $resolverFunc = null

Methods

__construct()

セッションのコンストラクタです。 セッションの作成は通常DriverManager.phpのcti_get_sessionで行うため、 ユーザーがコンストラクタを直接呼び出す必要はありません。

public __construct(resource $fp[, array<string|int, mixed>|null $options = null ]) : mixed
Parameters
$fp : resource

入出力ストリーム(通常はソケット)

$options : array<string|int, mixed>|null = null

接続オプション

_main_handler()

本体の変換のためのコールバック関数です。

public _main_handler(string $buffer) : string
Parameters
$buffer : string
Return values
string

_resource_handler()

リソースの送信のためのコールバック関数です。

public _resource_handler(string $buffer) : string
Parameters
$buffer : string
Return values
string

abort()

変換処理の中断を要求します。

public abort(int $mode) : mixed
Parameters
$mode : int

中断モード 0=生成済みのデータを出力して中断, 1=即時中断

close()

セッションを閉じます。

public close() : mixed

この関数の呼出し後、対象となったセッションに対するいかなる操作もできません。

end_main()

変換結果を送信し、本体の変換のためのバッファリングを終了します。

public end_main() : mixed

start_main,end_mainは対となります。

end_resource()

バッファの内容を送信し、リソース送信のためのバッファリングを終了します。

public end_resource() : mixed

start_resource,end_resourceは対となります。 これらの関数はtranscodeおよびstart_mainの前に呼び出してください。

get_server_info()

サーバー情報を返します。 詳細は<a href="http://sourceforge.jp/projects/copper/wiki/CTIP2.0%E3%81%AE%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC%E6%83%85%E5%A0%B1"> オンラインのドキュメント</a>をご覧下さい。

public get_server_info(string $uri) : string
Parameters
$uri : string

サーバー情報のURI

Return values
string —

サーバー情報のデータ

join()

結果を結合します。

public join() : mixed

property()

プロパティを設定します。

public property(string $name, string $value) : mixed

セッションを作成した直後に呼び出してください。 利用可能なプロパティの一覧は「開発者ガイド」を参照してください。

Parameters
$name : string

名前

$value : string

値

reset()

全ての状態をリセットします。

public reset() : mixed

set_continuous()

複数の結果を結合するモードを切り替えます。 モードが有効な場合、join()の呼び出しで複数の結果を結合して返します。

public set_continuous(bool $continuous) : mixed

transcodeおよびstart_mainの前に呼び出してください。

Parameters
$continuous : bool

有効にするにはTRUE

set_message_func()

エラーメッセージ受信のためのコールバック関数を設定します。

public set_message_func(callable $messageFunc) : mixed

transcodeおよびstart_mainの前に呼び出してください。 コールバック関数の引数は、エラーコード(int)、メッセージ(string)、付属データ(array)です。

Parameters
$messageFunc : callable

コールバック関数

set_output_as_directory()

変換結果の出力先ディレクトリ名を指定します。

public set_output_as_directory(string $dir[, string $prefix = '' ][, string $suffix = '' ]) : mixed

set_resultsの簡易版です。 こちらは、複数の結果をファイルとして出力するディレクトリ名を直接設定出来ます。 ファイル名は prefix ページ番号 suffix をつなげたものです。

Parameters
$dir : string

出力先ディレクトリ名。

$prefix : string = ''

出力するファイルの名前の前に付ける文字列。

$suffix : string = ''

出力するファイルの名前の後に付ける文字列。

set_output_as_file()

変換結果の出力先ファイル名を指定します。

public set_output_as_file(string $file) : mixed

set_resultsの簡易版です。 こちらは、１つだけ結果を出力するファイル名を直接設定出来ます。

Parameters
$file : string

出力先ファイル名。

set_output_as_resource()

変換結果の出力先リソースを指定します。

public set_output_as_resource(resource $fp) : mixed

set_resultsの簡易版です。 こちらは、１つだけ結果を出力先リソースを直接設定出来ます。

Parameters
$fp : resource

出力先リソース。

set_output_as_variable()

変換結果の出力先文字列変数を指定します。

public set_output_as_variable(string &$var) : mixed

set_resultsの簡易版です。 こちらは、１つだけ結果を出力先文字列変数を直接設定出来ます。

Parameters
$var : string

出力先文字列変数。

set_progress_func()

進行状況受信のためのコールバック関数を設定します。

public set_progress_func(callable $progressFunc) : mixed

transcodeおよびstart_mainの前に呼び出してください。 コールバック関数の引数は、全体のバイト数(int)、読み込み済みバイト数(int)です。

Parameters
$progressFunc : callable

コールバック関数

set_resolver_func()

リソース解決のためのコールバック関数を設定します。

public set_resolver_func(callable $resolverFunc) : mixed

transcodeおよびstart_mainの前に呼び出してください。 コールバック関数の引数は、全体のバイト数(string)、リソース出力クラス(ResourceOutput)です。

Parameters
$resolverFunc : callable

コールバック関数

set_results()

変換結果の出力先を指定します。

public set_results(Results $results) : mixed

transcodeおよびstart_mainの前に呼び出してください。 この関数を呼び出さない場合、出力先は標準出力になります。 出力先が標準出力の場合、自動的にContent-Lengthヘッダが送出されます。

Parameters
$results : Results

出力先

start_main()

本体の変換のための出力のバッファリングを有効にします。

public start_main([string $uri = '.' ][, array<string|int, mixed> $opts = array() ]) : mixed

start_main,end_mainは対となります。

Parameters
$uri : string = '.'

仮想URI

$opts : array<string|int, mixed> = array()

リソースオプション('mimeType', 'encoding', 'length'というキーでデータ型、文字コード、長さを設定することができます。)

start_resource()

リソース送信のための出力のバッファリングを有効にします。

public start_resource(string $uri[, array<string|int, mixed> $opts = array() ]) : mixed

start_resource,end_resourceは対となります。 これらの関数はtranscodeおよびstart_mainの前に呼び出してください。

Parameters
$uri : string

仮想URI

$opts : array<string|int, mixed> = array()

リソースオプション('mimeType', 'encoding', 'length'というキーでデータ型、文字コード、長さを設定することができます。)

transcode()

サーバー側リソースを変換します。

public transcode(string $uri) : mixed
Parameters
$uri : string

URI

_build_next()

次のビルドタスクを実行します。

private _build_next() : mixed
Return values
mixed —

次がある場合はtrue,終わった場合はnull,エラーの場合はfalse


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results