HaruDoc::setPagesConfiguration
(PECL haru >= 0.0.1)
HaruDoc::setPagesConfiguration — ページ群単位のページ数を設定する
説明
HaruDoc::setPagesConfiguration
( int
$page_per_pages
) : bool
デフォルトでは、ドキュメントはひとつの pages オブジェクトを持っており、
これがすべてのページのルートとなります。各ページのオブジェクトは、
すべてこのオブジェクトの配下に作成されます。ひとつの pages
オブジェクトが保持できるページ数は最大で 8191 までなので、
ドキュメントの最大ページ数は 8191 となります。しかし、パラメータ
page_per_pages を指定することで、
これを変更することができます。ルートオブジェクトは
8191 を超える pages (ページではない) オブジェクトを保持することができ、
それぞれの pages が 8191 のページを保持するのです。
これにより、ドキュメントの最大ページ数は
8191*page_per_pages となります。
パラメータ
-
page_per_pages -
pages オブジェクトが保持できるページ数。
返り値
成功した場合に TRUE を返します。
エラー / 例外
エラー時に HaruException をスローします。