文字
The HaruDoc class
(PECL haru >= 0.0.1)
简介
Haru PDF Document Class.
类摘要
HaruDoc
{
object addPage
( void
)
bool addPageLabel
( int
$first_page
, int $style
, int $first_num
[, string $prefix = ""
] ) __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
)
}预定义常量
| Type | Name | Description |
|---|---|---|
| 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 |
Table of Contents
- HaruDoc::addPage — Add new page to the document
- HaruDoc::addPageLabel — Set the numbering style for the specified range of pages
- HaruDoc::__construct — Construct new HaruDoc instance
- HaruDoc::createOutline — Create a HaruOutline instance
- HaruDoc::getCurrentEncoder — Get HaruEncoder currently used in the document
- HaruDoc::getCurrentPage — Return current page of the document
- HaruDoc::getEncoder — Get HaruEncoder instance for the specified encoding
- HaruDoc::getFont — Get HaruFont instance
- HaruDoc::getInfoAttr — Get current value of the specified document attribute
- HaruDoc::getPageLayout — Get current page layout
- HaruDoc::getPageMode — Get current page mode
- HaruDoc::getStreamSize — Get the size of the temporary stream
- HaruDoc::insertPage — Insert new page just before the specified page
- HaruDoc::loadJPEG — Load a JPEG image
- HaruDoc::loadPNG — Load PNG image and return HaruImage instance
- HaruDoc::loadRaw — Load a RAW image
- HaruDoc::loadTTC — Load the font with the specified index from TTC file
- HaruDoc::loadTTF — Load TTF font file
- HaruDoc::loadType1 — Load Type1 font
- HaruDoc::output — Write the document data to the output buffer
- HaruDoc::readFromStream — Read data from the temporary stream
- HaruDoc::resetError — Reset error state of the document handle
- HaruDoc::resetStream — Rewind the temporary stream
- HaruDoc::save — Save the document into the specified file
- HaruDoc::saveToStream — Save the document into a temporary stream
- HaruDoc::setCompressionMode — Set compression mode for the document
- HaruDoc::setCurrentEncoder — Set the current encoder for the document
- HaruDoc::setEncryptionMode — Set encryption mode for the document
- HaruDoc::setInfoAttr — Set the info attribute of the document
- HaruDoc::setInfoDateAttr — Set the datetime info attributes of the document
- HaruDoc::setOpenAction — Define which page is shown when the document is opened
- HaruDoc::setPageLayout — Set how pages should be displayed
- HaruDoc::setPageMode — Set how the document should be displayed
- HaruDoc::setPagesConfiguration — Set the number of pages per set of pages
- HaruDoc::setPassword — Set owner and user passwords for the document
- HaruDoc::setPermission — Set permissions for the document
- HaruDoc::useCNSEncodings — Enable Chinese simplified encodings
- HaruDoc::useCNSFonts — Enable builtin Chinese simplified fonts
- HaruDoc::useCNTEncodings — Enable Chinese traditional encodings
- HaruDoc::useCNTFonts — Enable builtin Chinese traditional fonts
- HaruDoc::useJPEncodings — Enable Japanese encodings
- HaruDoc::useJPFonts — Enable builtin Japanese fonts
- HaruDoc::useKREncodings — Enable Korean encodings
- HaruDoc::useKRFonts — Enable builtin Korean fonts