repo_zf1/documentation/manual/ja/module_specs/Zend_Pdf-Properties.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 15103 -->
<sect1 id="zend.pdf.info">
    <!-- @todo review and revise upon completion of refactoring -->
    <title>ドキュメントの情報およびメタデータ</title>
    <para>
        PDF ドキュメントには、そのドキュメントに関する情報
        (たとえばタイトルや作者、作成日、更新日など)
        を含めることができます。
    </para>
    <para>
        歴史的に、この情報は特別な Info 構造体に格納されるようになっています。
        この構造体を読み書きするには、<classname>Zend_Pdf</classname> オブジェクトの public プロパティ
        <code>properties</code> の連想配列を使用します。
            <programlisting role="php"><![CDATA[
$pdf = Zend_Pdf::load($pdfPath);

echo $pdf->properties['Title'] . "\n";
echo $pdf->properties['Author'] . "\n";

$pdf->properties['Title'] = 'New Title.';
$pdf->save($pdfPath);
]]>
            </programlisting>

    </para>
    <para>
        PDF v1.4 (Acrobat 5) の標準規格では、次のようなキーが定義されています。

        <itemizedlist>
            <listitem>
                <para>
                    <emphasis>Title</emphasis> - 文字列 (任意)。ドキュメントのタイトル。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Author</emphasis> - 文字列 (任意)。
                    ドキュメントの作成者。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Subject</emphasis> - 文字列 (任意)。
                    ドキュメントのサブタイトル。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Keywords</emphasis> - 文字列 (任意)。
                    ドキュメントに関連するキーワード。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Creator</emphasis> - 文字列 (任意)。
                    他の形式から PDF に変換されたドキュメントである場合に、
                    変換元のドキュメントを作成したアプリケーションの名前
                    (たとえば Adobe FrameMaker®) が格納されます。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Producer</emphasis> - 文字列 (任意)。
                    他の形式から PDF に変換されたドキュメントである場合に、
                    PDF への変換に使用したアプリケーションの名前
                    (たとえば Acrobat Distiller) が格納されます。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>CreationDate</emphasis> - 文字列 (任意)。
                    ドキュメントの作成日時を
                    "D:YYYYMMDDHHmmSSOHH'mm'" 形式で表したもの。
                    <itemizedlist>
                        <listitem>
                            <para>
                                <emphasis>YYYY</emphasis> は年です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>MM</emphasis> は月です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>DD</emphasis> は日 (01–31) です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>HH</emphasis> は時 (00–23) です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>mm</emphasis> は分 (00–59) です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>SS</emphasis> は秒 (00–59) です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>O</emphasis> は地方時と標準時 (UT)
                                との関連です。+, −, あるいは Z で表します
                                (以下を参照ください)。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>HH</emphasis> の後に ' を続けたものは、
                                UT との時差 (時) の絶対値 (00–23) です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>mm</emphasis> の後に ' を続けたものは、
                                UT との時差 (分) の絶対値 (00–59) です。
                            </para>
                        </listitem>
                    </itemizedlist>
                    HH および mm の後に続くアポストロフィ (') は、それぞれのパーツの一部となります。
                    年以外のすべてのフィールドはオプションです (先頭の D: もオプションですが、
                    これは省略しないことを強くお勧めします)。MM と DD のデフォルト値はともに
                    01 で、その他のすべての数値フィールドのデフォルト値はゼロです。
                    O フィールドのプラス記号  (+) は、地方時が UT より遅れていることを表し、
                    マイナス記号 (−) は地方時のほうが UT より進んでいることを表します。
                    UT 情報を省略した場合は、その時刻と UT との関係は未知となります。
                    タイムゾーンの指定の有無にかかわらず、日付は地方時で指定しなければなりません。
                </para>
                <para>
                    たとえば、太平洋標準時の 1998 年 12 月 23 日午後 7 時 52 分は、
                    "D:199812231952−08'00'" となります。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>ModDate</emphasis> - 文字列 (任意)。
                    ドキュメントの最終更新日時。形式は
                    <emphasis>CreationDate</emphasis> と同じ。
                </para>
            </listitem>
            <listitem>
                <para>
                    <emphasis>Trapped</emphasis> - boolean (任意)。
                    ドキュメントにトラッピング情報を含むよう修正されているかどうか。
                    <itemizedlist>
                        <listitem>
                            <para>
                                <emphasis>true</emphasis> - ドキュメントは完全にトラッピングされています。
                                これ以上のトラッピングは不要です。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>false</emphasis> - ドキュメントはまだトラッピングされていません。
                                必要なトラッピングを行わなければなりません。
                            </para>
                        </listitem>
                        <listitem>
                            <para>
                                <emphasis>null</emphasis> -
                                ドキュメントがトラッピングされているかどうかが判別不可能、
                                あるいは一部だけトラッピングされている状態です。
                                さらなるトラッピングが必要かもしれません。
                            </para>
                        </listitem>
                    </itemizedlist>
                </para>
            </listitem>
        </itemizedlist>
    </para>

    <para>
        PDF v 1.6 以降では、メタデータを特別な XML 形式
        (XMP - <ulink url="http://www.adobe.com/products/xmp/">Extensible Metadata Platform</ulink>)
        で表して PDF に添付することができます。
    </para>

    <para>
        この XML ドキュメントを PDF から取得したり PDF に添付したりするには、それぞれ
        <classname>Zend_Pdf::getMetadata()</classname> メソッドおよび
        <classname>Zend_Pdf::setMetadata($metadata)</classname> メソッドを使用します。
            <programlisting role="php"><![CDATA[
$pdf = Zend_Pdf::load($pdfPath);
$metadata = $pdf->getMetadata();
$metadataDOM = new DOMDocument();
$metadataDOM->loadXML($metadata);

$xpath = new DOMXPath($metadataDOM);
$pdfPreffixNamespaceURI = $xpath->query('/rdf:RDF/rdf:Description')
                                ->item(0)
                                ->lookupNamespaceURI('pdf');
$xpath->registerNamespace('pdf', $pdfPreffixNamespaceURI);

$titleNode = $xpath->query('/rdf:RDF/rdf:Description/pdf:Title')->item(0);
$title = $titleNode->nodeValue;
...

$titleNode->nodeValue = 'New title';
$pdf->setMetadata($metadataDOM->saveXML());
$pdf->save($pdfPath);
]]>
            </programlisting>
    </para>

    <para>
        標準的なドキュメントのプロパティは、Info 構造体とメタデータドキュメント
        (存在する場合) の両方に重複して存在することになります。
        これらをきちんと同期させるのは、アプリケーション側の責任となります。
    </para>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->