Class Session

Description

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

Located in /Session.class.php (line 13)


	
			
Method Summary
Session __construct ($fp &$fp, [$options $options = null])
void abort ($mode $mode)
void close ()
void end_main ()
void end_resource ()
サーバー情報のデータ get_server_info ($uri $uri)
void join ()
void property ($name $name, $value $value)
void reset ()
void set_continuous ($continuous $continuous)
void set_message_func ($messageFunc $messageFunc)
void set_output_as_directory ($dir $dir, [$prefix $prefix = ''], [$suffix $suffix = ''])
void set_output_as_file ($file $file)
void set_output_as_resource ($fp &$fp)
void set_output_as_variable ($fp &$var)
void set_progress_func ($progressFunc $progressFunc)
void set_resolver_func ($resolverFunc $resolverFunc)
void set_results ($results &$results)
void start_main ($uri $uri, [$opts $opts = array()])
void start_resource ($uri $uri, [$opts $opts = array()])
void transcode ($uri $uri)
string _main_handler ($buffer $buffer)
string _resource_handler ($buffer $buffer)
Methods
Constructor __construct (line 35)

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

  • access: public
Session __construct ($fp &$fp, [$options $options = null])
  • $fp &$fp: 入出力ストリーム(通常はソケット)
  • $options $options: 接続オプション
abort (line 381)

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

  • access: public
void abort ($mode $mode)
  • $mode $mode: 中断モード 0=生成済みのデータを出力して中断, 1=即時中断
close (line 421)

セッションを閉じます。

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

  • access: public
void close ()
end_main (line 321)

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

start_main,end_mainは対となります。

  • access: public
void end_main ()
end_resource (line 266)

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

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

  • access: public
void end_resource ()
get_server_info (line 65)

サーバー情報を返します。 詳細は<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>をご覧下さい。

  • access: public
サーバー情報のデータ get_server_info ($uri $uri)
  • $uri $uri: サーバー情報のURI
join (line 406)

結果を結合します。

  • access: public
void join ()
property (line 216)

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

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

  • access: public
void property ($name $name, $value $value)
  • $name $name: string 名前
  • $value $value: string 値
reset (line 391)

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

  • access: public
void reset ()
set_continuous (line 200)

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

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

void set_continuous ($continuous $continuous)
  • $continuous $continuous: function 有効にするにはTRUE
set_message_func (line 154)

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

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

  • access: public
void set_message_func ($messageFunc $messageFunc)
  • $messageFunc $messageFunc: function コールバック関数
set_output_as_directory (line 115)

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

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

  • access: public
void set_output_as_directory ($dir $dir, [$prefix $prefix = ''], [$suffix $suffix = ''])
  • $dir $dir: 出力先ディレクトリ名。
  • $prefix $prefix: 出力するファイルの名前の前に付ける文字列。
  • $suffix $suffix: 出力するファイルの名前の後に付ける文字列。
set_output_as_file (line 100)

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

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

  • access: public
void set_output_as_file ($file $file)
  • $file $file: 出力先ファイル名。
set_output_as_resource (line 127)

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

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

  • access: public
void set_output_as_resource ($fp &$fp)
  • $fp &$fp: 出力先リソース。
set_output_as_variable (line 139)

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

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

  • access: public
void set_output_as_variable ($fp &$var)
  • $fp &$var: 出力先文字列変数。
set_progress_func (line 169)

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

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

void set_progress_func ($progressFunc $progressFunc)
  • $progressFunc $progressFunc: function コールバック関数
set_resolver_func (line 184)

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

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

void set_resolver_func ($resolverFunc $resolverFunc)
  • $resolverFunc $resolverFunc: function コールバック関数
set_results (line 85)

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

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

  • access: public
void set_results ($results &$results)
  • $results &$results: 出力先
start_main (line 302)

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

start_main,end_mainは対となります。

  • access: public
void start_main ($uri $uri, [$opts $opts = array()])
  • $uri $uri: string 仮想URI
  • $opts $opts: array リソースオプション('mimeType', 'encoding', 'length'というキーでデータ型、文字コード、長さを設定することができます。)
start_resource (line 247)

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

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

  • access: public
void start_resource ($uri $uri, [$opts $opts = array()])
  • $uri $uri: string 仮想URI
  • $opts $opts: array リソースオプション('mimeType', 'encoding', 'length'というキーでデータ型、文字コード、長さを設定することができます。)
transcode (line 228)

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

  • access: public
void transcode ($uri $uri)
  • $uri $uri: string URI
_main_handler (line 338)

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

  • access: public
string _main_handler ($buffer $buffer)
  • $buffer $buffer
_resource_handler (line 281)

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

  • access: public
string _resource_handler ($buffer $buffer)
  • $buffer $buffer

Documentation generated on Wed, 24 Apr 2013 10:09:08 +0900 by phpDocumentor 1.4.3