View source for Class: I2CE PrintedForm Render (4.1.6)

{{otherversions|Class: I2CE_PrintedForm_Render}}
This article describes the ''abstract'' class ''I2CE_PrintedForm_Render'' .
*Extends the class: [[Class: I2CE_Fuzzy (4.1.6) | I2CE_Fuzzy]].
*Child Classes:
** [[Class: I2CE_PrintedForm_Render_PDF (4.1.6) | I2CE_PrintedForm_Render_PDF]]
** [[Class: I2CE_PrintedForm_Render_ODT (4.1.6) | I2CE_PrintedForm_Render_ODT]]
*Location: Part of the module [[I2CE Module List (4.1.6)#PrintedForms|PrintedForms]] in the package [https://launchpad.net/i2ce I2CE] 4.1.6-release
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L33 modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 33
*Author: Carl Leitner <litlfred@ibiblio.org>
*Since: v4.0.4
@filesource Class I2CE_PrintedForm_Render
==Variables==
===$std_form===
.  The standardized printed form we are rendeding
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L38 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 38
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $std_form

===$ids===
.  The ids of the primary form in the relationship
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L42 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 42
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $ids

===$base_rel_config===
The magic data path that we look for the base relationship in.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L48 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 48
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $base_rel_config

===$rel===
The form relationshiop
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L66 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 66
*Type: protected I2CE_FormRelationsip $rel

===$stdConfig===
@var protected I2CE_MagicDataNode $stdConfg the magic data node for the standard config
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L70 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 70
*Type: protected $stdConfig

===$layoutOptions===
.  Main options for page layout
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L77 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 77
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $layoutOptions

===$content===
.  Content descrtiption
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L81 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 81
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $content

===$forms===
. Indedx by id's of the primary form it is an array of the forms satisfying the relationship
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L266 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 266
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $forms

===$id===
The id of the form currently being processed
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L284 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 284
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $id

==Methods==
===__construct()===
Constructor
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L56 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 56
*Signature: public function __construct($std_form,$ids,$base_rel_config)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $std_form <br/>The standardized printed form we are rendeding @parm array $ids of string.  The ids of the primary form in the relationship
**$ids 
** [http://www.php.net/manual/en/language.types.string.php string ] $base_rel_config <br/>The magic data path that we look for the base relationship in.  Defaults to /modules/CustomReports/relationships
***Default Value: '/modules/CustomReports/relationships'
===_render()===
business  method to render the forms
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L307 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 307
*Signature: protected function _render($textProps)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $textProps
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess.
===addForm()===
Adds the form data at the specified position on the current page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L390 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 390
*Signature: protected function addForm($left_x,$top_y,$formData,$textProps)
*Parameters:
** [http://www.php.net/manual/en/language.types.integer.php int ] $left_x
** [http://www.php.net/manual/en/language.types.integer.php int ] $top_y
** [http://www.php.net/manual/en/language.types.array.php array ] $formData <br/>of I2CE_Form
** [http://www.php.net/manual/en/language.types.array.php array ] $textProps
*Returns: boolean.<br/>True on success
===addPage()===
Add a page to the rendered document
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L526 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 526
*Signature: abstract protected function addPage($textProps)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $textProps
===display()===
Abstract method to retreive/display the contents of the rendered forms
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L535 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 535
*Signature: abstract public function display($as_string)
*Parameters:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $as_string <br/>Defaults to false
***Default Value: false
*Returns: mixed.<br/>If {$as_string} is false the it is a  boolean true on sucess.  If $as_string is true, then it is a string on success, false on failure
===getCurrentId()===
Gets the id of the form currently being processsed
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L289 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 289
*Signature: protected function getCurrentId()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getFileName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L537 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 537
*Signature: abstract public function getFileName()
===getFormData()===
Get the form data for the given id
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L271 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 271
*Signature: public function getFormData($id)
*Parameters:
**$id 
===getMimeType()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L538 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 538
*Signature: abstract public function getMimeType()
===processElement_image()===
Abstract business method to render a text element from the elements tree
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L519 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 519
*Signature: abstract protected function processElement_image($left_x,$top_y,$formData,$textProps,$elementConfig)
*Parameters:
** [http://www.php.net/manual/en/language.types.integer.php int ] $left_x
** [http://www.php.net/manual/en/language.types.integer.php int ] $top_y
** [http://www.php.net/manual/en/language.types.array.php array ] $formData <br/>of I2CE_Form
** [http://www.php.net/manual/en/language.types.array.php array ] $textProps
** [[Class: I2CE_MagicDataNode (4.1.6) | I2CE_MagicDataNode]] $elementConfig <br/>The node defining the element
*Returns: boolean.<br/>True on success
===processElement_text()===
Abstract business method to render a text element from the elements tree
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L508 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 508
*Signature: abstract protected function processElement_text($left_x,$top_y,$formData,$textProps,$elementConfig)
*Parameters:
** [http://www.php.net/manual/en/language.types.integer.php int ] $left_x
** [http://www.php.net/manual/en/language.types.integer.php int ] $top_y
** [http://www.php.net/manual/en/language.types.array.php array ] $formData <br/>of I2CE_Form
** [http://www.php.net/manual/en/language.types.array.php array ] $textProps
** [[Class: I2CE_MagicDataNode (4.1.6) | I2CE_MagicDataNode]] $elementConfig <br/>The node defining the element
*Returns: boolean.<br/>True on success
===processTextString()===
Processes the printf string and args
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L433 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 433
*Signature: protected function processTextString($printf,$printf_args,$formData)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $printf
** [http://www.php.net/manual/en/language.types.array.php array ] $printf_args @pram array $formData of I2CE_Form.
**$formData 
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===render()===
Abstract method to render the form. Makes sure all ducks are in a row
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L87 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 87
*Signature: public function render()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess.
===setCurrentId()===
Sets the id of the form currently being processsed
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L297 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 297
*Signature: protected function setCurrentId($id)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $id
===validateTextProps()===
Validates the text properties
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.6-release/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php#L333 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php] on line 333
*Signature: protected function validateTextProps($textProps)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] &$textProps
==Inherited Methods==
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (4.1.6)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy (4.1.6)#userMessage() | I2CE_Fuzzy->userMessage()]]


[[Category:Class Documentation (4.1.6)]]