Location: PHPKode > projects > NOLA > includes/pc4p/apidoc/pc4p_init.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- Generated with PHPDoc, http://www.phpdoc.de -->
<html>
<head>
	<title>PC4P - pc4p - Module: pc4p_init</title>
	<link href="phpdoc.css" rel="stylesheet" type="text/css">
</head>

<body>
<table width="100%" border="0">
	<tr>
		<td align="left" valign="top" bgcolor="#B0BAFF">			
			<table width="100%">
				<tr>
					<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
					<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
					<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
					<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
					<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
					<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
				</tr>
			</table>	
		</td>
	</tr>
	<tr>	
		<td height="20" align="left" valign="top"><hr></td>
	</tr>
	<tr>
		<td align="left" valign="top">			
			File: <a href="file:///data/customers/alex/htdocs/include/pc4p_init.inc">/data/customers/alex/htdocs/include/pc4p_init.inc</a>
			<h5>PC4P - pc4p</h5>
			<h1>pc4p::pc4p_init</h1>
			<p>
			PC4P's init module, sets the needed include path and provides wrapper functions
			<p>
			&nbsp;
		</td>
	</tr>
	<tr>
		<td align="left" valign="top">
			<h4>private module pc4p_init</h4>
			PC4P's init module, sets the needed include path and provides wrapper functions
			<br>
			for the objects
			<p>
			<table>
				
				
				
				
				
				
				
				
			</table>
		</td>
	</tr>
	<tr>
		<td height="10" align="left" valign="top">&nbsp;</td>
	</tr>
	
	<tr>
		<td height="20" align="left" valign="top"><hr></td>
	</tr>
	
	<tr>
		<td align="left" valign="top">		
			<table width="100%" border="0">
				<tr>
					<td colspan="2" align="left" valign="top"><h2>Public Method Summary</h2></td>
				</tr>
				
				<tr>
					<td align="right" valign="top">object pc4p_main</td>
					<td align="left" valign="top" width="100%"><a href="#function_&pc4p_create_pdf()"><h4>&pc4p_create_pdf([ array $info ])</h4></a>pc4p_create_pdf - Main wrapper function to create the PDF</td>
				</tr>
				
				<tr>
					<td align="right" valign="top">object pc4p_page</td>
					<td align="left" valign="top" width="100%"><a href="#function_&pc4p_create_page()"><h4>&pc4p_create_page(object pc4p_main &$parent, string $format, [ string $dimensions ])</h4></a>pc4p_create_page - Wrapper function to create a page</td>
				</tr>
				
				<tr>
					<td align="right" valign="top">object pc4p_object</td>
					<td align="left" valign="top" width="100%"><a href="#function_&pc4p_create_object()"><h4>&pc4p_create_object(object pc4p_page &$parent, [ string $object_type ])</h4></a>pc4p_create_object - Wrapper function to create objects</td>
				</tr>
				
			</table>
		</td>
	</tr>
	
	
	
	<tr>
		<td align="left" valign="top">
			<table width="100%" border="0">
				<tr>
					<td align="left" valign="top" colspan=2><h3>Included files Summary, Type: include_once</h3></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_main.inc">pc4p_main.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_main.inc">Include the main object</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_page.inc">pc4p_page.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_page.inc">Include the page object</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_object.inc">pc4p_object.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_object.inc">Include the generic object</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_text.inc">pc4p_text.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_text.inc">Include the object for using text</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_box.inc">pc4p_box.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_box.inc">Include the object for drawing boxes</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_table.inc">pc4p_table.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_table.inc">Include the object for creating tables</a></td>
				</tr>
				
				<tr>
					<td align="left" valign="top"><a href="#uses_pc4p_image.inc">pc4p_image.inc</a></td>
					<td align="left" valign="top" width="100%"><a href="#uses_pc4p_image.inc">Include the object for images</a></td>
				</tr>
				
			</table>
		</td>
	</tr>
	
	
	<tr>
		<td align="left" valign="top">
			<table width="100%" border="0">
				<tr>
					<td colspan="2" align="left" valign="top"><h2>Public Method Details</h2></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="function_&pc4p_create_pdf()"><h4>&pc4p_create_pdf</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>public    object pc4p_main &pc4p_create_pdf( [ array $info ] )</b><p>
					</td>
				</tr>
				<tr>
					<td width="10" align="left" valign="top">&nbsp;</td>
					<td align="left" valign="top">
						pc4p_create_pdf - Main wrapper function to create the PDF
						<br>
						This is the first function which should be called, as itacquires the PDF-Pointer for all other operations.
						<p>
						
					</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top">Parameter</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">array</td>
								<td align="left" valign="top">$info</td>
								<td align="left" valign="top"><code>= >>array()<<</code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">here go the vars for the infos of the PDF</td>
							</tr>
						</table>
					</td>
				</tr>
				
				
				
				<tr>
					<td align="left" valign="top">Returns</td>
					<td>object pc4p_main $pdf<p>the pdf-object, used by pc4p_create_page</td>
				</tr>
				
				
				
				
				
				
				
				
				
				
				
				
				<tr>
					<td align="left" valign="top">Author(s)</td>
					<td align="left" valign="top">Alexander Wirtz &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="function_&pc4p_create_page()"><h4>&pc4p_create_page</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>public    object pc4p_page &pc4p_create_page( object pc4p_main &$parent, string $format, [ string $dimensions ] )</b><p>
					</td>
				</tr>
				<tr>
					<td width="10" align="left" valign="top">&nbsp;</td>
					<td align="left" valign="top">
						pc4p_create_page - Wrapper function to create a page
						<br>
						This function is used to create new pages. Can takea standard pagesize or user defines.
						<p>
						
					</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top">Parameter</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">object pc4p_main</td>
								<td align="left" valign="top">&$parent</td>
								<td align="left" valign="top"><code></code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">parent of the page, can only be a PDF-Object</td>
							</tr>
						</table>
					</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">string</td>
								<td align="left" valign="top">$format</td>
								<td align="left" valign="top"><code></code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">name of a standard pagesize or &quot;user&quot;</td>
							</tr>
						</table>
					</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">string</td>
								<td align="left" valign="top">$dimensions</td>
								<td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">or the dimensions if page is &quot;user&quot;-defined &lt;width&gt;x&lt;height&gt;</td>
							</tr>
						</table>
					</td>
				</tr>
				
				
				
				<tr>
					<td align="left" valign="top">Returns</td>
					<td>object pc4p_page $page<p>a page-object is returned, used by pc4p_create_object</td>
				</tr>
				
				
				
				
				
				
				
				
				
				
				
				
				<tr>
					<td align="left" valign="top">Author(s)</td>
					<td align="left" valign="top">Alexander Wirtz &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="function_&pc4p_create_object()"><h4>&pc4p_create_object</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>public    object pc4p_object &pc4p_create_object( object pc4p_page &$parent, [ string $object_type ] )</b><p>
					</td>
				</tr>
				<tr>
					<td width="10" align="left" valign="top">&nbsp;</td>
					<td align="left" valign="top">
						pc4p_create_object - Wrapper function to create objects
						<br>
						Here we have the wrapper for all the other objects: Text, tables, boxes,images and a object, which is used as container.
						<p>
						
					</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top">Parameter</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">object pc4p_page</td>
								<td align="left" valign="top">&$parent</td>
								<td align="left" valign="top"><code></code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">parent of the object, usually a page, or some container-object such as boxes and tables</td>
							</tr>
						</table>
					</td>
				</tr>
				
				<tr>
					<td></td>
					<td align="left" valign="top">						
						<table>
							<tr>
								<td align="left" valign="top">string</td>
								<td align="left" valign="top">$object_type</td>
								<td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
							</tr>
							<tr>
								<td></td>
								<td colspan="2" align="left" valign="top">type of object to be created, if empty a container-object is created</td>
							</tr>
						</table>
					</td>
				</tr>
				
				
				
				<tr>
					<td align="left" valign="top">Returns</td>
					<td>object pc4p_object $object<p>the object, which was created by this function</td>
				</tr>
				
				
				
				
				
				
				
				
				
				
				
				
				<tr>
					<td align="left" valign="top">Author(s)</td>
					<td align="left" valign="top">Alexander Wirtz &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
			</table>
	</tr>
		
	
	
	<tr>
		<td align="left" valign="top">
			<table width="100%" border="0">
				<tr>
					<td colspan="2" align="left" valign="top"><h2>Included Files, Type: include_once</h2></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_main.inc"><h4>pc4p_main.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_main.inc )</b>
						<p>
						Include the main object
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_page.inc"><h4>pc4p_page.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_page.inc )</b>
						<p>
						Include the page object
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_object.inc"><h4>pc4p_object.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_object.inc )</b>
						<p>
						Include the generic object
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_text.inc"><h4>pc4p_text.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_text.inc )</b>
						<p>
						Include the object for using text
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_box.inc"><h4>pc4p_box.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_box.inc )</b>
						<p>
						Include the object for drawing boxes
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_table.inc"><h4>pc4p_table.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_table.inc )</b>
						<p>
						Include the object for creating tables
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_pc4p_image.inc"><h4>pc4p_image.inc</h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>include_once( pc4p_image.inc )</b>
						<p>
						Include the object for images
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
			</table>
		</td>
	</tr>
	
	<tr>
		<td align="left" valign="top">
			<table width="100%" border="0">
				<tr>
					<td colspan="2" align="left" valign="top"><h2>Included Files, Type: </h2></td>
				</tr>
				
				<tr><td colspan="2" align="left" valign="top"><a name="uses_"><h4></h4></a></td></tr>
				<tr>
					<td colspan="2" align="left" valign="top">
						<b>(  )</b>
						<p>
						
						<br>
						
					</td>
				</tr>
				
				
				
				
				
				
				
				
				
				<tr>
					<td align="left" valign="top">Author(s)</td>
					<td align="left" valign="top">Alexander Wirtz &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</td>
				</tr>
				
				<tr>
					<td colspan="2" align="left" valign="top"><hr></td>
				</tr>
				
			</table>
		</td>
	</tr>
	
	<tr>
		<td height="10" align="left" valign="top"><hr></td>
	</tr>
	<tr>
		<td align="left" valign="top" bgcolor="#C0C0C0">			
			<table width="100%">
				<tr>
					<td align="left" valign="top"><a href="phpdoc_packagelist.html">Packageindex</a></td>
					<td align="left" valign="top"><a href="phpdoc_classtree.html">Classtrees</a></td>
					<td align="left" valign="top"><a href="phpdoc_modulegroup.html">Modulegroups</a></td>
					<td align="left" valign="top"><a href="phpdoc_elementlist.html">Elementlist</a></td>
					<td align="left" valign="top"><a href="phpdoc_warnings.html">Report</a></td>
					<td align="left" valign="top"><a href="phpdoc_xmlfiles.html">XML Files</a></td>
				</tr>
			</table>	
		</td>
	</tr>
	<tr>
		<td align="left" valign="top">PHPDoc 1.0beta</td>
	</tr>
</table>


</body>
</html>
Return current item: NOLA