Location: PHPKode > projects > NOLA > includes/pc4p/apidoc/module_pc4p_init.xml
<?xml version="1.0"?><phpdoc><module name="pc4p_init" group="pc4p" undoc="false" access="private" package="pc4p"><file>/data/customers/alex/htdocs/include/pc4p_init.inc</file><doc><author email="hide@address.com">Alexander Wirtz</author><description>for the objects</description><shortdescription>PC4P&amp;apos;s init module, sets the needed include path and provides wrapper functions</shortdescription></doc><function name="&amp;pc4p_create_pdf" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="$info" default="array()" type="array">here go the vars for the infos of the PDF</parameter><return name="$pdf" type="object pc4p_main">the pdf-object, used by pc4p_create_page</return><description>This is the first function which should be called, as itacquires the PDF-Pointer for all other operations.</description><shortdescription>pc4p_create_pdf - Main wrapper function to create the PDF</shortdescription></doc></function><function name="&amp;pc4p_create_page" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="&amp;$parent" type="object pc4p_main">parent of the page, can only be a PDF-Object</parameter><parameter name="$format" type="string">name of a standard pagesize or &amp;quot;user&amp;quot;</parameter><parameter name="$dimensions" default="&amp;quot;&amp;quot;" type="string">or the dimensions if page is &amp;quot;user&amp;quot;-defined &amp;lt;width&amp;gt;x&amp;lt;height&amp;gt;</parameter><return name="$page" type="object pc4p_page">a page-object is returned, used by pc4p_create_object</return><description>This function is used to create new pages. Can takea standard pagesize or user defines.</description><shortdescription>pc4p_create_page - Wrapper function to create a page</shortdescription></doc></function><function name="&amp;pc4p_create_object" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="&amp;$parent" type="object pc4p_page">parent of the object, usually a page, or some container-object such as boxes and tables</parameter><parameter name="$object_type" default="&amp;quot;&amp;quot;" type="string">type of object to be created, if empty a container-object is created</parameter><return name="$object" type="object pc4p_object">the object, which was created by this function</return><description>Here we have the wrapper for all the other objects: Text, tables, boxes,images and a object, which is used as container.</description><shortdescription>pc4p_create_object - Wrapper function to create objects</shortdescription></doc></function><uses type="include_once" file="pc4p_main.inc" undoc="false"><doc><description/><shortdescription>Include the main object</shortdescription></doc></uses><uses type="include_once" file="pc4p_page.inc" undoc="false"><doc><description/><shortdescription>Include the page object</shortdescription></doc></uses><uses type="include_once" file="pc4p_object.inc" undoc="false"><doc><description/><shortdescription>Include the generic object</shortdescription></doc></uses><uses type="include_once" file="pc4p_text.inc" undoc="false"><doc><description/><shortdescription>Include the object for using text</shortdescription></doc></uses><uses type="include_once" file="pc4p_box.inc" undoc="false"><doc><description/><shortdescription>Include the object for drawing boxes</shortdescription></doc></uses><uses type="include_once" file="pc4p_table.inc" undoc="false"><doc><description/><shortdescription>Include the object for creating tables</shortdescription></doc></uses><uses type="include_once" file="pc4p_image.inc" undoc="false"><doc><description/><shortdescription>Include the object for images</shortdescription></doc></uses></module></phpdoc>
Return current item: NOLA