📄 class.harudoc.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>The HaruDoc class</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="class.haruexception.html">HaruException</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.harudoc-addpage.html">HaruDoc::addPage</a></div> <div class="up"><a href="book.haru.html">haru</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div> <h1 class="title">The HaruDoc class</h1> <div class="partintro"> <div id="harudoc.intro" class="section"> <h2 class="title">Introduction</h2> <p class="para"> Haru PDF Document Class. </p> </div> <div id="harudoc.synopsis" class="section"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"><b class="classname">HaruDoc</b></div> <div class="classsynopsisinfo"> <span class="ooclass"> <b class="classname">HaruDoc</b> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-addpage.html" class="function">HaruDoc::addPage</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-addpagelabel.html" class="function">HaruDoc::addPageLabel</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$first_page</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$style</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$first_num</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$prefix</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">void</span> <span class="methodname"><b><a href="function.harudoc-construct.html" class="function">HaruDoc::__construct</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-createoutline.html" class="function">HaruDoc::createOutline</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$title</tt></span> [, <span class="methodparam"><span class="type">object</span> <tt class="parameter">$parent_outline</tt></span> [, <span class="methodparam"><span class="type">object</span> <tt class="parameter">$encoder</tt></span> ]] )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-getcurrentencoder.html" class="function">HaruDoc::getCurrentEncoder</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-getcurrentpage.html" class="function">HaruDoc::getCurrentPage</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-getencoder.html" class="function">HaruDoc::getEncoder</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-getfont.html" class="function">HaruDoc::getFont</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fontname</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="function.harudoc-getinfoattr.html" class="function">HaruDoc::getInfoAttr</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="function.harudoc-getpagelayout.html" class="function">HaruDoc::getPageLayout</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="function.harudoc-getpagemode.html" class="function">HaruDoc::getPageMode</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><b><a href="function.harudoc-getstreamsize.html" class="function">HaruDoc::getStreamSize</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-insertpage.html" class="function">HaruDoc::insertPage</a></b></span> ( <span class="methodparam"><span class="type">object</span> <tt class="parameter">$page</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-loadjpeg.html" class="function">HaruDoc::loadJPEG</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-loadpng.html" class="function">HaruDoc::loadPNG</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span> [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$deferred</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><a href="function.harudoc-loadraw.html" class="function">HaruDoc::loadRaw</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$filename</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$width</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$height</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$color_space</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="function.harudoc-loadttc.html" class="function">HaruDoc::loadTTC</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fontfile</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$index</tt></span> [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$embed</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="function.harudoc-loadttf.html" class="function">HaruDoc::loadTTF</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$fontfile</tt></span> [, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$embed</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="function.harudoc-loadtype1.html" class="function">HaruDoc::loadType1</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$afmfile</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pfmfile</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-output.html" class="function">HaruDoc::output</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><b><a href="function.harudoc-readfromstream.html" class="function">HaruDoc::readFromStream</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$bytes</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-reseterror.html" class="function">HaruDoc::resetError</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-resetstream.html" class="function">HaruDoc::resetStream</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-save.html" class="function">HaruDoc::save</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$file</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-savetostream.html" class="function">HaruDoc::saveToStream</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setcompressionmode.html" class="function">HaruDoc::setCompressionMode</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setcurrentencoder.html" class="function">HaruDoc::setCurrentEncoder</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$encoding</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setencryptionmode.html" class="function">HaruDoc::setEncryptionMode</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span> [, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$key_len</tt></span> ] )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setinfoattr.html" class="function">HaruDoc::setInfoAttr</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$info</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setinfodateattr.html" class="function">HaruDoc::setInfoDateAttr</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$type</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$year</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$month</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$day</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$hour</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$min</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$sec</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$ind</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$off_hour</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$off_min</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setopenaction.html" class="function">HaruDoc::setOpenAction</a></b></span> ( <span class="methodparam"><span class="type">object</span> <tt class="parameter">$destination</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setpagelayout.html" class="function">HaruDoc::setPageLayout</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$layout</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setpagemode.html" class="function">HaruDoc::setPageMode</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setpagesconfiguration.html" class="function">HaruDoc::setPagesConfiguration</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$page_per_pages</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setpassword.html" class="function">HaruDoc::setPassword</a></b></span> ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$owner_password</tt></span> , <span class="methodparam"><span class="type">string</span> <tt class="parameter">$user_password</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-setpermission.html" class="function">HaruDoc::setPermission</a></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$permission</tt></span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usecnsencodings.html" class="function">HaruDoc::useCNSEncodings</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usecnsfonts.html" class="function">HaruDoc::useCNSFonts</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usecntencodings.html" class="function">HaruDoc::useCNTEncodings</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usecntfonts.html" class="function">HaruDoc::useCNTFonts</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usejpencodings.html" class="function">HaruDoc::useJPEncodings</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usejpfonts.html" class="function">HaruDoc::useJPFonts</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usekrencodings.html" class="function">HaruDoc::useKREncodings</a></b></span> ( <span class="methodparam">void</span> )</div><div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><a href="function.harudoc-usekrfonts.html" class="function">HaruDoc::useKRFonts</a></b></span> ( <span class="methodparam">void</span> )</div> }</div> </div> <div id="haru.harudoc.constants" class="section"> <h2 class="title">Predefined Constants</h2> <table border="5"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Type</th> <th colspan="1">Name</th> <th colspan="1">Description</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_DEVICE_GRAY</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_DEVICE_RGB</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_DEVICE_CMYK</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_CAL_GRAY</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_CAL_RGB</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_LAB</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_ICC_BASED</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_SEPARATION</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_DEVICE_N</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_INDEXED</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::CS_PATTERN</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENABLE_READ</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENABLE_PRINT</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENABLE_EDIT_ALL</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENABLE_COPY</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENABLE_EDIT</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENCRYPT_R2</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::ENCRYPT_R3</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::INFO_AUTHOR</td> <td class="empty"> </td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left">int</td> <td colspan="1" rowspan="1" align="left">HaruDoc::INFO_CREATOR</td> <td class="empty"> </td> </tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -