LDAPAccountManager/lam-web/developers/phpdoc/PDF/_lib_pdf_inc.html

365 lines
12 KiB
HTML
Raw Normal View History

2006-07-09 14:14:57 +00:00
<html>
<head>
<title>Docs for page pdf.inc</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<p align="center">
<script type="text/javascript"><!--
google_ad_client = "pub-4179059556107138";
google_alternate_ad_url = "http://lam.sourceforge.net/google_adsense_script.html";
google_ad_width = 728;
google_ad_height = 90;
google_ad_format = "728x90_as";
google_ad_type = "text_image";
google_ad_channel ="";
google_page_url = document.location;
google_color_border = "EEEEEE";
google_color_bg = "FFFFFF";
google_color_link = "0000FF";
google_color_url = "008000";
google_color_text = "000000";
//--></script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</p>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">PDF</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_PDF.html" class="menu">class tree: PDF</a> ]
[ <a href="../elementindex_PDF.html" class="menu">index: PDF</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_README.html">README</a></p>
<p><a href="../ric_INSTALL.html">INSTALL</a></p>
</div>
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_main.html">main</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_tests.html">tests</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../PDF/_lib_fpdf_php.html"> fpdf.php
</a><br>
<a href="../PDF/_lib_pdf_inc.html"> pdf.inc
</a><br>
<a href="../PDF/_templates_pdfedit_pdfdelete_php.html"> pdfdelete.php
</a><br>
<a href="../PDF/_templates_pdfedit_pdfmain_php.html"> pdfmain.php
</a><br>
<a href="../PDF/_templates_pdfedit_pdfpage_php.html"> pdfpage.php
</a><br>
<a href="../PDF/_lib_pdfstruct_inc.html"> pdfstruct.inc
</a><br>
<a href="../PDF/_lib_ufpdf_php.html"> ufpdf.php
</a><br>
<a href="../PDF/_lib_font_vera_php.html"> vera.php
</a><br>
<a href="../PDF/_lib_font_verab_php.html"> verab.php
</a><br>
<a href="../PDF/_lib_font_verabi_php.html"> verabi.php
</a><br>
<a href="../PDF/_lib_font_verai_php.html"> verai.php
</a><br>
<a href="../PDF/_lib_xml_parser_inc.html"> xml_parser.inc
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../PDF/FPDF.html">FPDF</a><br />
<a href="../PDF/lamPDF.html">lamPDF</a><br />
<a href="../PDF/UFPDF.html">UFPDF</a><br />
<a href="../PDF/xmlParser.html">xmlParser</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Procedural File: pdf.inc</h1>
Source Location: /lib/pdf.inc<br /><br />
<br>
<br>
<div class="contents">
<h2>Classes:</h2>
<dt><a href="../PDF/lamPDF.html">lamPDF</a></dt>
<dd>Creates a LAM information page in PDF format.</dd>
</div><br /><br />
<h2>Page Details:</h2>
LDAP Account Manager PDF printing library. It consists of lamPDF class, the createModulePDF() function that may be called by other pages and furthermore some helper functions.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b>&nbsp;&nbsp;</td><td>Michael D<>rgner</td>
</tr>
</table>
</div>
<br /><br />
<h4>Includes:</h4>
<div class="tags">
include_once(<a href="../PDF/_lib_ufpdf_php.html">"ufpdf.php"</a>) [line 39]<br />
Unicode support for FPDF<br /><br />include_once(<a href="../PDF/_lib_xml_parser_inc.html">'xml_parser.inc'</a>) [line 42]<br />
XML functions<br /><br />include_once(<a href="../PDF/_lib_fpdf_php.html">"fpdf.php"</a>) [line 36]<br />
PDF generator class<br /><br />include_once(<a href="../PDF/_lib_pdfstruct_inc.html">'pdfstruct.inc'</a>) [line 45]<br />
access to PDF configuration files<br /><br /></div>
<br /><br />
<br /><br />
<hr />
<a name="defineLAMPDF_LINEWIDTH"></a>
<h3>LAMPDF_LINEWIDTH <span class="smalllinenumber">[line 33]</span></h3>
<div class="tags">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>LAMPDF_LINEWIDTH = 190</code>
</td></tr></table>
</td></tr></table>
PDF line width<br /><br /> <br />
</div>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
<br />
<hr />
<a name="functioncreateModulePDF"></a>
<h3>createModulePDF <span class="smalllinenumber">[line 62]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void createModulePDF(
array $accounts, [string $pdf_structure = "default"])</code>
</td></tr></table>
</td></tr></table><br />
This function creates the PDF output of one or more accounts. At the moment this function can create a PDF page for user, group and host accounts. But this is not limited by the function itself but by the account types that are allowed in LAM and the exsisting PDF structure definitions.<br /><br /> <br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$accounts</b>&nbsp;&nbsp;</td>
<td>A numbered array containing all accounts the PDF page should be created for. The entries of the array must be AccountContainer objects.</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$pdf_structure</b>&nbsp;&nbsp;</td>
<td>The filename of the structure definition that should be used to create the PDF page. If not submitted the 'default.user' structure definition for the appropriate account type.</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functiongetSectionHeadline"></a>
<h3>getSectionHeadline <span class="smalllinenumber">[line 197]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>string getSectionHeadline(
string $line)</code>
</td></tr></table>
</td></tr></table><br />
Creates a section headline.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>XML code for headline</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$line</b>&nbsp;&nbsp;</td>
<td>section name</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionprocessAttributes"></a>
<h3>processAttributes <span class="smalllinenumber">[line 325]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array processAttributes(
string $attrs, [array $return = array()])</code>
</td></tr></table>
</td></tr></table><br />
Processes width, height and alignment attributes.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>XML code</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$attrs</b>&nbsp;&nbsp;</td>
<td>attributes</td>
</tr>
<tr>
<td class="type">array&nbsp;&nbsp;</td>
<td><b>$return</b>&nbsp;&nbsp;</td>
<td>XML code</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionprocessFormatTags"></a>
<h3>processFormatTags <span class="smalllinenumber">[line 292]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array processFormatTags(
string $line, string $style)</code>
</td></tr></table>
</td></tr></table><br />
Formats the XML code.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>XML code</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$line</b>&nbsp;&nbsp;</td>
<td>XML code of PDF entry</td>
</tr>
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$style</b>&nbsp;&nbsp;</td>
<td>style commands</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<hr />
<a name="functionprocessLine"></a>
<h3>processLine <span class="smalllinenumber">[line 216]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>array processLine(
string $line, [boolean $first_td = true], mixed $fontName)</code>
</td></tr></table>
</td></tr></table><br />
Creates the XML code for an PDF entry.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>return:</b>&nbsp;&nbsp;</td><td>XML codes</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters</h4>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">string&nbsp;&nbsp;</td>
<td><b>$line</b>&nbsp;&nbsp;</td>
<td>XML code of PDF entry</td>
</tr>
<tr>
<td class="type">boolean&nbsp;&nbsp;</td>
<td><b>$first_td</b>&nbsp;&nbsp;</td>
<td>True if this is the first column</td>
</tr>
</table>
<div class="top">[ <a href="#top">Top</a> ]</div><br /><br />
</div>
<div class="credit">
<hr />
Documentation generated on Tue, 07 Feb 2006 17:03:50 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.2.3</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
<p align="center">
<script type="text/javascript"><!--
google_ad_client = "pub-4179059556107138";
google_alternate_ad_url = "http://lam.sourceforge.net/google_adsense_script.html";
google_ad_width = 728;
google_ad_height = 90;
google_ad_format = "728x90_as";
google_ad_type = "text_image";
google_ad_channel ="";
google_page_url = document.location;
google_color_border = "EEEEEE";
google_color_bg = "FFFFFF";
google_color_link = "0000FF";
google_color_url = "008000";
google_color_text = "000000";
//--></script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</p>
</body>
</html>