HaruException
HaruDoc::addPage
haru
PHP Manual

# HaruDoc クラス

## 導入

Haru PDF ドキュメントクラスです。

## クラス概要

HaruDoc
HaruDoc {
/* メソッド */
object addPage ( void )
bool addPageLabel ( int `$first_page` , int `$style` , int `$first_num` [, string `$prefix` = "" ] )
void __construct ( void )
object createOutline ( string `$title` [, object `$parent_outline` [, object `$encoder` ]] )
object getCurrentEncoder ( void )
object getCurrentPage ( void )
object getEncoder ( string `$encoding` )
object getFont ( string `$fontname` [, string `$encoding` ] )
string getInfoAttr ( int `$type` )
int getPageLayout ( void )
int getPageMode ( void )
int getStreamSize ( void )
object insertPage ( object `$page` )
object loadJPEG ( string `$filename` )
object loadPNG ( string `$filename` [, bool `$deferred` = false ] )
object loadRaw ( string `$filename` , int `$width` , int `$height` , int `$color_space` )
string loadTTC ( string `$fontfile` , int `$index` [, bool `$embed` = false ] )
string loadTTF ( string `$fontfile` [, bool `$embed` = false ] )
string loadType1 ( string `$afmfile` [, string `$pfmfile` ] )
bool output ( void )
string readFromStream ( int `$bytes` )
bool resetError ( void )
bool resetStream ( void )
bool save ( string `$file` )
bool saveToStream ( void )
bool setCompressionMode ( int `$mode` )
bool setCurrentEncoder ( string `$encoding` )
bool setEncryptionMode ( int `$mode` [, int `$key_len` = 5 ] )
bool setInfoAttr ( int `$type` , string `$info` )
bool setInfoDateAttr ( int `$type` , int `$year` , int `$month` , int `$day` , int `$hour` , int `$min` , int `$sec` , string `$ind` , int `$off_hour` , int `$off_min` )
bool setOpenAction ( object `$destination` )
bool setPageLayout ( int `$layout` )
bool setPageMode ( int `$mode` )
bool setPagesConfiguration ( int `$page_per_pages` )
bool setPassword ( string `$owner_password` , string `$user_password` )
bool setPermission ( int `$permission` )
bool useCNSEncodings ( void )
bool useCNSFonts ( void )
bool useCNTEncodings ( void )
bool useCNTFonts ( void )
bool useJPEncodings ( void )
bool useJPFonts ( void )
bool useKREncodings ( void )
bool useKRFonts ( void )
}

## 定義済み定数

型 | 名前 | 説明
--- | --- | ---
int | HaruDoc::CS_DEVICE_GRAY |
int | HaruDoc::CS_DEVICE_RGB |
int | HaruDoc::CS_DEVICE_CMYK |
int | HaruDoc::CS_CAL_GRAY |
int | HaruDoc::CS_CAL_RGB |
int | HaruDoc::CS_LAB |
int | HaruDoc::CS_ICC_BASED |
int | HaruDoc::CS_SEPARATION |
int | HaruDoc::CS_DEVICE_N |
int | HaruDoc::CS_INDEXED |
int | HaruDoc::CS_PATTERN |
int | HaruDoc::ENABLE_READ |
int | HaruDoc::ENABLE_PRINT |
int | HaruDoc::ENABLE_EDIT_ALL |
int | HaruDoc::ENABLE_COPY |
int | HaruDoc::ENABLE_EDIT |
int | HaruDoc::ENCRYPT_R2 |
int | HaruDoc::ENCRYPT_R3 |
int | HaruDoc::INFO_AUTHOR |
int | HaruDoc::INFO_CREATOR |
int | HaruDoc::INFO_TITLE |
int | HaruDoc::INFO_SUBJECT |
int | HaruDoc::INFO_KEYWORDS |
int | HaruDoc::INFO_CREATION_DATE |
int | HaruDoc::INFO_MOD_DATE |
int | HaruDoc::COMP_NONE |
int | HaruDoc::COMP_TEXT |
int | HaruDoc::COMP_IMAGE |
int | HaruDoc::COMP_METADATA |
int | HaruDoc::COMP_ALL |
int | HaruDoc::PAGE_LAYOUT_SINGLE |
int | HaruDoc::PAGE_LAYOUT_ONE_COLUMN |
int | HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT |
int | HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT |
int | HaruDoc::PAGE_MODE_USE_NONE |
int | HaruDoc::PAGE_MODE_USE_OUTLINE |
int | HaruDoc::PAGE_MODE_USE_THUMBS |
int | HaruDoc::PAGE_MODE_FULL_SCREEN |

## 目次

- HaruDoc::addPage — 新しいページをドキュメントに追加する
- HaruDoc::addPageLabel — 指定した範囲のページにおけるページラベルの形式を設定する
- HaruDoc::__construct — 新しい HaruDoc のインスタンスを作成する
- HaruDoc::createOutline — HaruOutline のインスタンスを作成する
- HaruDoc::getCurrentEncoder — ドキュメントが現在使用している HaruEncoder を取得する
- HaruDoc::getCurrentPage — ドキュメントの現在のページを返す
- HaruDoc::getEncoder — 指定したエンコーディングの HaruEncoder のインスタンスを取得する
- HaruDoc::getFont — HaruFont のインスタンスを取得する
- HaruDoc::getInfoAttr — 指定したドキュメント属性の現在の値を取得する
- HaruDoc::getPageLayout — 現在のページレイアウトを取得する
- HaruDoc::getPageMode — 現在のページモードを取得する
- HaruDoc::getStreamSize — 一時ストリームの大きさを取得する
- HaruDoc::insertPage — 指定したページの直前に新しいページを挿入する
- HaruDoc::loadJPEG — JPEG 画像を読み込む
- HaruDoc::loadPNG — PNG 画像を読み込み、HaruImage のインスタンスを返す
- HaruDoc::loadRaw — RAW 画像を読み込む
- HaruDoc::loadTTC — TTC ファイルから指定したインデックスのフォントを読み込む
- HaruDoc::loadTTF — TTF フォントファイルを読み込む
- HaruDoc::loadType1 — Type1 フォントを読み込む
- HaruDoc::output — ドキュメントデータを出力バッファに書き出す
- HaruDoc::readFromStream — データを一時ストリームから読み込む
- HaruDoc::resetError — ドキュメントハンドルのエラーの状態をリセットする
- HaruDoc::resetStream — 一時ストリームを巻き戻す
- HaruDoc::save — ドキュメントを指定したファイルに保存する
- HaruDoc::saveToStream — ドキュメントを一時ストリームに保存する
- HaruDoc::setCompressionMode — ドキュメントの圧縮モードを設定する
- HaruDoc::setCurrentEncoder — ドキュメントの現在のエンコーダを設定する
- HaruDoc::setEncryptionMode — ドキュメントの暗号化モードを設定する
- HaruDoc::setInfoAttr — ドキュメントの情報属性を設定する
- HaruDoc::setInfoDateAttr — ドキュメントの情報属性に日付と時刻を設定する
- HaruDoc::setOpenAction — ドキュメントを開いたときにどのページを表示するかを定義する
- HaruDoc::setPageLayout — ページをどのように表示するかを設定する
- HaruDoc::setPageMode — ドキュメントをどのように表示するかを設定する
- HaruDoc::setPagesConfiguration — ページ群単位のページ数を設定する
- HaruDoc::setPassword — ドキュメントに所有者パスワードおよびユーザパスワードを設定する
- HaruDoc::setPermission — ドキュメントの使用権限を設定する
- HaruDoc::useCNSEncodings — 簡体字中国語エンコーディングを有効にする
- HaruDoc::useCNSFonts — 組み込みの簡体字中国語フォントを有効にする
- HaruDoc::useCNTEncodings — 繁体字中国語エンコーディングを有効にする
- HaruDoc::useCNTFonts — 組み込みの繁体字中国語フォントを有効にする
- HaruDoc::useJPEncodings — 日本語エンコーディングを有効にする
- HaruDoc::useJPFonts — 組み込みの日本語フォントを有効にする
- HaruDoc::useKREncodings — 韓国/朝鮮語エンコーディングを有効にする
- HaruDoc::useKRFonts — 組み込みの韓国/朝鮮語フォントを有効にする

HaruException
HaruDoc::addPage
haru
PHP Manual