The HaruDoc class
(PECL haru >= 0.0.1)
Introduction
Haru PDF Document Class.
Class synopsis
$type
, int $year
, int $month
, int $day
, int $hour
, int $min
, int $sec
, string $ind
, int $off_hour
, int $off_min
) : boolPredefined Constants
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
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.harudoc.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.