hirokawa Sun Feb 18 15:29:45 2001 EDT
Added files:
/phpdoc/ja/functions bzip2.xml ctype.xml
Modified files:
/phpdoc/ja/functions dir.xml mail.xml mysql.xml outcontrol.xml
pdf.xml yaz.xml
Log:
added ctype.xml and bzip2.xml in japanese tree and update translation.
Index: phpdoc/ja/functions/dir.xml
diff -u phpdoc/ja/functions/dir.xml:1.4 phpdoc/ja/functions/dir.xml:1.5
--- phpdoc/ja/functions/dir.xml:1.4 Sat Aug 26 18:43:06 2000
+++ phpdoc/ja/functions/dir.xml Sun Feb 18 15:29:44 2001
@@ -3,6 +3,35 @@
<title>ディレクトリ関数</title>
<titleabbrev>ディレクトリ</titleabbrev>
+ <refentry id="function.chroot">
+ <refnamediv>
+ <refname>chroot</refname>
+ <refpurpose>ルートディレクトリを変更する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>chroot</function></funcdef>
+ <paramdef>string <parameter>directory</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ カレントのプロセスのルートディレクトリを
+ <parameter>directory</parameter>に変更します。ルートディレクトリ
+ を変更できない場合に FALSE、それ以外の場合に TRUE
+を返します。
+ </para>
+ <note>
+ <para>
+ このリクエストの後で再度ルートディレクトリを /
+にリセットするこ
+
+とはできないため、Webサーバ環境での実行時にこの関数を使用するの
+
+は賢明ではありません。この関数は、CGIとして実行する場合にのみ正
+ しく機能します。
+ </para>
+ </note>
+ </refsect1>
+ </refentry>
+
<refentry id="function.chdir">
<refnamediv>
<refname>chdir</refname>
Index: phpdoc/ja/functions/mail.xml
diff -u phpdoc/ja/functions/mail.xml:1.9 phpdoc/ja/functions/mail.xml:1.10
--- phpdoc/ja/functions/mail.xml:1.9 Thu Jan 4 22:29:04 2001
+++ phpdoc/ja/functions/mail.xml Sun Feb 18 15:29:44 2001
@@ -25,6 +25,11 @@
<replaceable><optional>additional_headers</optional></replaceable>
</parameter>
</paramdef>
+ <paramdef>string
+ <parameter>
+ <replaceable><optional>additional_parameters</optional></replaceable>
+ </parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<simpara>
@@ -42,16 +47,44 @@
</example>
</para>
<simpara>
-
4番目の文字列が渡されると、その文字列はヘッダの最後に挿入されます。
-
これは通常ヘッダと追加する際に使用されます。追加ヘッダが複数の場合、
- 改行で区切ります。
+
+4番目の文字列が指定された場合、その文字列はヘッダの最後に挿入され
+
+ます。通常、これはヘッダを追加する際に使用されます。複数のヘッダ
+ を追加する場合は、改行で区切ります。
</simpara>
+ <simpara>
+
+5番目のパラメータを指定した場合、PHPはこのデータをメーラをコール
+ 際に追加します。この機能は、sendmailを使用する際に正しい
+ Return-Pathヘッダを設定したい場合に便利です。
+ </simpara>
+ <para>
+ <example>
+ <title>追加ヘッダを指定してメールを送信</title>
+ <programlisting role="php">
+mail("[EMAIL PROTECTED]", "the subject", $message,
+ "From: webmaster@$SERVER_NAME\nReply-To: webmaster@$SERVER_NAME\nX-Mailer: PHP/"
+. phpversion());
+ </programlisting>
+ </example>
+
+5番目のパラメータを指定するとこれが使用するメーラのコマンドライン
+ パラメータに追加されます。以下の例では、sendmailに正しい
+
+Return-Pathを設定しています。通常、sendmailは-fパラメータを使用し
+
+た場合にX-Authentication-Warningヘッダを追加します。これは、通常、
+
+Webサーバのユーザが認証済のユーザのメンバではないことが多いからで
+
+す。この警告をなくすには、Webサーバのユーザを使用するsendmailの設
+ 定ファイルの認証済のユーザ(trusted
+users)に追加する必要があります。
+ </para>
+ <note>
+ <para>
+ この5番目のパラメータは、PHP 4.0.5で追加されました。
+ </para>
+ </note>
<para>
<example>
- <title>追加ヘッダを指定してメールを送信します</title>
+ <title>
+
+ヘッダおよびコマンドラインパラメータを追加してメールを送信
+ </title>
<programlisting role="php">
-mail ("[EMAIL PROTECTED]", "the subject", $message,
- "From: webmaster@$SERVER_NAME\nReply-To: webmaster@$SERVER_NAME\nX-Mailer:
PHP/" . phpversion());
+mail("[EMAIL PROTECTED]", "the subject", $message,
+ "From: webmaster@$SERVER_NAME", "-fwebmaster@$SERVERNAME");
</programlisting>
</example>
複雑なemailメッセージを作成する際に単純な文字列結合を使用すること
@@ -92,7 +125,7 @@
$headers .= "bcc:[EMAIL PROTECTED], [EMAIL PROTECTED]\n"; // BCCの宛先
/* ここでメールを送信する */
-mail ($recipient, $subject, $message, $headers);
+mail($recipient, $subject, $message, $headers);
</programlisting>
</example>
</para>
Index: phpdoc/ja/functions/mysql.xml
diff -u phpdoc/ja/functions/mysql.xml:1.15 phpdoc/ja/functions/mysql.xml:1.16
--- phpdoc/ja/functions/mysql.xml:1.15 Thu Jan 4 22:29:04 2001
+++ phpdoc/ja/functions/mysql.xml Sun Feb 18 15:29:44 2001
@@ -1594,13 +1594,12 @@
<function>mysql_query</function>は失敗し、FALSEが返されます。
</para>
<para>
- クエリーが成功したとۮ定すると(DELETE, INSERT, REPLACE,
UPDATE文について)
+ クエリが成功したと仮定すると(DELETE, INSERT, REPLACE,
+UPDATE文について)
作用を受けた行の数を得るために<function>mysql_affected_rows</function>
- をコールすることができます。
- SELECT文については、
+ をコールすることができます。SELECT文については、
<function>mysql_query</function>は、新規の結果IDを返します。
このIDは、<function>mysql_result</function>の引数とすることができます。
- 結果の処理を終えた後、結果を俦́するリソースを
+ 結果の処理を終えた後、結果を保持するリソースを
<function>mysql_free_result</function>により解放することが
可能です。
</para>
@@ -1636,12 +1635,10 @@
</funcsynopsis>
<para>
<function>mysql_result</function> は、MySQL 結果セットから一つの
- セルの内容を返します。
-
引数fieldには、フィールドのオフセットまたはフィールド名または
- フィールド名.テーブル名を指定可能です。
- カラム名のエイリアスが定義されている場合
- ('select foo as bar
from...')、そのカラム名の代わりにエイリアスを
- 使用して下さい。
+
+セルの内容を返します。引数fieldには、フィールドのオフセットまたは
+
+フィールド名またはテーブル名.フィールド名を指定可能です。カラム名
+ のエイリアスが定義されている場合 ('select foo as bar from...')、
+ そのカラム名の代わりにエイリアスを使用して下さい。
</para>
<para>
大量の結果セットで作業を行う際、(以下で示す)
Index: phpdoc/ja/functions/outcontrol.xml
diff -u phpdoc/ja/functions/outcontrol.xml:1.6 phpdoc/ja/functions/outcontrol.xml:1.7
--- phpdoc/ja/functions/outcontrol.xml:1.6 Thu Jan 4 22:29:04 2001
+++ phpdoc/ja/functions/outcontrol.xml Sun Feb 18 15:29:44 2001
@@ -100,8 +100,8 @@
</funcsynopsis>
<para>
この関数は出力のバッファリングをオンにします。出力のバッファリン
-
グがアクティブの場合、スクリプトからの出力は実際には行われず、代
- わりに内部バッファに追加されます。
+
+グがアクティブの場合、(ヘッダ以外の)スクリプトからの出力は実際に
+ は行われず、代わりに内部バッファに追加されます。
</para>
<para>
この内部バッファの内容は、<function>ob_get_contents</function> を
@@ -111,51 +111,80 @@
消去します。
</para>
<para>
- オプションの引数 output_callback
関数を指定することが可能です。こ
-
の関数は、パラメータとして文字列をとり、文字列を返します。このコー
- ルバック関数は、<function>ob_end_flush</function> 実行時にコール
-
され、出力バッファの内容をパラメータとして受取ります。このコール
+ オプションの引数<parameter>output_callback</parameter>関数を指定
+
+することが可能です。この関数は、パラメータとして文字列をとり、文
+ 字列を返します。このコールバック関数は、
+ <function>ob_end_flush</function> がコールされた際、または、リク
+
+エストの最後にブラウザに出力をフラッシュする際にコールされます。
+ <parameter>output_callback</parameter>がコールされた際に、この関
+
+数は、出力バッファの内容をパラメータとして受取ります。このコール
バック関数は、新規の出力バッファを実際に出力される結果として返す
- 必要があります。
+ 必要があり、この結果はブラウザに送信されます。
</para>
+ <note>
+ <para>
+ PHP
+4.0.4において、Webページの圧縮をサポートする圧縮gzエンコード
+ されたデータのWebブラウザへの送信を容易にするために
+ <function>ob_gzhandler</function> がサポートされています。
+ <function>ob_gzhandler</function>は、ブラウザが受け入れるcontent
+ encodingの型を調べ、それに基づいて出力を返します。
+ </para>
+ </note>
<para>
出力バッファはスタッカブルであり、このため、他の
<function>ob_start</function> がアクティブの間に
<function>ob_start</function> をコールすることが可能です。この場
- 合、<function>ob_end_flush()</function> を適当な回数コールするよ
+ 合、<function>ob_end_flush</function> を適当な回数コールするよ
うにして下さい。複数の出力コールバック関数がアクティブの場合、出
力はネストした順番で逐次連続的にフィルタ処理されます。
</para>
<example>
- <title>コールバック関数の例</title>
+ <title>ユーザ定義のコールバック関数の例</title>
<programlisting role="php">
<?php
-function c($str) {
- // Druu Chunusun mut dum Kuntrubu゚...
- return nl2br(ereg_replace("[aeiou]", "u", $str));
-}
+
+function callback($buffer) {
+
+ // apples を全て oranges に置換する
+ return (ereg_replace("apples", "oranges", $buffer));
-function d($str) {
- return strip_tags($str);
}
-?>
-<?php ob_start("c"); ?>
-Drei Chinesen mit dem Kontraba゚...
-<?php ob_start("d"); ?>
-<h1>..sa゚en auf der Stra゚e und erz臧lten sich was...</h1>
-<?php ob_end_flush(); ?>
-... da kam die Polizei, ja was ist denn das?
-<?php ob_end_flush(); ?>
+ob_start("callback");
?>
+
+<html>
+<body>
+<p>It's like comparing apples to oranges.
+</body>
+</html>
+
+<?php
+
+ob_end_flush();
+
+?>
</programlisting>
</example>
<para>
+ 出力は次のようになります。
+ <informalexample>
+ <programlisting role="php">
+<html>
+<body>
+<p>It's like comparing oranges to oranges.
+</body>
+</html>
+ </programlisting>
+ </informalexample>
+ </para>
+ <para>
<function>ob_get_contents</function>,
<function>ob_end_flush</function>,
<function>ob_end_clean</function>,
- <function>ob_implicit_flush</function>も参照下さい。
+ <function>ob_implicit_flush</function>,
+ <function>ob_gzhandler</function> も参照下さい。
</para>
</refsect1>
</refentry>
@@ -212,6 +241,56 @@
</refsect1>
</refentry>
+ <refentry id="function.ob-gzhandler">
+ <refnamediv>
+ <refname>ob_gzhandler</refname>
+ <refpurpose>
+ 出力バッファをgzip圧縮するためのob_startコールバック関数
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ob_gzhandler</function></funcdef>
+ <paramdef>string <parameter>buffer</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>ob_gzhandler</function> は、Webページの圧縮をサポートす
+
+るgzエンコードされたデータをWebブラウザに送信することを容易にする
+
+ための<function>ob_start</function>用のコールバック関数として使用
+ されることを意図しています。<function>ob_gzhandler</function>は実
+
+際に圧縮されたデータを送信する前にブラウザがサポートするcontent
+
+encodingの種類("gzip"、"deflate"またはなし)を調べ、それに基づいて
+
+出力を返します。ブラウザがサポートする圧縮されたWebページを表す正
+
+しいヘッダを送信することは、ブラウザの責任であるため、全てのブラ
+ ウザがサポートされています。
+ </para>
+ <para>
+ <example>
+ <title><function>ob_gzhandler</function> の例</title>
+ <programlisting role="php">
+<php
+
+ob_start("ob_gzhandler");
+
+?>
+<html>
+<body>
+<p>This should be a compressed page.
+</html>
+</body>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <function>ob_start</function> および
+ <function>ob_end_flush</function>も参照下さい。
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.ob-end-flush">
<refnamediv>
<refname>ob_end_flush</refname>
Index: phpdoc/ja/functions/pdf.xml
diff -u phpdoc/ja/functions/pdf.xml:1.16 phpdoc/ja/functions/pdf.xml:1.17
--- phpdoc/ja/functions/pdf.xml:1.16 Thu Jan 4 22:29:04 2001
+++ phpdoc/ja/functions/pdf.xml Sun Feb 18 15:29:44 2001
@@ -338,104 +338,109 @@
<title>pdflib配布ファイル中の pdfclockの例</title>
<programlisting role="php">
<?php
-$pdffilename = "clock.pdf";
$radius = 200;
$margin = 20;
-$pagecount = 40;
+$pagecount = 10;
-$fp = fopen($pdffilename, "w");
-$pdf = pdf_open($fp);
-pdf_set_info($pdf, "Creator", "pdf_clock.php3");
-pdf_set_info($pdf, "Author", "Uwe Steinmann");
-pdf_set_info($pdf, "Title", "Analog Clock");
+$pdf = PDF_new();
+if (!PDF_open_file($pdf, "")) {
+ print error;
+ exit;
+};
+
+PDF_set_parameter($pdf, "warning", "true");
+
+PDF_set_info($pdf, "Creator", "pdf_clock.php");
+PDF_set_info($pdf, "Author", "Uwe Steinmann");
+PDF_set_info($pdf, "Title", "Analog Clock");
+
while($pagecount-- > 0) {
- pdf_begin_page($pdf, 2 * ($radius + $margin), 2 * ($radius + $margin));
+ PDF_begin_page($pdf, 2 * ($radius + $margin), 2 * ($radius + $margin));
- pdf_set_parameter($pdf, "transition", "wipe");
- pdf_set_value($pdf, "duration", 0.5);
+ PDF_set_parameter($pdf, "transition", "wipe");
+ PDF_set_value($pdf, "duration", 0.5);
- pdf_translate($pdf, $radius + $margin, $radius + $margin);
- pdf_save($pdf);
- pdf_setrgbcolor($pdf, 0.0, 0.0, 1.0);
+ PDF_translate($pdf, $radius + $margin, $radius + $margin);
+ PDF_save($pdf);
+ PDF_setrgbcolor($pdf, 0.0, 0.0, 1.0);
/* 1分刻みの目盛 */
- pdf_setlinewidth($pdf, 2.0);
+ PDF_setlinewidth($pdf, 2.0);
for ($alpha = 0; $alpha < 360; $alpha += 6) {
- pdf_rotate($pdf, 6.0);
- pdf_moveto($pdf, $radius, 0.0);
- pdf_lineto($pdf, $radius-$margin/3, 0.0);
- pdf_stroke($pdf);
+ PDF_rotate($pdf, 6.0);
+ PDF_moveto($pdf, $radius, 0.0);
+ PDF_lineto($pdf, $radius-$margin/3, 0.0);
+ PDF_stroke($pdf);
}
- pdf_restore($pdf);
- pdf_save($pdf);
+ PDF_restore($pdf);
+ PDF_save($pdf);
/* 5分刻みの目盛 */
- pdf_setlinewidth($pdf, 3.0);
+ PDF_setlinewidth($pdf, 3.0);
for ($alpha = 0; $alpha < 360; $alpha += 30) {
- pdf_rotate($pdf, 30.0);
- pdf_moveto($pdf, $radius, 0.0);
- pdf_lineto($pdf, $radius-$margin, 0.0);
- pdf_stroke($pdf);
+ PDF_rotate($pdf, 30.0);
+ PDF_moveto($pdf, $radius, 0.0);
+ PDF_lineto($pdf, $radius-$margin, 0.0);
+ PDF_stroke($pdf);
}
$ltime = getdate();
/* 時針を描画 */
- pdf_save($pdf);
- pdf_rotate($pdf,-(($ltime['minutes']/60.0)+$ltime['hours']-3.0)*30.0);
- pdf_moveto($pdf, -$radius/10, -$radius/20);
- pdf_lineto($pdf, $radius/2, 0.0);
- pdf_lineto($pdf, -$radius/10, $radius/20);
- pdf_closepath($pdf);
- pdf_fill($pdf);
- pdf_restore($pdf);
+ PDF_save($pdf);
+ PDF_rotate($pdf,-(($ltime['minutes']/60.0)+$ltime['hours']-3.0)*30.0);
+ PDF_moveto($pdf, -$radius/10, -$radius/20);
+ PDF_lineto($pdf, $radius/2, 0.0);
+ PDF_lineto($pdf, -$radius/10, $radius/20);
+ PDF_closepath($pdf);
+ PDF_fill($pdf);
+ PDF_restore($pdf);
/* 分針を描画 */
- pdf_save($pdf);
- pdf_rotate($pdf,-(($ltime['seconds']/60.0)+$ltime['minutes']-15.0)*6.0);
- pdf_moveto($pdf, -$radius/10, -$radius/20);
- pdf_lineto($pdf, $radius * 0.8, 0.0);
- pdf_lineto($pdf, -$radius/10, $radius/20);
- pdf_closepath($pdf);
- pdf_fill($pdf);
- pdf_restore($pdf);
+ PDF_save($pdf);
+ PDF_rotate($pdf,-(($ltime['seconds']/60.0)+$ltime['minutes']-15.0)*6.0);
+ PDF_moveto($pdf, -$radius/10, -$radius/20);
+ PDF_lineto($pdf, $radius * 0.8, 0.0);
+ PDF_lineto($pdf, -$radius/10, $radius/20);
+ PDF_closepath($pdf);
+ PDF_fill($pdf);
+ PDF_restore($pdf);
/* 秒針を描画 */
- pdf_setrgbcolor($pdf, 1.0, 0.0, 0.0);
- pdf_setlinewidth($pdf, 2);
- pdf_save($pdf);
- pdf_rotate($pdf, -(($ltime['seconds'] - 15.0) * 6.0));
- pdf_moveto($pdf, -$radius/5, 0.0);
- pdf_lineto($pdf, $radius, 0.0);
- pdf_stroke($pdf);
- pdf_restore($pdf);
+ PDF_setrgbcolor($pdf, 1.0, 0.0, 0.0);
+ PDF_setlinewidth($pdf, 2);
+ PDF_save($pdf);
+ PDF_rotate($pdf, -(($ltime['seconds'] - 15.0) * 6.0));
+ PDF_moveto($pdf, -$radius/5, 0.0);
+ PDF_lineto($pdf, $radius, 0.0);
+ PDF_stroke($pdf);
+ PDF_restore($pdf);
/* 中心に小さな円を描画 */
- pdf_circle($pdf, 0, 0, $radius/30);
- pdf_fill($pdf);
+ PDF_circle($pdf, 0, 0, $radius/30);
+ PDF_fill($pdf);
+
+ PDF_restore($pdf);
- pdf_restore($pdf);
+ PDF_end_page($pdf);
- pdf_end_page($pdf);
+ # 変化を見るために待つ
+ sleep(1);
}
-$pdf = pdf_close($pdf);
-fclose($fp);
-echo "<A HREF=getpdf.php?filename=".$pdffilename.">finished</A>";
-?>
- </programlisting>
- <simpara>
- 以下のPHPスクリプト<filename>getpdf.php</filename>は、pdfドキュ
- メントを出力するだけのものです。
- </simpara>
- <programlisting role="php">
-<?php
-$fp = fopen($filename, "r");
+PDF_close($pdf);
+
+$buf = PDF_get_buffer($pdf);
+$len = strlen($buf);
+
header("Content-type: application/pdf");
-fpassthru($fp);
-fclose($fp);
+header("Content-Length: $len");
+header("Content-Disposition: inline; filename=foo.pdf");
+print $buf;
+
+PDF_delete($pdf);
?>
</programlisting>
</example>
@@ -443,1481 +448,1211 @@
</sect1>
</partintro>
- <refentry id="function.pdf-set-info">
+ <refentry id="function.pdf-add-annotation">
<refnamediv>
- <refname>pdf_set_info</refname>
- <refpurpose>ドキュメント情報のフィールドを設定する</refpurpose>
+ <refname>PDF_add_annotation</refname>
+ <refpurpose>古い関数: 注記を追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_set_info</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>fieldname</parameter></paramdef>
- <paramdef>string <parameter>value</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
-
関数<function>pdf_set_info</function>は、pdfドキュメントの情報フィー
- ルドを設定します。fieldnameとして設定可能な値は、'Subject',
- 'Title', 'Creator','Author', 'Keywords'および1種類のユーザが定義
-
した名前です。ページを開始する前にコールすることが可能です。
- <example>
- <title>ドキュメント情報を設定する</title>
- <programlisting role="php">
-<?php
-$fd = fopen("test.pdf", "w");
-$pdfdoc = pdf_open($fd);
-pdf_set_info($pdfdoc, "Author", "Uwe Steinmann");
-pdf_set_info($pdfdoc, "Creator", "Uwe Steinmann");
-pdf_set_info($pdfdoc, "Title", "Testing Info Fields");
-pdf_set_info($pdfdoc, "Subject", "Test");
-pdf_set_info($pdfdoc, "Keywords", "Test, Fields");
-pdf_set_info($pdfdoc, "CustomField", "What ever makes sense");
-pdf_begin_page($pdfdoc, 595, 842);
-pdf_end_page($pdfdoc);
-pdf_close($pdfdoc);
-?>
- </programlisting>
- </example>
+ <function>PDF_add_outline</function> は、
+ <function>PDF_add_note</function>に置換されました。
</para>
- <note>
- <simpara>
- この関数は、<function>pdf_set_info_keywords</function>,
- <function>pdf_set_info_title</function>,
- <function>pdf_set_info_subject</function>,
- <function>pdf_set_info_creator</function>,
- <function>pdf_set_info_sybject</function>を置き換えるものです。
- </simpara>
- </note>
+ <para>
+ <function>PDF_add_note</function>も参照下さい。
+ </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-open">
+ <refentry id="function.pdf-add-bookmark">
<refnamediv>
- <refname>pdf_open</refname>
- <refpurpose>新規の pdf ドキュメントをオープンする</refpurpose>
+ <refname>PDF_add_bookmark</refname>
+
+<refpurpose>ブックマークをカレントのページに追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_open</function></funcdef>
- <paramdef>int <parameter>file</parameter></paramdef>
+ <funcdef>int <function>PDF_add_bookmark</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
+ <paramdef>int
+ <parameter><optional>parent</optional></parameter>
+ </paramdef>
+ <paramdef>int
+ <parameter><optional>open</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_open</function>関数は、新規の pdf
ドキュメントをオー
- プンします。対応するファイルは、<function>fopen</function>
でオー
- プンされ、ファイル記述子は引数 <parameter>file</parameter>
として
- 渡される必要があります。
- <note>
- <simpara>
-
返り値は、pdfドキュメントを書く他の全ての関数で最初のパラメータ
- として必要です。
- </simpara>
- </note>
- </para>
<para>
- <function>fopen</function>,<function>pdf_close</function>も参照下
- さい。
+ <parameter>parent</parameter>以下または
+ <parameter>parent</parameter> =
+0の場合に、新規にトップレベルのブッ
+
+クマーク以下にブックマーク階層を追加します。ブックマーク記述子が
+
+返されますが、これは、これ以降にブックマーク階層を追加する際に、
+ 親として使用することが可能です。
+ open = 1の場合、子ブックマークは展開され、open =
+0の場合は隠され
+ ます。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-close">
+ <refentry id="function.pdf-add-launchlink">
<refnamediv>
- <refname>pdf_close</refname>
- <refpurpose>pdf ドキュメントを閉じる</refpurpose>
+ <refname>PDF_add_launchlink</refname>
+ <refpurpose>カレントのページに起動用注記を追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_close</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>int <function>PDF_add_launchlink</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>llx</parameter></paramdef>
+ <paramdef>double <parameter>lly</parameter></paramdef>
+ <paramdef>double <parameter>urx</parameter></paramdef>
+ <paramdef>double <parameter>ury</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_close</function> 関数は、pdf
ドキュメントを閉じます。
- </para>
<para>
- <function>pdf_open</function>,
- <function>fclose</function> も参照下さい。
+
+(任意のファイル型のターゲットへの)起動用の注記を追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-begin-page">
+ <refentry id="function.pdf-add-locallink">
<refnamediv>
- <refname>pdf_begin_page</refname>
- <refpurpose>新規ページを開始する</refpurpose>
+ <refname>PDF_add_locallink</refname>
+ <refpurpose>カレントのページにリンク注記を追加</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_begin_page</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>height</parameter></paramdef>
- <paramdef>double <parameter>width</parameter></paramdef>
+ <funcdef>int <function>PDF_add_locallink</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>llx</parameter></paramdef>
+ <paramdef>double <parameter>lly</parameter></paramdef>
+ <paramdef>double <parameter>urx</parameter></paramdef>
+ <paramdef>double <parameter>ury</parameter></paramdef>
+ <paramdef>int <parameter>page</parameter></paramdef>
+ <paramdef>string <parameter>dest</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_begin_page</function> 関数は、高さ
- <parameter>height</parameter> および幅
- <parameter>width</parameter>で新規ページを開始します。
- 有効なドキュメントを作成するためには、この関数と
- <function>pdf_end_page</function>を最低一回はコールする必要があり
- ます。
- </para>
<para>
- <function>pdf_end_page</function> も参照下さい。
+
+カレントのPDFファイルの中にターゲットへのリンク注記を追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-end-page">
+ <refentry id="function.pdf-add-note">
<refnamediv>
- <refname>pdf_end_page</refname>
- <refpurpose>ページを終了する</refpurpose>
+ <refname>PDF_add_note</refname>
+ <refpurpose>カレントのページに注記を追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_end_page</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>int <function>PDF_add_note</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>llx</parameter></paramdef>
+ <paramdef>double <parameter>lly</parameter></paramdef>
+ <paramdef>double <parameter>urx</parameter></paramdef>
+ <paramdef>double <parameter>ury</parameter></paramdef>
+ <paramdef>string <parameter>contents</parameter></paramdef>
+ <paramdef>string <parameter>title</parameter></paramdef>
+ <paramdef>string <parameter>icon</parameter></paramdef>
+ <paramdef>int <parameter>open</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_end_page</function> 関数はページを終了します。
- いったんページを終了するともう修正はできません。
- </para>
<para>
- <function>pdf_begin_page</function> も参照下さい。
+ 注記を追加します。iconvは、"comment, "insert", "note",
+ "paragraph", "newparagraph", "key", "help"のどれかとなります。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-show">
+ <refentry id="function.pdf-add-outline">
<refnamediv>
- <refname>pdf_show</refname>
- <refpurpose>カレントの位置にテキストを出力する</refpurpose>
+ <refname>pdf_add_outline</refname>
+ <refpurpose>古い関数:
+カレントのページにブックマークを追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_show</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <para>
- <function>pdf_show</function> 関数は、カレントのテキスト位置にカ
- レントフォントを用いて文字列<parameter>text</parameter>
を出力し
- ます。
+ <para>
+ 古い関数です。
</para>
<para>
- <function>pdf_show_xy</function>,
- <function>pdf_show_boxed</function>,
- <function>pdf_set_text_pos</function>,
- <function>pdf_set_font</function>も参照下さい。
+ <function>PDF_add_bookmark</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-show-boxed">
+ <refentry id="function.pdf-add-pdflink">
<refnamediv>
- <refname>pdf_show_boxed</refname>
- <refpurpose>箱の中にテキストを出力する</refpurpose>
+ <refname>PDF_add_pdflink</refname>
+ <refpurpose>カレントページにリンク注記を追加</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_show_boxed</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>width</parameter></paramdef>
- <paramdef>double <parameter>height</parameter></paramdef>
- <paramdef>string <parameter>mode</parameter></paramdef>
+ <funcdef>int <function>PDF_add_pdflink</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>llx</parameter></paramdef>
+ <paramdef>double <parameter>lly</parameter></paramdef>
+ <paramdef>double <parameter>urx</parameter></paramdef>
+ <paramdef>double <parameter>ury</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
+ <paramdef>int <parameter>page</parameter></paramdef>
+ <paramdef>string <parameter>dest</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_show_boxed</function>関数は文字列
- <parameter>text</parameter>を左下隅の座標を
- (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>)とす
- る箱の内に出力します。箱の大きさは、
- <parameter>height</parameter>×<parameter>width</parameter>
-
となります。パラメータ<parameter>mode</parameter>によりテキストの
- 出力方法を指定します。<parameter>width</parameter>と
- <parameter>height</parameter>がゼロの場合、
- <parameter>mode</parameter>には"left"、"right"、"center"を指定可
- 能です。<parameter>width</parameter>または
- <parameter>height</parameter>がゼロでない場合、"justify"および
- "fulljustify"を指定可能です。
- </para>
- <para>
- 箱の中に収まらずに処理できなかった文字の数を返します。
- </para>
<para>
- <function>pdf_show</function>,<function>pdf_show_xy</function>も
- 参照下さい。
+ (PDFターゲットに)リンク注記を追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-show-xy">
+ <refentry id="function.pdf-add-weblink">
<refnamediv>
- <refname>pdf_show_xy</refname>
- <refpurpose>テキストを指定位置に出力する</refpurpose>
+ <refname>PDF_add_weblink</refname>
+ <refpurpose>カレントのページにWebリンクを追加する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_show_xy</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
+ <funcdef>int <function>PDF_add_weblink</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>llx</parameter></paramdef>
+ <paramdef>double <parameter>lly</parameter></paramdef>
+ <paramdef>double <parameter>urx</parameter></paramdef>
+ <paramdef>double <parameter>ury</parameter></paramdef>
+ <paramdef>string <parameter>url</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_show_xy</function> 関数は、文字列
- <parameter>text</parameter> を位置(<parameter>x-coor</parameter>,
- <parameter>y-coor</parameter>) に出力します。
- </para>
<para>
- <function>pdf_show</function>、
- <function>pdf_show_boxed</function> も参照下さい。
+ Web上のターゲットURLへのWebリンクを追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-font">
+ <refentry id="function.pdf-arc">
<refnamediv>
- <refname>pdf_set_font</refname>
- <refpurpose>フォントの種類及びサイズを選択する</refpurpose>
+ <refname>pdf_arc</refname>
+ <refpurpose>円弧を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_font</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>font name</parameter></paramdef>
- <paramdef>double <parameter>size</parameter></paramdef>
- <paramdef>string <parameter>encoding</parameter></paramdef>
- <paramdef>int
- <parameter>
- <replaceable><optional>embed</optional></replaceable>
- </parameter>
- </paramdef>
+ <funcdef>void <function>pdf_arc</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
+ <paramdef>double <parameter>r</parameter></paramdef>
+ <paramdef>double <parameter>alpha</parameter></paramdef>
+ <paramdef>double <parameter>beta</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_font</function> 関数は、カレントのフォントの種
-
類およびフォントサイズ、エンコード法を設定します。pdflib 0.6
を使
- 用している場合、フォントパス (デフォルトは ./fonts )
にあるフォン
- トについてAdobe Font Metrics (afm ファイル)
を用意する必要があり
- ます。PHP
3またはバージョン2.20より以前のpdflibを使用している場合
- は、4番目のパラメータ<parameter>encoding</parameter> は次のような
- 値を取ります:0 = builtin, 1 = pdfdoc, 2 = macroman, 3 =
- macexpert, 4 =
winansi。4より大きいか0未満のエンコードは、デフォ
- ルトが winansi となります。winansi
は通常の場合良い選択肢です。
-
php4とpdflibバージョン2.20以降を使用している場合、パラメータ
- encodingは文字列に変更されています。'winansi','builtin', 'host',
-
'macroman'等を代わりに使用して下さい。最後のパラメータを1に設定し
- た場合、フォントは、pdf
ドキュメントに組み込まれますが、1を設定し
-
ない場合は組み込まれません。フォントが一般に普及しておらず、自分
-
の文書を見る人がその文書内のフォントにアクセスできる保証がない場
-
合、そのフォントを埋め込むというのは一般的に良い考えです。
- フォントが埋め込まれるのは、<function>pdf_set_font</function>を複
- 数回コールした場合でも一回だけです。
- </para>
- <note>
- <simpara>
-
(訳注)埋め込みフォントはCJKフォントではサポートされていません。
- このため、CJKフォントを使用する場合は、
- <parameter>embed</parameter>には0を指定する必要があります。
- </simpara>
- </note>
- <note>
- <simpara>
- 有効なpdfドキュメントを作成するためには、この関数を
-
<function>pdf_begin_page</function>の後にコールする必要があります。
- </simpara>
- </note>
- <note>
- <simpara>
-
.uprファイルの中のフォントを参照する場合、afmファイルの名前とフォ
-
ント名が同じになるようにして下さい。さもないと、このフォントは複
- 数回埋め込まれることになります。(Paul
Haddonがこのことを見付けて
- くれました)
- </simpara>
- </note>
+ 反時計周りにalpha度からbeta度まで円弧を描画します。
+ </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-leading">
+ <refentry id="function.pdf-begin-page">
<refnamediv>
- <refname>pdf_set_leading</refname>
- <refpurpose>テキスト行間の距離を設定する</refpurpose>
+ <refname>pdf_begin_page</refname>
+ <refpurpose>新規ページを開始する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set leading</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>distance</parameter></paramdef>
+ <funcdef>void <function>pdf_begin_page</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ <paramdef>double <parameter>height</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_set_leading</function> 関数はテキスト行間の距離を設
- 定します。テキストが <function>pdf_continue_text</function> によ
- り出力される場合に使用されます。
- </para>
<para>
- <function>pdf_continue_text</function> も参照下さい。
+ 新規ページをドキュメントに追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-parameter">
+ <refentry id="function.pdf-circle">
<refnamediv>
- <refname>pdf_set_parameter</refname>
- <refpurpose>パラメータを設定する</refpurpose>
+ <refname>pdf_circle</refname>
+ <refpurpose>円を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_parameter</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>string <parameter>value</parameter></paramdef>
+ <funcdef>void <function>pdf_circle</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
+ <paramdef>double <parameter>r</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- 関数<function>pdf_set_parameter</function>はpdflibのパラメータの
- 型を指定して多数のパラメータを設定します。
- </para>
<para>
- <function>pdf_get_value</function>、
- <function>pdf_set_value</function>、
- <function>pdf_get_parameter</function>も参照下さい。
+ (x, y) を中心として半径rの円を描く。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-get-parameter">
+ <refentry id="function.pdf-clip">
<refnamediv>
- <refname>pdf_get_parameter</refname>
- <refpurpose>パラメータを得る</refpurpose>
+ <refname>pdf_clip</refname>
+ <refpurpose>カレントのパスに切り取る</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>pdf_get_parameter</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>double <parameter>modifier</parameter></paramdef>
+ <funcdef>void <function>pdf_clip</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_get_parameter</function>は指定した型のpdflibパ
-
ラメータを得ます。関数のパラメータ<parameter>modifier</parameter>
-
は取得するパラメータを修飾するものです。modifierが必要でない場合
- には、0を指定する必要があります。
+ カレントのパスをクリッピングのパスとして使用します。
</para>
- <para>
- <function>pdf_get_value</function>,
- <function>pdf_set_value</function>,
- <function>pdf_set_parameter</function>も参照下さい。
- </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-value">
+ <refentry id="function.pdf-close">
<refnamediv>
- <refname>pdf_set_value</refname>
- <refpurpose>数値を設定する</refpurpose>
+ <refname>pdf_close</refname>
+ <refpurpose>pdf ドキュメントを閉じる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_value</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>double <parameter>value</parameter></paramdef>
+ <funcdef>void <function>pdf_close</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- 関数<function>pdf_set_value</function>はpdflibのパラメータの数値
- を設定します。
- </para>
<para>
- <function>pdf_get_value</function>,
- <function>pdf_get_parameter</function>,
- <function>pdf_set_parameter</function>も参照下さい。
+
+生成されたPDFファイルを閉じ、ドキュメントの関係する全てのリソース
+ を開放します。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-get-value">
+
+ <refentry id="function.pdf-closepath">
<refnamediv>
- <refname>pdf_get_value</refname>
- <refpurpose>数値を得る</refpurpose>
+ <refname>pdf_closepath</refname>
+ <refpurpose>パスを閉じる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>double <function>pdf_get_value</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>name</parameter></paramdef>
- <paramdef>double
- <parameter>
- <replaceable><optional>modifier</optional></replaceable>
- </parameter>
- </paramdef>
+ <funcdef>void <function>pdf_closepath</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- 関数<function>pdf_get_value</function>はpdflibの数値パラメータを
-
得ます。関数パラメータ<parameter>modifier</parameter>は、取得する
-
パラメータを修飾します。modifierが必要でない場合には、0を指定する
- 必要があります。
- </para>
<para>
- <function>pdf_set_value</function>,
- <function>pdf_get_parameter</function>,
- <function>pdf_set_parameter</function>も参照下さい。
+ カレントのパスを閉じます。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-get-image-height">
+ <refentry id="function.pdf-closepath-fill-stroke">
<refnamediv>
- <refname>pdf_get_image_height</refname>
- <refpurpose>イメージの高さを返す</refpurpose>
+ <refname>pdf_closepath_fill_stroke</refname>
+
+<refpurpose>カレントのパスを閉じ、塗りつぶし、輪郭を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>pdf_get_image_height</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
+ <funcdef>void <function>pdf_closepath_fill_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- 関数<function>pdf_get_image_height</function>は、pdfイメージの高
- さをピクセル単位で返します。
- </para>
<para>
- <function>pdf_open_image_file</function>、
- <function>pdf_open_memory_image</function>、
- <function>pdf_get_image_width</function>も参照下さい。
+ パスを閉じ、塗りつぶし、輪郭を描きます。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-get-image-width">
+ <refentry id="function.pdf-closepath-stroke">
<refnamediv>
- <refname>pdf_get_image_width</refname>
- <refpurpose>イメージの幅を返す</refpurpose>
+ <refname>pdf_closepath_stroke</refname>
+ <refpurpose>パスを閉じ、パスに沿って線を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>string <function>pdf_get_image_width</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
+ <funcdef>void <function>pdf_closepath_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_get_image_width</function>は、pdfイメージの幅を
- ピクセル単位で返します。
+ パスを閉じ、その輪郭を描きます。
</para>
- <para>
- <function>pdf_open_image_file</function>,
- <function>pdf_open_memory_image</function>,
- <function>pdf_get_image_height</function>も参照下さい。
- </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-text-rendering">
+ <refentry id="function.pdf-close-image">
<refnamediv>
- <refname>pdf_set_text_rendering</refname>
- <refpurpose>テキストの描画法を定義する</refpurpose>
+ <refname>pdf_close_image</refname>
+ <refpurpose>画像を閉じる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_text_rendering</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>mode</parameter></paramdef>
+ <funcdef>void <function>pdf_close_image</function></funcdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_text_rendering</function>関数はテキストの描画法
-
を設定します。<parameter>mode</parameter>の値は、0=塗りつぶしたテ
- キスト, 1=ストロークテキスト,
2=塗りつぶしおよびストロークテキス
- ト,
3=不可視,4=塗りつぶしたテキストおよびクリッピングパスへ追加,
- 5=ストロークテキストおよびクリッピングパスへ追加,
6=塗りつぶした
- ストロークテキストおよびクリッピングパスへ追加,
7=クリッピングパ
- スへ追加のどれかです。
+ <function>PDF_open_image*</function>関数のどれかから取得された
+ <parameter>image</parameter>を閉じます。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-horiz-scaling">
+ <refentry id="function.pdf-concat">
<refnamediv>
- <refname>pdf_set_horiz_scaling</refname>
- <refpurpose>テキストの水平スケールを設定する</refpurpose>
+ <refname>PDF_concat</refname>
+ <refpurpose>行列をCTMに追加</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_horiz_scaling</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>scale</parameter></paramdef>
+ <funcdef>void <function>PDF_concat</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>a</parameter></paramdef>
+ <paramdef>double <parameter>b</parameter></paramdef>
+ <paramdef>double <parameter>c</parameter></paramdef>
+ <paramdef>double <parameter>d</parameter></paramdef>
+ <paramdef>double <parameter>e</parameter></paramdef>
+ <paramdef>double <parameter>f</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_horiz_scaling</function> 関数は、水平スケールを
- <parameter>scale</parameter> パーセントに設定します。
+ 行列をCTMに追加します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-text-rise">
+
+ <refentry id="function.pdf-continue-text">
<refnamediv>
- <refname>pdf_set_text_rise</refname>
- <refpurpose>テキストを拡大する</refpurpose>
+ <refname>pdf_continue_text</refname>
+ <refpurpose>次の行にテキストを出力する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_text_rise</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>rise</parameter></paramdef>
+ <funcdef>void <function>pdf_continue_text</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_text_rise</function> 関数は、テキストを
- <parameter>rise</parameter> ポイントに拡大します。
+ 次の行にtextを出力します。行間の空白は、パラメータ
+ <parameter>leading</parameter> で定義されます。
+ Print text at the next line. The spacing between lines is determined
+ by the <parameter>leading</parameter> parameter.
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-text-matrix">
+ <refentry id="function.pdf-curveto">
<refnamediv>
- <refname>pdf_set_text_matrix</refname>
- <refpurpose>テキスト行列を設定する</refpurpose>
+ <refname>pdf_curveto</refname>
+ <refpurpose>曲線を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_text_matrix</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>array <parameter>matrix</parameter></paramdef>
+ <funcdef>void <function>pdf_curveto</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x1</parameter></paramdef>
+ <paramdef>double <parameter>y1</parameter></paramdef>
+ <paramdef>double <parameter>x2</parameter></paramdef>
+ <paramdef>double <parameter>y2</parameter></paramdef>
+ <paramdef>double <parameter>x3</parameter></paramdef>
+ <paramdef>double <parameter>y3</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_text_matrix</function> 関数は、カレントのテキス
-
トフォントに適用される変換を記述する行列(matrix)を設定します。
- matrix
は、6個の要素を有する配列として指定する必要があります。
+
+3つの制御点を使用して現在の点からベジエ曲線を描画します。
</para>
- <note>
- <simpara>
- この関数は、PDFLIB 2.3以降ではもう利用できません。
- </simpara>
- </note>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-text-pos">
+ <refentry id="function.pdf-delete">
<refnamediv>
- <refname>pdf_set_text_pos</refname>
- <refpurpose>テキスト位置を設定する</refpurpose>
+ <refname>PDF_delete</refname>
+ <refpurpose>PDFオブジェクトを削除</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_text_pos</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
+ <funcdef>void <function>PDF_delete</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_set_text_pos</function> 関数は、次の
- <function>pdf_show</function> 関数コールに用いるテキストの位置を
- 設定します。
- </para>
<para>
- <function>pdf_show</function>,
- <function>pdf_show_xy</function> も参照下さい。
+ PDFオブジェクトを削除し、内部リソースを全て開放します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-char-spacing">
+ <refentry id="function.pdf-end-page">
<refnamediv>
- <refname>pdf_set_char_spacing</refname>
- <refpurpose>文字間の空白を設定する</refpurpose>
+ <refname>pdf_end_page</refname>
+ <refpurpose>ページを終了する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_char_spacing</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>space</parameter></paramdef>
+ <funcdef>void <function>pdf_end_page</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_set_char_spacing</function> 関数は、文字間の空白を
- 設定します。
- </para>
<para>
- <function>pdf_set_word_spacing</function>,
- <function>pdf_set_leading</function> も参照下さい。
+ ページを終了します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-word-spacing">
+ <refentry id="function.pdf-endpath">
<refnamediv>
- <refname>pdf_set_word_spacing</refname>
- <refpurpose>単語間の空白を設定する</refpurpose>
+ <refname>pdf_endpath</refname>
+ <refpurpose>古い関数: カレントのパスを終了する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_word_spacing</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>space</parameter></paramdef>
+ <funcdef>void <function>pdf_endpath</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_word_spacing</function> 関数は、単語間の空白を
- 設定します。
+
+古い関数であるため、代わりにstroke、fill、clip関数を使用して下さ
+ い。
</para>
- <para>
- <function>pdf_set_char_spacing</function>,
- <function>pdf_set_leading</function> も参照下さい。
- </para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-skew">
+
+ <refentry id="function.pdf-fill">
<refnamediv>
- <refname>pdf_skew</refname>
- <refpurpose>座標系を歪ませる</refpurpose>
+ <refname>pdf_fill</refname>
+ <refpurpose>カレントのパスを塗りつぶす</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_skew</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>alpha</parameter></paramdef>
- <paramdef>double <parameter>beta</parameter></paramdef>
+ <funcdef>void <function>pdf_fill</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_skew</function>は、<parameter>alpha</parameter>
- (x)度と<parameter>beta</parameter>(y) 度、座標系を歪ませます。
- <parameter>alpha</parameter>と<parameter>beta</parameter>は、90度
- または270度とすることはできません。
+ パスの内部をカレントの塗りつぶし色で塗りつぶします。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-continue-text">
+ <refentry id="function.pdf-fill-stroke">
<refnamediv>
- <refname>pdf_continue_text</refname>
- <refpurpose>次の行にテキストを出力する</refpurpose>
+ <refname>pdf_fill_stroke</refname>
+
+<refpurpose>カレントのパスを塗りつぶし、パスの輪郭を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_continue_text</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
+ <funcdef>void <function>pdf_fill_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_continue_text</function> 関数は、次の行に
- <parameter>text</parameter> の中の文字列を出力します。行間は、
- <function>pdf_set_leading</function> で指定可能です。
- </para>
<para>
- <function>pdf_show_xy</function>,
- <function>pdf_set_leading</function>,
- <function>pdf_set_text_pos</function> も参照下さい。
+
+カレントのパスの内部をカレントの塗りつぶし色で塗りつぶし、カレン
+ トのパスの輪郭を輪郭色で描画します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-stringwidth">
+ <refentry id="function.pdf-findfont">
<refnamediv>
- <refname>pdf_stringwidth</refname>
- <refpurpose>カレントフォントのテキストの幅を返す</refpurpose>
+ <refname>PDF_findfont</refname>
+ <refpurpose>
+ 後で<function>PDF_setfont</function>で使用するフォントを準備する
+ </refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>double <function>pdf_stringwidth</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
+ <funcdef>void <function>PDF_findfont</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>fontname</parameter></paramdef>
+ <paramdef>string <parameter>encoding^</parameter></paramdef>
+ <paramdef>int <parameter>embed</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_stringwidth</function> 関数は、カレントのフォントを
- 用いた場合の<parameter>text</parameter>
の文字列の幅を返します。
- 事前に<function>pdf_set_font</function>でフォントを設定しておく必
- 要があります。
- </para>
<para>
- <function>pdf_set_font</function> も参照下さい。
+ この後、<function>PDF_setfont</function>で使用するフォントを準備
+
+します。このフォントのメトリックがロードされ、embedがゼロでない場
+
+合、フォントファイルがチェックされますが、ロードはまだ行われませ
+ ん。encodingは、"builtin", "macroman", "winansi", "host" またはユー
+
+ザが定義したエンコーディング名またはCMapの名前のどれかとなります。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-save">
+ <refentry id="function.pdf-get-buffer">
<refnamediv>
- <refname>pdf_save</refname>
- <refpurpose>現在の環境を保存する</refpurpose>
+ <refname>PDF_get_buffer</refname>
+ <refpurpose>
+ 生成されたPDFデータを含むバッファを取得する
+ </refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_save</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>string <function>PDF_get_buffer</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_save</function> 関数は、現在の環境を保存します。
- この関数は、postscript コマンド gsave と同様に動作します。
-
他のオブジェクトを変更することなくあるオブジェクトを変換または回
-
転させたい場合に大変便利です。<function>pdf_save</function>の前に
- 環境を保存するには、常に<function>pdf_save</function> の後に
- <function>pdf_restore</function>を実行する必要があります。
- </para>
<para>
- <function>pdf_restore</function> も参照下さい。
+
+PDF出力バッファの内容を取得します。この結果は、この他のPDFlib関数
+
+をコールする前にクライアントで使用済である必要があります。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-restore">
+ <refentry id="function.pdf-get-font">
<refnamediv>
- <refname>pdf_restore</refname>
- <refpurpose>以前保存された環境を回復する</refpurpose>
+ <refname>PDF_get_font</refname>
+ <refpurpose>古い関数: フォント処理</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_restore</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- <function>pdf_restore</function> 関数は、
- <function>pdf_save</function> で保存された環境を回復します。この
- 関数は、postscript コマンド grestore と似た動作をします。
- <example>
- <title>保存と回復</title>
- <programlisting role="php">
-<?php pdf_save($pdf);
-// 回転、変換を衣F ...
-pdf_restore($pdf) ?>
- </programlisting>
- </example>
+ 古い関数です。
</para>
<para>
- <function>pdf_save</function> も参照下さい。
+ <function>PDF_get_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-translate">
+ <refentry id="function.pdf-get-fontname">
<refnamediv>
- <refname>pdf_translate</refname>
- <refpurpose>座標系の原点を設定する</refpurpose>
+ <refname>PDF_get_fontname</refname>
+ <refpurpose>古い関数: フォント処理</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_translate</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- <function>pdf_translate</function> 関数は、座標系の原点を現在の原
- 点に関する相対座標で点
- (<parameter>x-coor</parameter>,<parameter>y-coor</parameter>) に
- 設定します。次の例では、初期座標系において (0, 0) から
(200, 200)
- まで線を描画します。<function>pdf_translate</function> の後でかつ
-
オブジェクトの更なる描画を開始する前にカレントのポイントを設定す
- る必要があります。
- <example>
- <title>変換</title>
- <programlisting role="php">
-<?php pdf_moveto($pdf, 0, 0);
-pdf_lineto($pdf, 100, 100);
-pdf_stroke($pdf);
-pdf_translate($pdf, 100, 100);
-pdf_moveto($pdf, 0, 0);
-pdf_lineto($pdf, 100, 100);
-pdf_stroke($pdf);
-?>
- </programlisting>
- </example>
+ 古い関数です。
+ </para>
+ <para>
+ <function>PDF_get_parameter</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-scale">
+ <refentry id="function.pdf-get-fontsize">
<refnamediv>
- <refname>pdf_scale</refname>
- <refpurpose>スケールを設定する</refpurpose>
+ <refname>PDF_get_fontsize</refname>
+ <refpurpose>古い関数: フォント処理</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_scale</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-scale</parameter></paramdef>
- <paramdef>double <parameter>y-scale</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- <function>pdf_scale</function> 関数は両方向の倍率(スケールファク
- ター)を設定します。以下の例では、x および y
方向のスケールを 72
- 倍にします。続いて描画される線は、両方向に 1
インチの長さとなりま
- す。(訳注:72dpiの場合)
- <example>
- <title>Scaling</title>
- <programlisting role="php">
-<?php pdf_scale($pdf, 72.0, 72.0);
-pdf_lineto($pdf, 1, 1);
-pdf_stroke($pdf);
-?>
- </programlisting>
- </example>
+ 古い関数です。
+ </para>
+ <para>
+ <function>PDF_get_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-rotate">
+ <refentry id="function.pdf-get-image-height">
<refnamediv>
- <refname>pdf_rotate</refname>
- <refpurpose>回転を設定する</refpurpose>
+ <refname>pdf_get_image_height</refname>
+ <refpurpose>古い関数: イメージの高さを返す</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_rotate</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>angle</parameter></paramdef>
+ <funcdef>string <function>pdf_get_image_height</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_rotate</function> 関数は、
- <parameter>angle</parameter> 度の回転を設定します。
+ <function>pdf_get_image_height</function>は、古い関数です。
+ 代わりに<function>PDF_get_value</function>を使用して下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setflat">
+ <refentry id="function.pdf-get-image-width">
<refnamediv>
- <refname>pdf_setflat</refname>
- <refpurpose>平面度を設定する</refpurpose>
+ <refname>pdf_get_image_width</refname>
+ <refpurpose>古い関数: イメージの幅を返す</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setflat</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>value</parameter></paramdef>
+ <funcdef>string <function>pdf_get_image_width</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setflat</function> 関数は、平面度を 0 から 100 の値
- に設定します。
+ <function>pdf_get_image_width</function>は古い関数です。代わりに
+ <function>PDF_get_value</function>を使用して下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setlinejoin">
+ <refentry id="function.pdf-get-parameter">
<refnamediv>
- <refname>pdf_setlinejoin</refname>
- <refpurpose>linejoin パラメータを設定する</refpurpose>
+ <refname>pdf_get_parameter</refname>
+ <refpurpose>パラメータを得る</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setlinejoin</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>long <parameter>value</parameter></paramdef>
+ <funcdef>string <function>pdf_get_parameter</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>double
+ <parameter><optional>modifier</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setlinejoin</function> 関数は、linejoin パラメータを
- 0 から 2 の値に設定します。
+
+いくつかのPDFLIBパラメータの内容を文字列として取得します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setlinecap">
+ <refentry id="function.pdf-get-value">
<refnamediv>
- <refname>pdf_setlinecap</refname>
- <refpurpose>linecap パラメータを設定する</refpurpose>
+ <refname>pdf_get_value</refname>
+ <refpurpose>数値を得る</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setlinecap</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>value</parameter></paramdef>
+ <funcdef>double <function>pdf_get_value</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>double
+ <parameter>
+ <replaceable><optional>modifier</optional></replaceable>
+ </parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setlinecap</function> 関数は、linecap パラメータを
- 0 から 2 の値に設定します。
+ いくつかのPDFLIBパラメータをfloat型で取得します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setmiterlimit">
+ <refentry id="function.pdf-lineto">
<refnamediv>
- <refname>pdf_setmiterlimit</refname>
- <refpurpose>miter リミットを設定する</refpurpose>
+ <refname>pdf_lineto</refname>
+ <refpurpose>線を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setmiterlimit</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>value</parameter></paramdef>
+ <funcdef>void <function>pdf_lineto</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setmiterlimit</function> 関数は、miter リミットを 1
- 以上の値に設定します。
+ カレントの点から座標 (<parameter>x</parameter>,
+<parameter>y</parameter>)
+ まで線を描画します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setlinewidth">
+ <refentry id="function.pdf-moveto">
<refnamediv>
- <refname>pdf_setlinewidth</refname>
- <refpurpose>ライン幅を設定する</refpurpose>
+ <refname>pdf_moveto</refname>
+ <refpurpose>現在の位置を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setlinewidth</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>width</parameter></paramdef>
+ <funcdef>void <function>pdf_moveto</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setlinewidth</function> 関数は、行の幅を
- <parameter>width</parameter> に設定します。
+ カレントの点を設定します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setdash">
+ <refentry id="function.pdf-new">
<refnamediv>
- <refname>pdf_setdash</refname>
- <refpurpose>破線パターンを設定する</refpurpose>
+ <refname>PDF_new</refname>
+ <refpurpose>Creates a new pdf object</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setdash</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>white</parameter></paramdef>
- <paramdef>double <parameter>black</parameter></paramdef>
+ <funcdef>int <function>PDF_new</function></funcdef>
+ <paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setdash</function> 関数は、
- <parameter>white</parameter> 白のポイントおよび
- <parameter>black</parameter>
黒のポイントにより、破線パターンを設
- 定します。両方共 0 の場合、実線が設定されます。
+ Create a new PDF object, using default error handling
+ and memory management.
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-moveto">
+ <refentry id="function.pdf-open">
<refnamediv>
- <refname>pdf_moveto</refname>
- <refpurpose>現在の位置を設定する</refpurpose>
+ <refname>pdf_open</refname>
+ <refpurpose>古い関数: 新規の
+pdfオブジェクトをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_moveto</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
+ <funcdef>int <function>pdf_open</function></funcdef>
+ <paramdef>int <parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ <function>pdf_open</function>関数は、古い関数であるため、
+ <function>PDF_new</function> と
+ <function>PDF_open_file</function>を代わりに使用して下さい。
+ </para>
<para>
- <function>pdf_moveto</function> 関数は、現在位置を
- 座標 (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)
- に設定します。
+ <function>PDF_new</function>,
+ <function>PDF_open_file</function>も参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-curveto">
+
+ <refentry id="function.pdf-open-ccitt">
<refnamediv>
- <refname>pdf_curveto</refname>
- <refpurpose>曲線を描く</refpurpose>
+ <refname>PDF_open_CCITT</refname>
+ <refpurpose>
+ 生のCCITTデータから新規イメージファイルをオープンします
+ </refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_curveto</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x1</parameter></paramdef>
- <paramdef>double <parameter>y1</parameter></paramdef>
- <paramdef>double <parameter>x2</parameter></paramdef>
- <paramdef>double <parameter>y2</parameter></paramdef>
- <paramdef>double <parameter>x3</parameter></paramdef>
- <paramdef>double <parameter>y3</parameter></paramdef>
+ <funcdef>int <function>PDF_open</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
+ <paramdef>int <parameter>width</parameter></paramdef>
+ <paramdef>int <parameter>height</parameter></paramdef>
+ <paramdef>int <parameter>BitReverse</parameter></paramdef>
+ <paramdef>int <parameter>k</parameter></paramdef>
+ <paramdef>int <parameter>Blackls1</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_curveto</function> 関数は、ベジエー曲線を
- 現在の点から点
- (<parameter>x3</parameter>, <parameter>y3</parameter>) まで
- (<parameter>x1</parameter>, <parameter>y1</parameter>) および
- (<parameter>x2</parameter>, <parameter>y2</parameter>) を制御点として
- 描画します。
- </para>
<para>
- <function>pdf_moveto</function>,
- <function>pdf_lineto</function>,
- <function>pdf_stroke</function>
- 参照下さい。
+ 生のCCITTイメージをオープンします。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-lineto">
+ <refentry id="function.pdf-open-file">
<refnamediv>
- <refname>pdf_lineto</refname>
- <refpurpose>線を描く</refpurpose>
+ <refname>PDF_open_file</refname>
+ <refpurpose>新規PDFオブジェクトをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_lineto</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
+ <funcdef>int <function>PDF_open_file</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>filename</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_lineto</function> 関数は、現在の点から
- 座標 (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)
- の点まで線を描画します。
- </para>
<para>
- <function>pdf_moveto</function>,
- <function>pdf_curveto</function>,
- <function>pdf_stroke</function>
- も参照下さい。
+ 新規のPDFファイルを指定したファイル名で作成します。
+ <parameter>filename</parameter> が空の場合、PDFドキュメントはファ
+ イルではなくメモリ上に作成されます。結果は、
+ <function>PDF_get_buffer</function>関数によりクライアント側で取得
+ 可能です。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-circle">
+ <refentry id="function.pdf-open-gif">
<refnamediv>
- <refname>pdf_circle</refname>
- <refpurpose>円を描く</refpurpose>
+ <refname>pdf_open_gif</refname>
+ <refpurpose>古い関数: GIFイメージをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_circle</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>radius</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- <function>pdf_circle</function> 関数は、中心を点
- (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)
- 、半径を <parameter>radius</parameter> とした円を描画します。
+ 古い関数です。
</para>
<para>
- <function>pdf_arc</function>,<function>pdf_stroke</function>
- も参照下さい。
+ <function>PDF_open_image</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-arc">
+ <refentry id="function.pdf-open-image">
<refnamediv>
- <refname>pdf_arc</refname>
- <refpurpose>円弧を描く</refpurpose>
+ <refname>PDF_open_image</refname>
+ <refpurpose>イメージ読み込み関数</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_arc</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>radius</parameter></paramdef>
- <paramdef>double <parameter>start</parameter></paramdef>
- <paramdef>double <parameter>end</parameter></paramdef>
+ <funcdef>int <function>PDF_open_image</function></funcdef>
+ <paramdef>int <parameter>PDF-document</parameter></paramdef>
+ <paramdef>string <parameter>imagetype</parameter></paramdef>
+ <paramdef>string <parameter>source</parameter></paramdef>
+ <paramdef>string <parameter>data</parameter></paramdef>
+ <paramdef>long <parameter>length</parameter></paramdef>
+ <paramdef>int <parameter>width</parameter></paramdef>
+ <paramdef>int <parameter>height</parameter></paramdef>
+ <paramdef>int <parameter>components</parameter></paramdef>
+ <paramdef>int <parameter>bpc</parameter></paramdef>
+ <paramdef>string <parameter>params</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_arc</function> 関数は、中心を点
- (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>)、
- 半径を <parameter>radius</parameter>、開始角を
- <parameter>start</parameter> 、終了角を
- <parameter>end</parameter>とした円弧を描画します。
- </para>
<para>
- <function>pdf_circle</function>,<function>pdf_stroke</function>
- も参照下さい。
+
+複数のデータソースからのイメージデータを使用します。サポートさ
+ れているイメージ型は、"jpeg", "ccitt", "raw"
+です。サポートされて
+ いるソースは、"memory", "fileref", "url" です。len は type="raw"
+ の場合にのみ使用可能です。params は type="ccitt"
+の場合にのみ使用
+ 可能です。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-rect">
+ <refentry id="function.pdf-open-image-file">
<refnamediv>
- <refname>pdf_rect</refname>
- <refpurpose>長方形を描く</refpurpose>
+ <refname>pdf_open_image_file</refname>
+ <refpurpose>ファイルからイメージを読み込む</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_rect</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>width</parameter></paramdef>
- <paramdef>double <parameter>height</parameter></paramdef>
+ <funcdef>int <function>PDF_open_image_file</function></funcdef>
+ <paramdef>int <parameter>PDF-document</parameter></paramdef>
+ <paramdef>string <parameter>imagetype</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>stringparam</optional></parameter>
+ </paramdef>
+ <paramdef>string
+ <parameter><optional>intparam</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_rect</function> 関数は、左下隅を点
- (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) と
- した長方形を描画します。幅を <parameter>width</parameter> に設定
- します。高さを <parameter>height</parameter> に設定します。
+
+イメージファイルをオープンします。サポートされている型は、
+ "jpeg", "tiff", "gif", "png"です。
+ <parameter>stringparam</parameter> は、"", "mask", "masked",
+ "page"のどれかです。<parameter>intparam</parameter> は、0、適用し
+ たマスクまたはページのイメージIDのどれかです。
</para>
- <para>
- <function>pdf_stroke</function> も参照下さい。
- </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-closepath">
+ <refentry id="function.pdf-open-jpeg">
<refnamediv>
- <refname>pdf_closepath</refname>
- <refpurpose>パスを閉じる</refpurpose>
+ <refname>PDF_open_jpeg</refname>
+ <refpurpose>古い関数: JPEGイメージをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_closepath</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
+ <para>
+ 古い関数です。
+ </para>
<para>
- <function>pdf_closepath</function> 関数は、カレントのパスを閉じま
-
す。これはカレントのポイントから最初の線が開始されたポイントに線
- が描かれることを意味します。
- <function>pdf_moveto</function>,
- <function>pdf_circle</function>,<function>pdf_rect</function> の
- ような多くの関数では、新しいパスを開始します。
+ <function>PDF_open_image</function>も参照下さい。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-stroke">
+
+ <refentry id="function.pdf-open-png">
<refnamediv>
- <refname>pdf_stroke</refname>
- <refpurpose>パスに基づいて線を描く</refpurpose>
+ <refname>PDF_open_png</refname>
+ <refpurpose>
+ 古い関数: PNGイメージをオープンする
+ </refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- <function>pdf_stroke</function> 関数は、カレントのパスに沿って線
-
を描画します。カレントのパスは、描画する全ての線を集めたものです。
- この関数を使用しない場合、線は描画されません。
+ 古い関数です。
</para>
<para>
- <function>pdf_closepath</function>,
- <function>pdf_closepath_stroke</function> も参照下さい。
+ <function>PDF_open_image</function>も参照下さい。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-closepath-stroke">
+
+ <refentry id="function.pdf-open-tiff">
<refnamediv>
- <refname>pdf_closepath_stroke</refname>
- <refpurpose>パスを閉じ、パスに基づいて線を出力する</refpurpose>
+ <refname>PDF_open_tiff</refname>
+ <refpurpose>古い関数: TIFFイメージをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_closepath_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>int <function>PDF_open_tiff</function></funcdef>
+ <paramdef>int <parameter>PDF-document</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_closepath_stroke</function> 関数は、
- <function>pdf_closepath</function> および
- <function>pdf_stroke</function> の組み合わせです。また、この関数
- はパスをクリアします。
+ 古い関数です。
</para>
<para>
- <function>pdf_closepath</function>,
- <function>pdf_stroke</function> も参照下さい。
+ <function>PDF_open_image</function>も参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-fill">
+ <refentry id="function.pdf-place-image">
<refnamediv>
- <refname>pdf_fill</refname>
- <refpurpose>カレントのパスに設定する</refpurpose>
+ <refname>pdf_place_image</refname>
+ <refpurpose>イメージをページ上に置く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_fill</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>pdf_place_image</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
+ <paramdef>double <parameter>scale</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_fill</function> 関数は、カレントのパスの内部を
- カレントの塗りつぶし色で塗りつぶします。
- </para>
<para>
- <function>pdf_closepath</function>,
- <function>pdf_stroke</function>,
- <function>pdf_setgray_fill</function>,
- <function>pdf_setgray</function>,
- <function>pdf_setrgbcolor_fill</function>,
- <function>pdf_setrgbcolor</function> も参照下さい。
+ イメージをそのイメージの左下隅を(<parameter>x</parameter>,
+ <parameter>y</parameter>)
+に合わせるように置き、サイズを変更しま
+ す。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-fill-stroke">
+ <refentry id="function.pdf-rect">
<refnamediv>
- <refname>pdf_fill_stroke</refname>
- <refpurpose>カレントのパスを塗りつぶし、パスを描く</refpurpose>
+ <refname>pdf_rect</refname>
+ <refpurpose>長方形を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_fill_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>pdf_rect</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ <paramdef>double <parameter>height</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_fill_stroke</function> 関数は、カレントのパスの内部
-
をカレントの塗りつぶし色で塗りつぶし、カレントのパスを描画します。
- </para>
<para>
- <function>pdf_closepath</function>,
- <function>pdf_stroke</function>,
- <function>pdf_fill</function>,
- <function>pdf_setgray_fill</function>,
- <function>pdf_setgray</function>,
- <function>pdf_setrgbcolor_fill</function>,
- <function>pdf_setrgbcolor</function> も参照下さい。
+ (<parameter>x</parameter>, <parameter>y</parameter>) を左下隅とし、
+ 幅を <parameter>width</parameter>、高さを
+ <parameter>height</parameter>とする長方形を描画します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-closepath-fill-stroke">
+ <refentry id="function.pdf-restore">
<refnamediv>
- <refname>pdf_closepath_fill_stroke</refname>
- <refpurpose>カレントのパスを閉じ、塗りつぶし、描く</refpurpose>
+ <refname>pdf_restore</refname>
+ <refpurpose>以前保存された環境を復元する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_closepath_fill_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>pdf_restore</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_closepath_fill_stroke</function> 関数は、カレントの
-
パスの内部を閉じ、カレントの塗りつぶし色で塗りつぶし、カレントの
- パスを描画します。
- </para>
<para>
- <function>pdf_closepath</function>,
- <function>pdf_stroke</function>,
- <function>pdf_fill</function>,
- <function>pdf_setgray_fill</function>,
- <function>pdf_setgray</function>,
- <function>pdf_setrgbcolor_fill</function>,
- <function>pdf_setrgbcolor</function> も参照下さい。
+ 直近に保存された描画状態を復元します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-endpath">
+ <refentry id="function.pdf-rotate">
<refnamediv>
- <refname>pdf_endpath</refname>
- <refpurpose>カレントのパスを終了する</refpurpose>
+ <refname>pdf_rotate</refname>
+ <refpurpose>回転を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_endpath</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>pdf_rotate</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>phi</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_endpath</function> 関数は、カレントのパスを
- 終了しますが、そのパスを閉じません。
- </para>
<para>
- <function>pdf_closepath</function> も参照下さい。
+ 座表系をphi度回転します。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-clip">
+
+ <refentry id="function.pdf-save">
<refnamediv>
- <refname>pdf_clip</refname>
- <refpurpose>カレントのパスに切り取る</refpurpose>
+ <refname>pdf_save</refname>
+ <refpurpose>現在の環境を保存する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_clip</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>pdf_save</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_clip</function> 関数は、絵全体をカレントのパスに切
- り取ります。
+ カレントの描画状態を保存します。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-setgray-fill">
+
+ <refentry id="function.pdf-scale">
<refnamediv>
- <refname>pdf_setgray_fill</refname>
- <refpurpose>塗りつぶし色をグレー値に設定する</refpurpose>
+ <refname>pdf_scale</refname>
+ <refpurpose>スケールを設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setgray_fill</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>gray value</parameter></paramdef>
- </funcprototype>
+ <funcdef>void <function>pdf_scale</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x-scale</parameter></paramdef>
+ <paramdef>double <parameter>y-scale</parameter></paramdef>
+ </funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setgray_fill</function> 関数は、カレントの
- グレー値をパスを塗りつぶし用に設定します。
+ 座表系のスケールを設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setdash">
+ <refnamediv>
+ <refname>pdf_setdash</refname>
+ <refpurpose>破線パターンを設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>pdf_setdash</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>w</parameter></paramdef>
+ <paramdef>double <parameter>b</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_setrgbcolor_fill</function> も参照下さい。
+
+カレントのダッシュパターンを黒および白単位で設定します。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-setgray-stroke">
+
+ <refentry id="function.pdf-setflat">
<refnamediv>
- <refname>pdf_setgray_stroke</refname>
- <refpurpose>描画色をグレー値に設定する</refpurpose>
+ <refname>pdf_setflat</refname>
+ <refpurpose>平面度を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setgray_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>gray value</parameter></paramdef>
+ <funcdef>void <function>pdf_setflat</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>flatness</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setgray_stroke</function> 関数は、カレントの描画色を
- 指定されたグレー値に設定します。
+ 平面度を 0 から 100 の間の値に設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setfont">
+ <refnamediv>
+ <refname>PDF_setfont</refname>
+ <refpurpose>カレントのフォントを設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_setfont</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>font</parameter></paramdef>
+ <paramdef>double <parameter>size</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_setrgbcolor_stroke</function> も参照下さい。
+ <function>PDF_findfont</function>から返された
+
+<parameter>font</parameter>ハンドルを使用して指定したサイズでカレ
+ ントのフォントを設定します。
</para>
</refsect1>
</refentry>
+
<refentry id="function.pdf-setgray">
<refnamediv>
@@ -1929,728 +1664,725 @@
<funcsynopsis>
<funcprototype>
<funcdef>void <function>pdf_setgray</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>gray value</parameter></paramdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>gray</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setgray</function> 関数は、カレントの描画および塗り
- つぶし色を指定されたグレー値に設定します。
+ カレントの塗りつぶしおよび輪郭描画色を設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setgray-fill">
+ <refnamediv>
+ <refname>pdf_setgray_fill</refname>
+ <refpurpose>塗りつぶし色をグレー値に設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>pdf_setgray_fill</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>gray</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_setrgbcolor_stroke</function>,
- <function>pdf_setrgbcolor_fill</function> も参照下さい。
+
+カレントの塗りつぶし色を0から1までのグレー値に設定します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-setrgbcolor-fill">
+ <refentry id="function.pdf-setgray-stroke">
<refnamediv>
- <refname>pdf_setrgbcolor_fill</refname>
- <refpurpose>塗りつぶし色を RGB カラー値に設定する</refpurpose>
+ <refname>pdf_setgray_stroke</refname>
+ <refpurpose>描画色をグレー値に設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setrgbcolor_fill</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>red value</parameter></paramdef>
- <paramdef>double <parameter>green value</parameter></paramdef>
- <paramdef>double <parameter>blue value</parameter></paramdef>
+ <funcdef>void <function>pdf_setgray_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>gray</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setrgbcolor_fill</function> 関数は、カレントの
- RGB カラー値をパスの塗りつぶし用に設定します。
+
+カレントの輪郭描画色を0から1までのグレー値に設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setlinecap">
+ <refnamediv>
+ <refname>pdf_setlinecap</refname>
+ <refpurpose>linecap パラメータを設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>pdf_setlinecap</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>linecap</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_setrgbcolor_fill</function> も参照下さい。
+ <parameter>linecap</parameter>パラメータを0から2までの値に設定し
+ ます。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-setrgbcolor-stroke">
+
+ <refentry id="function.pdf-setlinejoin">
<refnamediv>
- <refname>pdf_setrgbcolor_stroke</refname>
- <refpurpose>描画色を RGB カラー値に設定する</refpurpose>
+ <refname>PDF_setlinejoin</refname>
+ <refpurpose>linejoinパラメータを設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setrgbcolor_stroke</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>red value</parameter></paramdef>
- <paramdef>double <parameter>green value</parameter></paramdef>
- <paramdef>double <parameter>blue value</parameter></paramdef>
+ <funcdef>void <function>PDF_setlinejoin</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>long <parameter>linejoin</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setrgbcolor_stroke</function> 関数は、カレントの描
- 画色を指定された RGB カラー値に設定します。
+ line joinパラメータを0から2までの値に設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setlinewidth">
+ <refnamediv>
+ <refname>PDF_setlinewidth</refname>
+ <refpurpose>線幅を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_setlinewidth</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_setrgbcolor_stroke</function> も参照下さい。
+ カレントの線幅をwidthに設定します。
</para>
</refsect1>
</refentry>
-
+
+ <refentry id="function.pdf-setmiterlimit">
+ <refnamediv>
+ <refname>PDF_setmiterlimit</refname>
+ <refpurpose>miter limitを設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_setmiterlimit</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>miter</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ miter limitを1以上の値に設定します。
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-setpolydash">
+ <refnamediv>
+ <refname>PDF_setpolydash</refname>
+ <refpurpose>複雑な破線パターンを設定</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_setpolydash</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double *<parameter>dasharray</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ 配列で定義されるより複雑な破線のパターンを設定します。
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-setrgbcolor">
<refnamediv>
- <refname>pdf_setrgbcolor</refname>
- <refpurpose>描画および塗りつぶし色を RGB
カラー値に設定する</refpurpose>
+ <refname>PDF_setrgbcolor</refname>
+
+<refpurpose>描画色および塗りつぶし色をRGBカラー値で設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_setrgbcolor</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
+ <funcdef>void <function>PDF_setrgbcolor</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
<paramdef>double <parameter>red value</parameter></paramdef>
<paramdef>double <parameter>green value</parameter></paramdef>
<paramdef>double <parameter>blue value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_setrgbcolor_stroke</function> 関数は、カレントの描
- 画および塗りつぶし色を指定された RGB
カラー値に設定します。
+
+カレントの塗りつぶし色と輪郭色を指定したRGB値に設定します。
</para>
- <para>
- <function>pdf_setrgbcolor_stroke</function>,
- <function>pdf_setrgbcolor_fill</function> も参照下さい。
- </para>
</refsect1>
</refentry>
- <refentry id="function.pdf-add-outline">
+ <refentry id="function.pdf-setrgbcolor-fill">
<refnamediv>
- <refname>pdf_add_outline</refname>
-
<refpurpose>カレントのページにブックマークを追加する</refpurpose>
+ <refname>PDF_setrgbcolor_fill</refname>
+ <refpurpose>塗りつぶし色をRGBカラー値に設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_add_outline</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>text</parameter></paramdef>
- <paramdef>int
- <parameter>
- <replaceable><optional>parent</optional></replaceable>
- </parameter>
- </paramdef>
- <paramdef>int
- <parameter>
- <replaceable><optional>open</optional></replaceable>
- </parameter>
- </paramdef>
+ <funcdef>void <function>PDF_setrgbcolor_fill</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>red value</parameter></paramdef>
+ <paramdef>double <parameter>green value</parameter></paramdef>
+ <paramdef>double <parameter>blue value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_add_outline</function> 関数は、カレントのページを指
- すテキスト <parameter>text</parameter>
によりブックマークを追加し
-
ます。ブックマークは、<parameter>parent</parameter>の子として挿入
- され、<parameter>open</parameter>が 0 でない場合には、デフォルト
-
でオープンされます。返り値は、ブックマークのIDであり、他のブック
-
マークの親(parent)IDとして使用することが可能です。これにより、ブッ
- クマークの階層構造を構築することが可能です。
- </para>
- <simpara>
- 不幸なことに pdflib は文字列のコピーを作成しないため、PHP
はメモ
- リーを確保しません。現在、このメモリーの部分は、pdf
関数により解
- 放されませんが、PHP
メモリーマネージャーにより監視されています。
- </simpara>
+ カレントの塗りつぶし色を指定したRGB値に設定します。
+ </para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-set-transition">
+
+ <refentry id="function.pdf-setrgbcolor-stroke">
<refnamediv>
- <refname>pdf_set_transition</refname>
- <refpurpose>ページ間の移動を設定する</refpurpose>
+ <refname>PDF_setrgbcolor_stroke</refname>
+ <refpurpose>描画色をRGBカラー値に設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_transition</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>transition</parameter></paramdef>
+ <funcdef>void <function>PDF_setrgbcolor_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>red value</parameter></paramdef>
+ <paramdef>double <parameter>green value</parameter></paramdef>
+ <paramdef>double <parameter>blue value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
- <para>
- <function>pdf_set_transition</function> 関数は、次のようなページ
- 間の移動を設定します。<parameter>transition</parameter> の値は、
- 次のようにすることができます。
- <simplelist>
- <member>
- 0 は何もしない,
- </member>
- <member>
- 1 はページを表示する際に2行ずつスクロールする,
- </member>
- <member>
- 2 はページを表示する際に複数行ずつスクロールする,
- </member>
- <member>
- 3 ページの周りに箱を描く,
- </member>
- <member>
- 4 はページを表示する際に1行ずつスクロールする,
- </member>
- <member>
- 5 はページを描画する際に古Dページを消去する
- </member>
- <member>
- 6
は画面の一つの隅から他の隅に移動するように消すといった効果を用いる
- </member>
- <member>
- 7 は古いページを新しいページで単純に置換する
(デフォルト)
- </member>
- </simplelist>
- </para>
<para>
- <function>pdf_set_duration</function> も参照下さい。
+ カレントの輪郭色を指定したRGB値に設定します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-duration">
+ <refentry id="function.pdf-set-border-color">
<refnamediv>
- <refname>pdf_set_duration</refname>
- <refpurpose>ページ間の持続時間を設定する</refpurpose>
+ <refname>PDF_set_border_color</refname>
+ <refpurpose>リンクや注記の周りの境界色を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_duration</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>duration</parameter></paramdef>
+ <funcdef>void <function>PDF_set_border_color</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>red</parameter></paramdef>
+ <paramdef>double <parameter>green</parameter></paramdef>
+ <paramdef>double <parameter>blue</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_set_duration</function> 関数は、続くページの間の持
- 続時間を秒で設定します。
+ 全ての種類の注記の境界色を設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-border-dash">
+ <refnamediv>
+ <refname>PDF_set_border_dash</refname>
+
+<refpurpose>リンクおよび注記の周りの境界の破線形式を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_set_border_dash</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>black</parameter></paramdef>
+ <paramdef>double <parameter>white</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_set_transition</function> も参照下さい。
+ 全ての種類の注記の境界の破線形式を設定します。
+ <function>PDF_setdash</function>を参照下さい。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-open-gif">
+
+ <refentry id="function.pdf-set-border-style">
<refnamediv>
- <refname>pdf_open_gif</refname>
- <refpurpose>GIF 画像をオープンする</refpurpose>
+ <refname>PDF_set_border_style</refname>
+ <refpurpose>
+ リンクおよび注記の周りの境界の形式を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_open_gif</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>filename</parameter></paramdef>
+ <funcdef>void <function>PDF_set_border_style</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>style</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_open_gif</function> 関数は、
- <parameter>filename</parameter> という名前のファイルに保存された
- 画像をオープンします。画像のフォーマットは gif
である必要がありま
- す。この関数は、pdf 画像 ID を返します。
- <note>
- <simpara>
-
この関数は、もはや使用するべきではありません。代わりに関数
- <function>pdf_open_image_file</function> を使用して下さい。
- </simpara>
- </note>
- <example>
- <title>gif 画像を取り込む</title>
- <programlisting role="php">
-<?php
-$im = pdf_open_gif ($pdf, "test.gif");
-pdf_place_image ($pdf, $im, 100, 100, 1);
-pdf_close_image ($pdf, $im);
-?>
- </programlisting>
- </example>
+ 全ての種類の注記の境界の形式を設定します。
+ <parameter>style</parameter> は、"solid" または "dashed" です。
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-char-spacing">
+ <refnamediv>
+ <refname>PDF_set_char_spacing</refname>
+ <refpurpose>古い関数: 文字間隔を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <para>
+ 古い関数です。
</para>
<para>
- <function>pdf_close_image</function>,
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_memory_image</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function> も参照下さい。
+ <function>PDF_set_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-open-png">
+
+ <refentry id="function.pdf-set-duration">
<refnamediv>
- <refname>pdf_open_png</refname>
- <refpurpose>
- PNGイメージをオープンする
- </refpurpose>
+ <refname>pdf_set_duration</refname>
+ <refpurpose>古い関数: ページ間隔を設定</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>int <function>pdf_open_png</function></funcdef>
- <paramdef>int <parameter>pdf</parameter></paramdef>
- <paramdef>string <parameter>png_file</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <para>
- 関数<function>pdf_open_png</function>は名前が
-
<parameter>filename</parameter>のファイルに保存されたイ?üジをオー
-
プンします。イメージのフォーマットはPNGである必要があります。この
- 関数は、pdfイメージIDを返します。
- <note>
- <simpara>
-
この関数は、もはや使用するべきではありません。代わりに関数
- <function>pdf_open_image_file</function> を使用して下さい。
- </simpara>
- </note>
- <example>
- <title>PNGイメージを読み込む</title>
- <programlisting role="php">
-<?php
-$im = pdf_open_png ($pdf, "test.png");
-pdf_place_image ($pdf, $im, 100, 100, 1);
-pdf_close_image ($pdf, $im);
-?>
- </programlisting>
- </example>
+ <para>
+ 古い関数です。
</para>
<para>
- <function>pdf_close_image</function>,
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_memory_image</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function>も参照下さい。
+ <function>PDF_set_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-open-image-file">
+
+ <refentry id="function.pdf-set-font">
<refnamediv>
- <refname>pdf_open_image_file</refname>
- <refpurpose>ファイルからイメージを読み込む</refpurpose>
+ <refname>PDF_set_font</refname>
+ <refpurpose>古い関数: フォントの形式とサイズを選択</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>int <function>pdf_open_image_file</function></funcdef>
- <paramdef>int <parameter>pdf-document</parameter></paramdef>
- <paramdef>string <parameter>format</parameter></paramdef>
- <paramdef>string <parameter>filename</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
<para>
- 関数<function>pdf_open_image_file</function>は、ファイル
- <parameter>filename</parameter>から<parameter>format</parameter>
-
形式のイメージを読み込みます。使用可能なフォーマットは、'png',
- 'tiff', 'jpeg',
'gif'です。この関数は、pdfイメージIDを返します。
- <example>
- <title>イメージを挿入する</title>
- <programlisting role="php">
-<?php
-$pim = pdf_open_image_file($pdf, "png", "picture.png");
-pdf_place_image($pdf, $pim, 100, 100, 1);
-pdf_close_image($pdf, $pim);
-?>
- </programlisting>
- </example>
+ 古い関数です。<function>PDF_findfont</function> と
+ <function>PDF_setfont</function>
+を代わりに使用する必要があります。
</para>
<para>
- <function>pdf_close_image</function>,
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_tiff</function>,
- <function>pdf_open_png</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function>も参照下さい。
+ <function>PDF_findfont</function>,
+ <function>PDF_setfont</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-open-memory-image">
+ <refentry id="function.pdf-set-horiz-scaling">
<refnamediv>
- <refname>pdf_open_memory_image</refname>
- <refpurpose>
- PHP の画像関数により作成された画像をオープンする
- </refpurpose>
+ <refname>PDF_set_horiz_scaling</refname>
+ <refpurpose>古い関数: テキストの横方向倍率を設定</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_open_memory_image</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
+ <funcdef>void <function>PDF_set_horiz_scaling</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>scale</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_open_memory_image</function>関数は、PHPの画像関数に
-
より作成されたimageを引数としてとり、pdfドキュメントで利用できる
- ようにします。この関数は、pdf画像IDを返します。
- <example>
- <title>メモリー上の画像を取り込む</title>
- <programlisting role="php">
-<?php
-$im = ImageCreate(100, 100);
-$col = ImageColorAllocate($im, 80, 45, 190);
-ImageFill($im, 10, 10, $col);
-$pim = pdf_open_memory_image($pdf, $im);
-ImageDestroy($im);
-pdf_place_image($pdf, $pim, 100, 100, 1);
-pdf_close_image($pdf, $pim);
-?>
- </programlisting>
- </example>
+ 古い関数です。
</para>
<para>
- <function>pdf_close_image</function>,
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_png</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function>も参照下さい。
+ <function>PDF_set_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-open-jpeg">
+ <refentry id="function.pdf-set-info">
<refnamediv>
- <refname>pdf_open_jpeg</refname>
- <refpurpose>JPEG 画像をオープンする</refpurpose>
+ <refname>PDF_set_info</refname>
+ <refpurpose>ドキュメント情報のフィールドを設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_open_jpeg</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>filename</parameter></paramdef>
+ <funcdef>void <function>PDF_set_info</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ ドキュメント情報フィールドkeyにvalueを設定します。
+ <parameter>key</parameter> は、"Subject", "Title", "Creator",
+ "Author", "Keywords",
+またはユーザが定義したキーのどれかです。
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-leading">
+ <refnamediv>
+ <refname>PDF_set_leading</refname>
+ <refpurpose>古い関数: テキストの行間を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
<para>
- <function>pdf_open_jpeg</function>関数は、
- <parameter>filename</parameter>という名前のファイルに保存された
-
イメージをオープンします。画像のフォーマットはJPEGである必要があ
- ります。この関数は、pdfイメージIDを返します。
+ 古い関数です。
</para>
<para>
- <function>pdf_close_image</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_png</function>,
- <function>pdf_open_memory_image</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function>
- も参照下さい。
+ <function>PDF_set_value</function>も参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-open-tiff">
+ <refentry id="function.pdf-set-parameter">
<refnamediv>
- <refname>pdf_open_tiff</refname>
- <refpurpose>TIFFイメージをオープンする</refpurpose>
+ <refname>PDF_set_parameter</refname>
+ <refpurpose>パラメータを設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>int <function>pdf_open_tiff</function></funcdef>
- <paramdef>int <parameter>pdf-document</parameter></paramdef>
- <paramdef>string <parameter>filename</parameter></paramdef>
+ <funcdef>void <function>PDF_set_parameter</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>string <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_open_tiff</function>は、
-
<parameter>filename</parameter>という名前のファイルに保存されたイ
-
メージをオープンします。イメージのフォーマットはTIFFである必要が
- あります。関数は、pdfイメージIDを返します。
- <note>
- <simpara>
-
この関数はもはや使用するべきではありません。代わりに関数
- <function>pdf_open_image_file</function>を使用して下さい。
- </simpara>
- </note>
- </para>
- <para>
- <function>pdf_close_image</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_png</function>,
- <function>pdf_open_memory_image</function>,
- <function>pdf_execute_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_put_image</function>も参照下さい。
+ いくつかのPDFlibパラメータを文字列型で設定します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-close-image">
+ <refentry id="function.pdf-set-text-pos">
<refnamediv>
- <refname>pdf_close_image</refname>
- <refpurpose>画像を閉じる</refpurpose>
+ <refname>PDF_set_text_pos</refname>
+ <refpurpose>テキストの位置を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_close_image</function></funcdef>
- <paramdef>int <parameter>image</parameter></paramdef>
+ <funcdef>void <function>PDF_set_text_pos</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ テキストの出力位置を設定します。
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-text-rendering">
+ <refnamediv>
+ <refname>PDF_set_text_rendering</refname>
+ <refpurpose>古い関数: テキストの描画方法を設定</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
<para>
- <function>pdf_close_image</function>関数は、
- <function>pdf_open_xxx</function>関数のどれかでオープンされた
- 画像を閉じます。
+ 古い関数です。
</para>
<para>
- <function>pdf_open_jpeg</function>,
- <function>pdf_open_gif</function>,
- <function>pdf_open_memory_image</function>
- も参照下さい。
+ <function>PDF_set_value</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-place-image">
+ <refentry id="function.pdf-set-text-rise">
<refnamediv>
- <refname>pdf_place_image</refname>
- <refpurpose>画像をページに置く</refpurpose>
+ <refname>pdf_set_text_rise</refname>
+ <refpurpose>古い関数: テキストの傾きを設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
- <funcsynopsis>
- <funcprototype>
- <funcdef>void <function>pdf_place_image</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>scale</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
+ <para>
+ 古い関数です。
+ </para>
<para>
- <function>pdf_place_image</function> 関数は、
- イメージをそのページの位置 (<parameter>x-coor</parameter>,
- <parameter>y-coor</parameter>) に置きます。
- イメージのサイズを同時に変えることが可能です。
+ <function>PDF_set_value</function>を参照下さい。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-transition">
+ <refnamediv>
+ <refname>pdf_set_text_matrix</refname>
+ <refpurpose>古い関数: テキストのマトリックスを設定</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
<para>
- <function>pdf_put_image</function>も参照下さい。
+ <function>PDF_set_paramter</function>を参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-put-image">
+ <refentry id="function.pdf-set-value">
<refnamediv>
- <refname>pdf_put_image</refname>
-
<refpurpose>後で使用するためにpdfにイメージを保存する</refpurpose>
+ <refname>PDF_set_value</refname>
+ <refpurpose>数値を設定する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_put_image</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
+ <funcdef>void <function>PDF_set_value</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>double <parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_put_image</function>関数は、画像を表示せずにpdfファ
- イルに組み込みます。保存された画像は、
- <function>pdf_execute_image</function> 関数で表示することが可能で
-
す。同じ画像を複数回使用する場合に、ファイルサイズを小さく保つた
-
め便利です。(数kbの)大きな画像を文書の中で複数回表示させる場合に
- は、<function>pdf_put_image</function> および
- <function>pdf_execute_image</function> が強く推奨されます。
- <note>
- <simpara>
- この関数は、pdflib のバージョン 2.01
では意味がなくなりました。
- 警告を発生するだけとなります。
- </simpara>
- </note>
+ PDFlibパラメータの値をfloat型で設定します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-set-word-spacing">
+ <refnamediv>
+ <refname>pdf_set_word_spacing</refname>
+ <refpurpose>古い関数: 単語間の空白を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <para>
+ 古い関数です。
+ </para>
<para>
- <function>pdf_put_image</function>,
- <function>pdf_place_image</function>,
- <function>pdf_execute_image</function>も参照下さい。
+ <function>PDF_set_value</function>も参照下さい。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-execute-image">
+ <refentry id="function.pdf-show">
<refnamediv>
- <refname>pdf_execute_image</refname>
- <refpurpose>保存した画像をページに置く</refpurpose>
+ <refname>PDF_show</refname>
+ <refpurpose>カレントの位置にテキストを出力する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_execute_image</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>int <parameter>image</parameter></paramdef>
- <paramdef>double <parameter>x-coor</parameter></paramdef>
- <paramdef>double <parameter>y-coor</parameter></paramdef>
- <paramdef>double <parameter>scale</parameter></paramdef>
+ <funcdef>void <function>PDF_show</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_execute_image</function>関数は、
- <function>pdf_put_image</function>関数でpdfファイルに保存された画
- 像をカレントのページの指定した座標に表示します。
+
+カレントの位置にカレントのフォントとサイズでテキストを出力します。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-show-boxed">
+ <refnamediv>
+ <refname>PDF_show_boxed</refname>
+ <refpurpose>ボックスにテキストを出力する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>PDF_show_boxed</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
+ <paramdef>double <parameter>left</parameter></paramdef>
+ <paramdef>double <parameter>top</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ <paramdef>double <parameter>height</parameter></paramdef>
+ <paramdef>string <parameter>hmode</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>feature</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- 画像のサイズを表示する際に変えることが可能です。
- 倍率(scale) 1.0 の場合、元のサイズで画像が表示されます。
- <note>
- <simpara>
- この関数は、pdflibのバージョン2.01では意味が
- なくなりました。警告を発生するだけとなります。
- </simpara>
- </note>
- <example>
- <title>1つの画像を複数回表示する</title>
- <programlisting role="php">
-<?php
-$im = ImageCreate(100, 100);
-$col1 = ImageColorAllocate($im, 80, 45, 190);
-ImageFill($im, 10, 10, $col1);
-$pim = pdf_open_memory_image($pdf, $im);
-pdf_put_image($pdf, $pim);
-pdf_execute_image($pdf, $pim, 100, 100, 1);
-pdf_execute_image($pdf, $pim, 200, 200, 2);
-pdf_close_image($pdf, $pim);
-?>
- </programlisting>
- </example>
+
+指定したフォーマットモードに基づき指定したテキストボックスにカレ
+
+ントのフォントとサイズでテキストを出力します。フォーマットモード
+ は、"left", "right", "center", "justify", "fulljustify"のどれかと
+ する必要があります。width および height が
+0の場合、リクエストモー
+ ドの左上の点に最初の行のみが置かれます。
</para>
</refsect1>
</refentry>
-
- <refentry id="function.pdf-add-annotation">
+
+ <refentry id="function.pdf-show-xy">
<refnamediv>
- <refname>pdf_add_annotation</refname>
- <refpurpose>注記を追加する</refpurpose>
+ <refname>PDF_show_xy</refname>
+ <refpurpose>指定した位置にテキストを出力する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_add_annotation</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>llx</parameter></paramdef>
- <paramdef>double <parameter>lly</parameter></paramdef>
- <paramdef>double <parameter>urx</parameter></paramdef>
- <paramdef>double <parameter>ury</parameter></paramdef>
- <paramdef>string <parameter>title</parameter></paramdef>
- <paramdef>string <parameter>content</parameter></paramdef>
+ <funcdef>void <function>PDF_show_xy</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>pdf_add_annotation</function> は、左下隅を
- (<parameter>llx</parameter>,
- <parameter>lly</parameter>) 、右上隅を
- (<parameter>urx</parameter>, <parameter>ury</parameter>)
- とする注記を追加します。
+ (x, y)にカレントのフォントでテキストを出力します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-border-style">
+ <refentry id="function.pdf-skew">
<refnamediv>
- <refname>pdf_set_border_style</refname>
-
<refpurpose>リンクおよび注記の周囲の境界のスタイルを設定する</refpurpose>
+ <refname>PDF_skew</refname>
+ <refpurpose>座標系を歪ませる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_border_style</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>string <parameter>style</parameter></paramdef>
- <paramdef>double <parameter>width</parameter></paramdef>
+ <funcdef>void <function>PDF_skew</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>alpha</parameter></paramdef>
+ <paramdef>double <parameter>beta</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_set_border_style</function>は、リンクおよび注記
- を囲む箱のスタイルと幅を設定します。パラメータ
- <parameter>style</parameter>は 'solid'または'dashed'を指定するこ
- とができます。
+ 座標系をxおよびy方向にそれぞれalpha度、beta度歪ませます。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-stringwidth">
+ <refnamediv>
+ <refname>PDF_stringwidth</refname>
+
+<refpurpose>カレントフォントを用いた際のテキスト幅を返す</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>double <function>PDF_stringwidth</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>text</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>text</optional></parameter>
+ </paramdef>
+ <paramdef>string
+ <parameter><optional>text</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_set_border_color</function>、
- <function>pdf_set_border_dash</function>も参照下さい。
+ 任意のフォントでテキストの幅を返します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-border-color">
+ <refentry id="function.pdf-stroke">
<refnamediv>
- <refname>pdf_set_border_color</refname>
-
<refpurpose>リンクおよび注記の周囲の境界の色を設定する</refpurpose>
+ <refname>PDF_stroke</refname>
+ <refpurpose>パスに沿って線を描く</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_border_color</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>red</parameter></paramdef>
- <paramdef>double <parameter>green</parameter></paramdef>
- <paramdef>double <parameter>blue</parameter></paramdef>
+ <funcdef>void <function>PDF_stroke</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_set_border_color</function>はリンクおよび注記の
-
周囲の箱の色を設定します。色の3種類の要素には、0.0から1.0の間の
- 値を指定します。
+
+カレントの色および線幅で、パスの輪郭を描画し、パスをクリアします。
</para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-translate">
+ <refnamediv>
+ <refname>PDF_translate</refname>
+ <refpurpose>座標系の原点を設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_translate</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>tx</parameter></paramdef>
+ <paramdef>double <parameter>ty</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
<para>
- <function>pdf_set_border_style</function>、
- <function>pdf_set_border_dash</function>も参照下さい。
+ 座標系の原点を変更します。
</para>
</refsect1>
</refentry>
- <refentry id="function.pdf-set-border-dash">
+ <refentry id="function.pdf-open-memory-image">
<refnamediv>
- <refname>pdf_set_border_dash</refname>
+ <refname>PDF_open_memory_image</refname>
<refpurpose>
-
リンクおよび注記の周囲の境界のダッシュのスタイルを設定する
+ PHPのイメージ関数で作成されたイメージをオープンする
</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>pdf_set_border_dash</function></funcdef>
- <paramdef>int <parameter>pdf document</parameter></paramdef>
- <paramdef>double <parameter>black</parameter></paramdef>
- <paramdef>double <parameter>white</parameter></paramdef>
+ <funcdef>int <function>PDF_open_memory_image</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- 関数<function>pdf_set_border_dash</function>は、リンクおよび注記の
- 周囲の箱の破線において黒と白の部分の長さを設定します。
+ 関数<function>PDF_open_memory_image</function>は、PHPのイメージ関
+
+数で作成されたイメージを入力とし、PDFオブジェクトで利用可能としま
+ す。関数は、PDFのイメージIDを返します。
+ <example>
+ <title>メモリイメージの読み込み</title>
+ <programlisting role="php">
+<?php
+$im = ImageCreate(100, 100);
+$col = ImageColorAllocate($im, 80, 45, 190);
+ImageFill($im, 10, 10, $col);
+$pim = PDF_open_memory_image($pdf, $im);
+ImageDestroy($im);
+PDF_place_image($pdf, $pim, 100, 100, 1);
+PDF_close_image($pdf, $pim);
+?>
+ </programlisting>
+ </example>
</para>
<para>
- <function>pdf_set_border_style</function>、
- <function>pdf_set_border_color</function>も参照下さい。
+ <function>PDF_close_image</function>,
+ <function>PDF_place_image</function>も参照下さい。
</para>
</refsect1>
</refentry>
Index: phpdoc/ja/functions/yaz.xml
diff -u phpdoc/ja/functions/yaz.xml:1.3 phpdoc/ja/functions/yaz.xml:1.4
--- phpdoc/ja/functions/yaz.xml:1.3 Sat Feb 3 17:05:22 2001
+++ phpdoc/ja/functions/yaz.xml Sun Feb 18 15:29:44 2001
@@ -9,8 +9,8 @@
この拡張モジュールは、情報取得用のZ39.50プロトコルを実装する
<productname>YAZ</productname>ツールキットへのPHPインターフェース
を提供するものです。この拡張モジュールにより、Z39.50ターゲット(サー
-
バー)を並列に検索するZ39.50オリジン(クライアント)を容易に実装する
- ことが可能になります。
+
+バー)を並列に検索またはスキャンするZ39.50オリジン(クライアント)を
+ 容易に実装することが可能になります。
</para>
<para>
<productname>YAZ</productname> は、<ulink
@@ -67,7 +67,13 @@
</para>
<para>
<example>
- <title><function>YAZ</function></title>
+ <title>YAZによる並列検索</title>
+ <simpara>
+
+以下のスクリプトは、APIの並列検索機能のデモです。引数を指定せず
+
+にコールした場合、この関数は、クエリフォームを出力します。そう
+
+でない場合(引数を指定した場合)は、配列hostにあるターゲットを検
+ 索します。
+ </simpara>
<programlisting role="php">
$num_hosts = count ($host);
if (empty($term) || count($host) == 0) {
@@ -155,8 +161,9 @@
</funcprototype>
</funcsynopsis>
<para>
-
ターゲットとの接続をクローズします。この後、アプリケーションは、
-
指定したidを有するターゲットを参照することはできません。
+ <parameter>id</parameter>で指定したZ接続(Z-association)をクローズ
+ します。<parameter>id</parameter> は、コマンド
+ <function>yaz_connect</function> の返り値であるターゲットIDです。
</para>
</refsect1>
</refentry>
@@ -165,7 +172,7 @@
<refnamediv>
<refname>yaz_connect</refname>
<refpurpose>
- 成功時に正の接続ID、失敗した場合にゼロを返す
+ ターゲットへの接続およびZ接続を準備する。
</refpurpose>
</refnamediv>
<refsect1>
@@ -174,6 +181,9 @@
<funcprototype>
<funcdef>int <function>yaz_connect</function></funcdef>
<paramdef>string <parameter>zurl</parameter></paramdef>
+ <paramdef>string
+ <parameter><optional>authentication</optional></parameter>
+ </paramdef>
</funcprototype>
</funcsynopsis>
<para>
@@ -277,9 +287,11 @@
</funcprototype>
</funcsynopsis>
<para>
- この関数は、<function>yaz_search</function> と共に使用され、取得
-
するレコードの要素集合の名前を指定します。多くのサーバは、F
(完全)
- および B (短縮) をサポートします。
+ この関数は、<function>yaz_search</function> および
+ <function>yaz_present</function>と共に使用され、取得するレコード
+ の要素集合の名前を指定します。多くのサーバは、
+ <literal>F</literal> (完全版)および<literal>B</literal> (短縮版)
+ の名前をサポートします。
</para>
<para>
成功時にtrue、エラー時にfalseを返します。
@@ -465,11 +477,34 @@
</refsect1>
</refentry>
+ <refentry id="function.yaz-present">
+ <refnamediv>
+ <refname>yaz_present</refname>
+ <refpurpose>
+ (Z39.50による)取得の準備を行う
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_present</function></funcdef>
+ <void></void>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+
+この関数は、検索に成功した後、レコードを取得するための準備を行い
+
+ます。この関数をコールする前に取得するレコードの範囲を指定するた
+
+めに<function>yaz_range</function>をコールしておく必要があります。
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.yaz-syntax">
<refnamediv>
<refname>yaz_syntax</refname>
<refpurpose>
-
取得時のレコード構文に関してオブジェクトID(OID)を指定する
+ 取得用に適当なレコード構文を指定する
</refpurpose>
</refnamediv>
<refsect1>
@@ -483,34 +518,355 @@
</funcsynopsis>
<para>
syntaxには、(<literal>1.2.840.10003.5.10</literal>のような)ドット
- 表記または既知のレコード構文の一つ(sutrs, usmarc, grs1, xml,
等)
- を指定します。この関数は<function>yaz_search</function> と共に使
- 用され、取得時のレコード構文を指定します。
+ 表記のOIDまたは既知の登録されたレコード構文の一つ(sutrs,
+usmarc,
+ grs1, xml,等)を指定します。この関数は
+ <function>yaz_search</function> および
+ <function>yaz_present</function>と共に使用され、取得時のレコード
+ 構文を指定します。
</para>
</refsect1>
</refentry>
+ <refentry id="function.yaz-scan">
+ <refnamediv>
+ <refname>yaz_scan</refname>
+ <refpurpose>スキャンの準備をする</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_scan</function></funcdef>
+ <paramdef>int <parameter>id</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ <paramdef>string <parameter>startterm</parameter></paramdef>
+ <paramdef>array
+ <parameter><optional>flags</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ この関数は、Z39.50スキャンリクエストの準備をします。引数
+ <parameter>id</parameter>
+はターゲットIDです。スキャンを開始する
+ 言葉の場所は、<parameter>startterm</parameter>で指定します。
+
+開始語を指定する形式は、<parameter>type</parameter>で指定します。
+ 現在、<literal>rpn</literal>型がサポートされています。
+
+オプションの<parameter>flags</parameter>によりスキャンリクエスト
+
+の動作を制御する追加情報を指定します。現在、次の3つの添字が、現在、
+ flagsから読み込まれます。
+ <literal>number</literal> (リクエストされた語の数)、
+ <literal>position</literal> (要求された語の位置)、
+ <literal>stepSize</literal> (要求されたステップ数)。
+
+実際にスキャンリクエストをターゲットに送信し、スキャンレスポンス
+
+を受信する際には、<function>yaz_wait</function>をコールする必要が
+
+あります。<function>yaz_wait</function>が完了した後、応答を処理す
+ るために、<function>yaz_error</function> および
+ <function>yaz_scan_result</function>をコールします。
+ </para>
+ <para>
+ <parameter>startterm</parameter>の構文は、
+ <function>yaz_search</function>で説明いたRPNクエリに似ています。
+ starttermは、ゼロ以上の<literal>@attr</literal>演算子の後にトーク
+ ンが一つだけ続く形式となります。
+ </para>
+ <para>
+ <example>
+ <title>タイトルをスキャンするPHP関数</title>
+ <programlisting>
+ function scan_titles($id, $starterm) {
+ yaz_scan($id,"rpn", "@attr 1=4 " . $starterm);
+ yaz_wait();
+ $errno = yaz_errno($id);
+ if ($errno == 0) {
+ $ar = yaz_scan_result($id,&$options);
+ echo 'Scan ok; ';
+ $ar = yaz_scan_result($id, &$options);
+ while(list($key,$val)=each($options)) {
+ echo "$key = $val ";
+ }
+ echo '<br><table><tr><td>';
+ while(list($key,list($k, $term, $tcount))=each($ar)) {
+ if (empty($k)) continue;
+ echo "<tr><td>$term</td><td>";
+ echo $tcount;
+ echo "</td></tr>";
+ }
+ echo '</table>';
+ } else {
+ echo "Scan failed. Error: " . yaz_error($id) . "<br>";
+ }
+ }
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.yaz-scan-result">
+ <refnamediv>
+ <refname>yaz_scan_result</refname>
+ <refpurpose>スキャンリクエストの結果を返す</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>array <function>yaz_scan_result</function></funcdef>
+ <paramdef>int <parameter>id</parameter></paramdef>
+ <paramdef>array &
+ <parameter><optional>result</optional></parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Given a target ID this function returns and array with terms as received
+ from the target in the last Scan Response.
+ This function returns an array (0..n-1) where n is the number
+ of terms returned. Each value is a pair where first item is
+ term, second item is result-count.
+ If the <parameter>result</parameter> is given it will be modified to hold
+ additional information taken from the Scan Response:
+ <literal>number</literal> (number of entries returned),
+ <literal>stepsize</literal> (Step-size),
+ <literal>position</literal> (position of term),
+ <literal>status</literal> (Scan Status).
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.yaz-ccl-conf">
+ <refnamediv>
+ <refname>yaz_ccl_conf</refname>
+ <refpurpose>CCLパーサを設定する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_ccl_conf</function></funcdef>
+ <paramdef>int <parameter>id</parameter></paramdef>
+ <paramdef>array <parameter>config</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ This function configures the CCL query parser for a target
+ with definitions of access points (CCL qualifiers) and their
+ mapping to RPN. To map a specific CCL query to RPN afterwards
+ call the <function>yaz_ccl_parse</function> function.
+ Each index of the array <parameter>config</parameter> is the
+ name of a CCL field and the corresponding value holds a string
+ that specifies a mapping to RPN.
+ The mapping is a sequence of attribute-type, attribute-value
+ pairs. Attribute-type and attribute-value is separated by an equal
+ sign (<literal>=</literal>). Each pair is separated by white space.
+ </para>
+ <para>
+ <example>
+ <title>CCL configuration</title>
+ <simpara>
+ In the example below, the CCL parser is configured to support
+ three CCL fields: <literal>ti</literal>, <literal>au</literal> and
+ <literal>isbn</literal>. Each field is mapped to their BIB-1
+ equivalent. It is assumed that variable <literal>$id</literal> is a
+ target ID.
+ </simpara>
+ <programlisting>
+ $field["ti"] = "1=4";
+ $field["au"] = "1=1";
+ $field["isbn"] = "1=7";
+ yaz_ccl_conf($id,$field);
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.yaz-ccl-parse">
+ <refnamediv>
+ <refname>yaz_ccl_parse</refname>
+ <refpurpose>CCLパーサを起動する</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_ccl_parse</function></funcdef>
+ <paramdef>int <parameter>id</parameter></paramdef>
+ <paramdef>string <parameter>query</parameter></paramdef>
+ <paramdef>array &<parameter>result</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ この関数は、CCLパーサを起動します。
+ This function invokes the CCL parser. It converts a given
+ CCL FIND query to an RPN query which may be passed to the
+ <function>yaz_search</function> function to perform a search.
+ To define a set of valid CCL fields call
+ <function>yaz_ccl_conf</function> prior to this function.
+ If the supplied <parameter>query</parameter> was successfully
+ converted to RPN, this function returns true, and the index
+ <literal>rpn</literal> of the supplied array
+ <parameter>result</parameter> holds a valid RPN query.
+ If the query could not be converted (because of invalid syntax,
+ unknown field, etc.) this function returns false and three
+ indexes are set in the resulting array to indicate the cause
+ of failure: <literal>errorcode</literal>CCL error code (integer),
+ <literal>errorstring</literal>CCL error string, and
+ <literal>errorpos</literal>approximate position in query of failure
+ (integer is character position).
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.yaz-itemorder">
+ <refnamediv>
+ <refname>yaz_itemorder</refname>
+ <refpurpose>
+ ILLリクエストパッケージを関してZ39.50 Item Orderを準備する
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>説明</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>yaz_itemorder</function></funcdef>
+ <paramdef>array <parameter>args</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ この関数は、Transport ILL (Profile/1)へのZ39.50 Item Order
+ Extended Service用のプロファイルを使用するExtended Servicesリクエ
+ ストを準備します。
+ <ulink url="http://www.nlc-bnc.ca/iso/ill/stanprf.htm">このページ
+ </ulink>および
+ <ulink url="http://www.nlc-bnc.ca/iso/ill/document/standard/z-ill-1a.pdf">
+ 仕様</ulink>を参照下さい。パラメータargsは、送信するItem
+Orderリ
+
+クエストに関する情報を有するハッシュ配列とする必要があります。こ
+
+のハッシュ配列のキーは、対応するASN.1タグのパス名です。例えば、
+ Item-ID以下にISBNがある場合のキーはitem-id,ISBNとなります。
+ </para>
+ <para>
+ ILL-Request パラメータは次のようになります。
+ </para>
+ <literallayout>
+protocol-version-num
+transaction-id,initial-requester-id,person-or-institution-symbol,person
+transaction-id,initial-requester-id,person-or-institution-symbol,institution
+transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person
+transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution
+transaction-id,transaction-group-qualifier
+transaction-id,transaction-qualifier
+transaction-id,sub-transaction-qualifier
+service-date-time,this,date
+service-date-time,this,time
+service-date-time,original,date
+service-date-time,original,time
+requester-id,person-or-institution-symbol,person
+requester-id,person-or-institution-symbol,institution
+requester-id,name-of-person-or-institution,name-of-person
+requester-id,name-of-person-or-institution,name-of-institution
+responder-id,person-or-institution-symbol,person
+responder-id,person-or-institution-symbol,institution
+responder-id,name-of-person-or-institution,name-of-person
+responder-id,name-of-person-or-institution,name-of-institution
+transaction-type
+delivery-address,postal-address,name-of-person-or-institution,name-of-person
+delivery-address,postal-address,name-of-person-or-institution,name-of-institution
+delivery-address,postal-address,extended-postal-delivery-address
+delivery-address,postal-address,street-and-number
+delivery-address,postal-address,post-office-box
+delivery-address,postal-address,city
+delivery-address,postal-address,region
+delivery-address,postal-address,country
+delivery-address,postal-address,postal-code
+delivery-address,electronic-address,telecom-service-identifier
+delivery-address,electronic-address,telecom-service-addreess
+billing-address,postal-address,name-of-person-or-institution,name-of-person
+billing-address,postal-address,name-of-person-or-institution,name-of-institution
+billing-address,postal-address,extended-postal-delivery-address
+billing-address,postal-address,street-and-number
+billing-address,postal-address,post-office-box
+billing-address,postal-address,city
+billing-address,postal-address,region
+billing-address,postal-address,country
+billing-address,postal-address,postal-code
+billing-address,electronic-address,telecom-service-identifier
+billing-address,electronic-address,telecom-service-addreess
+ill-service-type
+requester-optional-messages,can-send-RECEIVED
+requester-optional-messages,can-send-RETURNED
+requester-optional-messages,requester-SHIPPED
+requester-optional-messages,requester-CHECKED-IN
+search-type,level-of-service
+search-type,need-before-date
+search-type,expiry-date
+search-type,expiry-flag
+place-on-hold
+client-id,client-name
+client-id,client-status
+client-id,client-identifier
+item-id,item-type
+item-id,call-number
+item-id,author
+item-id,title
+item-id,sub-title
+item-id,sponsoring-body
+item-id,place-of-publication
+item-id,publisher
+item-id,series-title-number
+item-id,volume-issue
+item-id,edition
+item-id,publication-date
+item-id,publication-date-of-component
+item-id,author-of-article
+item-id,title-of-article
+item-id,pagination
+item-id,ISBN
+item-id,ISSN
+item-id,additional-no-letters
+item-id,verification-reference-source
+copyright-complicance
+retry-flag
+forward-flag
+requester-note
+forward-note
+ </literallayout>
+ <para>
+ Extended Services RequestパッケージおよびItemOrderパッケージにも
+ 次のような小数のパラメータがあります。
+ </para>
+ <literallayout>
+package-name
+user-id
+contact-name
+contact-phone
+contact-email
+itemorder-item
+ </literallayout>
+ </refsect1>
+ </refentry>
+
<refentry id="function.yaz-wait">
<refnamediv>
<refname>yaz_wait</refname>
- <refpurpose>クエリを実行する</refpurpose>
+ <refpurpose>Z39.50リクエストが完了するまで待つ</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>yaz_wait</function></funcdef>
- <paramdef>int <parameter>id</parameter></paramdef>
- <paramdef>string <parameter>syntax</parameter></paramdef>
+ <void></void>
</funcprototype>
</funcsynopsis>
<para>
この関数は、関数<function>yaz_connect</function>、
-
<function>yaz_search</function>により準備された発行済のリクエスト
- をネットワーク経由で(ブロックモードで)伝送します。
-
<function>yaz_wait</function>は、全てのターゲットが全てのリクエス
-
トを完了したか、(エラーの場合には)その他のリクエストが完了した場
- 合に戻ります。
+ <function>yaz_search</function>、<function>yaz_present</function>,
+ <function>yaz_scan</function>、<function>yaz_itemorder</function>
+
+により準備された発行済のリクエストをネットワーク経由で(ブロックモー
+ ドで)伝送します。<function>yaz_wait</function>は、全てのターゲッ
+
+トが全てのリクエストを完了したか、(エラーの場合には)中断された場
+ 合に処理を戻します。
</para>
</refsect1>
</refentry>
Index: phpdoc/ja/functions/bzip2.xml
+++ phpdoc/ja/functions/bzip2.xml
<reference id="ref.bzip2">
<title>Bzip2 圧縮関数</title>
<titleabbrev>Bzip2</titleabbrev>
<partintro>
<para>
このモジュールは、Julian Seward
により作成されたbzip2(.bz2)圧縮さ
れたファイルを透過的に読み書きするための<ulink
url="&url.bzip2;">bzip2</ulink>ライブラリの関数を使用しています。
</para>
<para>
PHPにおけるbzip2サポートはデフォルトで有効になっていません。PHPで
bzip2サポートを有効にするには、PHPのコンパイル時に設定オプションに
<parameter>--with-bz2[=DIR]</parameter>を使用する必要があります。
このモジュールは、bzip2/libbzip2 version >= 1.0.x を必要としま
す。
</para>
<sect1 id="bzip2-example">
<title>簡単なコードの例</title>
<para>
この例は、テンポラリファイルをオープンし、テスト用の文字列を書き
込みます。この後、このファイルの内容を出力します。
</para>
<example>
<title>簡単な bzip2 の例</title>
<programlisting role="php">
<?php
$filename = "/tmp/testfile.bz2";
$str = "This is a test string.\n";
// 書き込み用にオープン
$bz = bzopen($filename, "w");
// ファイルに文字列を書き込む
bzwrite($bz, $str);
// ファイルを閉じる
bzclose($bz);
// 読み込み用にファイルをオープン
$bz = bzopen($filename, "r");
// 10文字読み込む
print bzread($bz, 10);
// ファイルの終端まで出力(または次の1024文字)し、閉じる
print bzread($bz);
bzclose($bz);
?>
</programlisting>
</example>
</sect1>
</partintro>
<refentry id="function.bzclose">
<refnamediv>
<refname>bzclose</refname>
<refpurpose>bzip2ファイルポインタを閉じる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>bzclose</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
ポインタ<parameter>bz</parameter>で参照されるbzip2ファイルを閉じ
ます。
</para>
<para>
成功時にtrue、失敗時にfalseを返します。
</para>
<para>
ファイルポインタは有効である必要があり、
<function>bzopen</function>によりオープンされたファイルを指してい
る必要があります。
</para>
<para>
<function>bzopen</function>も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzcompress">
<refnamediv>
<refname>bzcompress</refname>
<refpurpose>文字列をbzip2形式のデータに圧縮する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>bzcompress</function></funcdef>
<paramdef>string <parameter>source</parameter></paramdef>
<paramdef>int
<parameter><optional>blocksize</optional></parameter>
</paramdef>
<paramdef>int
<parameter><optional>workfactor</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>bzcompress</function> は、文字列
<parameter>source</parameter> を圧縮し、bzip2形式のデータとして返
します。
</para>
<para>
オプションのパラメータ<parameter>blocksize</parameter>は、圧縮時
のブロック長を指定し、1から9の数とする必要があります。この場合、9
の圧縮度が最大ですが、リソースの消費量も最大となります。
<parameter>blocksize</parameter> は、デフォルトで4になっています。
</para>
<para>
オプションのパラメータ<parameter>workfactor</parameter>は、
繰り返しが多い、最悪の入力データの場合の圧縮処理の動作を制御しま
す。この値は、0から250までとなり、0は特別な場合、30はデフォルト値
となります。<parameter>workfactor</parameter> によらず圧縮された
データは同じになります。
</para>
<para>
<example>
<title><function>bzcompress</function> の例</title>
<programlisting role="php">
$str = "sample data";
$bzstr = bzcompress($str, 9);
</programlisting>
</example>
</para>
<para>
<function>bzdecompress</function>も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzdecompress">
<refnamediv>
<refname>bzdecompress</refname>
<refpurpose>bzip2形式のデータを解凍する</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>bzdecompress</function></funcdef>
<paramdef>string <parameter>source</parameter></paramdef>
<paramdef>int
<parameter><optional>small</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>bzdecompress</function> は、bzip2形式のデータの文字列
<parameter>source</parameter> を解凍し、返します。オプションのパ
ラメータ<parameter>small</parameter> がtrueの場合、よりメモリの消
費量が少ない(所要メモリは最大2300K程度まで少なくなります)別の圧縮
アルゴリズムが使用されますが、速度は約半分になってしまいます。
この機能に関する詳細については、<ulink url="&url.bzip2;">bzip2
ドキュメント</ulink> を参照下さい。
</para>
<para>
<example>
<title><function>bzdecompress</function></title>
<programlisting role="php">
$str = $bzdecompress($bzstr);
</programlisting>
</example>
</para>
<para>
<function>bzcompress</function>も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzerrno">
<refnamediv>
<refname>bzerrno</refname>
<refpurpose>bzip2エラー番号を返す</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>bzerrno</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
ファイルポインタ<parameter>bz</parameter>から返されたbzip2エラー
のエラー番号を返します。
</para>
<para>
<function>bzerror</function> および <function>bzerrstr</function>
も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzerror">
<refnamediv>
<refname>bzerror</refname>
<refpurpose>bzip2エラー番号とエラー文字列を配列で返す</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>array <function>bzerror</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
ファイルポインタ<parameter>bz</parameter>から返されたbzip2エラー
のエラー番号とエラー文字列を連想配列として返します。
</para>
<para>
<example>
<title><function>bzerror</function>の例</title>
<programlisting role="php">
$error = bzerror($bz);
echo $error["errno"];
echo $error["errstr"];
</programlisting>
</example>
</para>
<para>
<function>bzerrno</function> および <function>bzerrstr</function>
も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzerrstr">
<refnamediv>
<refname>bzerrstr</refname>
<refpurpose>bzip2エラー文字列を返す</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>bzerrstr</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
ファイルポインタ<parameter>bz</parameter>から返されたbzip2エラー
のエラーの文字列を返します。
</para>
<para>
<function>bzerrno</function> および<function>bzerror</function>も
参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzflush">
<refnamediv>
<refname>bzflush</refname>
<refpurpose>
全てのバッファリングされたデータを強制的に書き込む
</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>bzflush</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
バッファリングされた全てのbzip2データを<parameter>bz</parameter>
が指すファイルポインタに書き込みます。
</para>
<para>
成功時のtrue、失敗した際にfalseを返します。
</para>
<para>
<function>bzread</function> および <function>bzwrite</function>も
参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzopen">
<refnamediv>
<refname>bzopen</refname>
<refpurpose>bzip2圧縮されたファイルをオープンする</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>bzopen</function></funcdef>
<paramdef>string <parameter>filename</parameter></paramdef>
<paramdef>string <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
bzip2 (.bz2) ファイルを読み書き用にオープンします。
<parameter>filename</parameter> は、オープンするファイルの名前で
す。<parameter>mode</parameter> は、
<function>fopen</function> 関数 (読み込みは`r'、書き込みは`w'、等)
に似ています。
</para>
<para>
オープンできなかった場合、この関数はfalseを返します。それ以外の場
合は、新規にオープンされたファイルへのポインタが返されます。
</para>
<para>
<example>
<title><function>bzopen</function> の例</title>
<programlisting role="php">
$bz = bzopen("/tmp/foo.bz2", "r");
</programlisting>
</example>
</para>
<para>
<function>bzclose</function>も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzread">
<refnamediv>
<refname>bzread</refname>
<refpurpose>バイナリ対応のbzip2ファイル読み込み</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>bzread</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
<paramdef>int
<parameter><optional>length</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>bzread</function> は、<parameter>bz</parameter>が指す
bzip2ファイルポインタから最大<parameter>length</parameter>バイト
読み込みます。読み込みは、(圧縮前の状態で)
<parameter>length</parameter>バイトが読み込まれたか、EOFに達した
かのどちらか最初に来た方で終了します。オプションのパラメータ
<parameter>length</parameter>が指定されない場合、
<function>bzread</function>は一度に(圧縮前の状態で)1024バイト読み
込みます。
</para>
<para>
<example>
<title><function>bzread</function> の例</title>
<programlisting role="php">
$bz = bzopen("/tmp/foo.bz2", "r");
$str = bzread($bz, 2048);
echo $str;
</programlisting>
</example>
</para>
<para>
<function>bzwrite</function> と <function>bzopen</function>も参照
下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.bzwrite">
<refnamediv>
<refname>bzread</refname>
<refpurpose>バイナリ対応のbzip2ファイルへの書き込み</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>int <function>bzwrite</function></funcdef>
<paramdef>int <parameter>bz</parameter></paramdef>
<paramdef>string <parameter>data</parameter></paramdef>
<paramdef>int
<parameter><optional>length</optional></parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>bzwrite</function> は、文字列
<parameter>data</parameter>の中身を
<parameter>bz</parameter>が指すbzip2ファイルストリームに書き込み
ます。オプションの引数<parameter>length</parameter>を指定した場合、
(圧縮前の)lengthバイト分の書き込みが終ったか、文字列の終端に達し
たかで書き込みは終了します。
</para>
<para>
<example>
<title><function>bzwrite</function> の例</title>
<programlisting role="php">
$str = "uncompressed data";
$bz = bzopen("/tmp/foo.bz2", "w");
bzwrite($bz, $str, strlen($str));
</programlisting>
</example>
</para>
<para>
<function>bzread</function>および<function>bzopen</function>も参
照下さい。
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Index: phpdoc/ja/functions/ctype.xml
+++ phpdoc/ja/functions/ctype.xml
<reference id="ref.ctype">
<title>文字型関数</title>
<titleabbrev>ctype</titleabbrev>
<partintro>
<para>
以下の関数は、現在のロケールに基づき文字または文字列がある文字クラ
スに含まれるかどうかを調べます。
</para>
<para>
整数の引数を指定してコールした場合、これらの関数は、Cの同名の関数
と全く同様に動作します。
</para>
<para>
文字列引数を指定してコールした場合、これらの関数は、その文字列の全
ての文字を調べ、その文字列の全ての文字が要求された基準に一致する場
合にのみtrueを返します。
</para>
<para>
文字列または整数以外のものを指定した場合は、直ちにfalsewが返されま
す。
</para>
<warning>
<simpara>
これらの関数は、PHP 4.0.4
で新規にサポートされたもので、近い将来
に名前が変更される可能性があります。
<function>ctype_somthing</function>の
<function>ctype_issomething</function>への変更、
<filename>ext/standard</filename>の部分に統合することが提案されて
います。また、元のC関数の名前を使用することも提案されていますが、
<function>isset</function>と<function>is_sometype</function>の問
題を見ると、更に混乱する可能性もあります。
</simpara>
</warning>
</partintro>
<refentry id="function.ctype-alnum">
<refnamediv>
<refname>ctype_alnum</refname>
<refpurpose>英数字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_alnum</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>setlocale</function>も参照下さい。
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-alpha">
<refnamediv>
<refname>ctype_alpha</refname>
<refpurpose>英字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_alpha</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-cntrl">
<refnamediv>
<refname>ctype_cntrl</refname>
<refpurpose>制御文字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_cntrl</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-digit">
<refnamediv>
<refname>ctype_digit</refname>
<refpurpose>数字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_digit</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-lower">
<refnamediv>
<refname>ctype_lower</refname>
<refpurpose>小文字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_lower</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-graph">
<refnamediv>
<refname>ctype_graph</refname>
<refpurpose>空白を除き出力可能な文字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_graph</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-print">
<refnamediv>
<refname>ctype_print</refname>
<refpurpose>出力可能な文字かどうかを確認</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_print</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-punct">
<refnamediv>
<refname>ctype_punct</refname>
<refpurpose>
空白文字以外の出力可能な文字または英数字かどうかを調べる
</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_punct</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-space">
<refnamediv>
<refname>ctype_space</refname>
<refpurpose>空白文字かどうか調べる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_space</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-upper">
<refnamediv>
<refname>ctype_upper</refname>
<refpurpose>大文字かどうか調べる</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_upper</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
<refentry id="function.ctype-xdigit">
<refnamediv>
<refname>ctype_xdigit</refname>
<refpurpose>
16進数を表す文字かどうかを調べる
</refpurpose>
</refnamediv>
<refsect1>
<title>説明</title>
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ctype_xdigit</function></funcdef>
<paramdef>string <parameter>c</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->