Location: PHPKode > projects > NOLA > includes/pc4p/apidoc/class_pc4p_page.xml
<?xml version="1.0"?><phpdoc><class name="pc4p_page" extends="" undoc="false" access="private" package="pc4p"><file>/data/customers/alex/htdocs/include/pc4p_page.inc</file><doc><author email="hide@address.com">Alexander Wirtz</author><description/><shortdescription>Supplies pagehandling ability</shortdescription></doc><function name="pc4p_page" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="&amp;$parent" type="object pc4p_page"/><parameter name="$format" type="string"/><parameter name="$dimensions" type="string"/><return type="void"/><description/><shortdescription>Constructor</shortdescription></doc></function><function name="pc4p_set_margin" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="$margin" type="array"/><return type="void"/><description/><shortdescription>Sets the margins for the page</shortdescription></doc></function><function name="pc4p_set_bgimage" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="$imgfile" type="string"/><parameter name="$imgtype" type="string"/><parameter name="$xoffset" type="integer"/><parameter name="$yoffset" type="integer"/><parameter name="$scale" default="1" type="float"/><return type="void"/><description/><shortdescription>Sets a background image for this page</shortdescription></doc></function><function name="pc4p_draw" undoc="false" access="public"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="&amp;$parent" type="object pc4p_main"/><return type="void"/><description>and closes the page.Called as last function in the class.</description><shortdescription>Begins the page with the dimensions, calls the draw for each child</shortdescription></doc></function><function name="pc4p_draw_children" undoc="false" access="private"><doc><author email="hide@address.com">Alexander Wirtz</author><return type="void"/><description/><shortdescription>Calls the draw function for each child in the children-array</shortdescription></doc></function><function name="pc4p_calc_offset" undoc="false" access="private"><doc><author email="hide@address.com">Alexander Wirtz</author><parameter name="&amp;$parent" type="object pc4p_page"/><return type="void"/><description>still fits onto the page. If not, it checks if there&amp;apos;s a following page; ifnot, it creates one, if yes it uses the existing. Moves the overlappingobjects to the new page. In one word: Here&amp;apos;s the pagebreak function!!!</description><shortdescription>Calls the calc_offset function in all children. Checks, if the current object</shortdescription></doc></function><variable name="$children" access="private" type="array">array()<doc><description/><shortdescription>Array of all children of this object</shortdescription></doc></variable><variable name="$pdfp" access="private" type="integer"><doc><description/><shortdescription>PDF-Pointer used for all pdf_*</shortdescription></doc></variable><variable name="$width" access="private" type="integer"><doc><description/><shortdescription>Width of the page</shortdescription></doc></variable><variable name="$height" access="private" type="integer"><doc><description/><shortdescription>Height of the page</shortdescription></doc></variable><variable name="$margin" access="private" type="array">array( &amp;quot;top&amp;quot; =&amp;gt; 5, &amp;quot;bottom&amp;quot; =&amp;gt; 5, &amp;quot;left&amp;quot; =&amp;gt; 5, &amp;quot;right&amp;quot; =&amp;gt; 5 )<doc><description/><shortdescription>Margins for the page</shortdescription></doc></variable><variable name="$act_width" access="private" type="integer"><doc><description/><shortdescription>x-Pos where the page really starts placing objects</shortdescription></doc></variable><variable name="$act_height" access="private" type="integer"><doc><description/><shortdescription>y-Pos where the page really starts placing objects</shortdescription></doc></variable><variable name="$draw_height" access="private" type="integer"><doc><description/><shortdescription>y-Pos used when calculating the positions for the objects</shortdescription></doc></variable><variable name="$bg_image" access="private" type="string"><doc><description/><shortdescription>Name of the background image</shortdescription></doc></variable><variable name="$bgi_type" access="private" type="string"><doc><description/><shortdescription>Type of the background image</shortdescription></doc></variable><variable name="$bgi_xoff" access="private" type="integer"><doc><description/><shortdescription>x-Pos for the background image</shortdescription></doc></variable><variable name="$bgi_yoff" access="private" type="integer"><doc><description/><shortdescription>y-Pos for the background image</shortdescription></doc></variable><variable name="$bgi_scale" access="private" type="float"><doc><description/><shortdescription>Scale for the background image</shortdescription></doc></variable></class></phpdoc>
Return current item: NOLA