Class: I2CE PrintedForm Render PDF (Development): Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
This article describes the class ''I2CE_PrintedForm_Render_PDF'' . | This article describes the class ''I2CE_PrintedForm_Render_PDF'' . | ||
*Extends the class: [[Class: I2CE_PrintedForm_Render (Development) | I2CE_PrintedForm_Render]]. | *Extends the class: [[Class: I2CE_PrintedForm_Render (Development) | I2CE_PrintedForm_Render]]. | ||
*Location: Part of the module [[I2CE Module List (Development)#PrintedForms|PrintedForms]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#PrintedForms|PrintedForms]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L33 modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 33 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
*Since: v4.0.5 | *Since: v4.0.5 | ||
| Line 10: | Line 10: | ||
===$pdf=== | ===$pdf=== | ||
The PDF we are rendering | The PDF we are rendering | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L37 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 37 | ||
*Type: protected [[Class: I2CE_PDF (Development) | I2CE_PDF]] $pdf | *Type: protected [[Class: I2CE_PDF (Development) | I2CE_PDF]] $pdf | ||
| Line 16: | Line 16: | ||
===_render()=== | ===_render()=== | ||
business method to render the forms | business method to render the forms | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L62 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 62 | ||
*Signature: protected function _render($textProps) | *Signature: protected function _render($textProps) | ||
*Parameters: | *Parameters: | ||
| Line 23: | Line 23: | ||
===addPage()=== | ===addPage()=== | ||
Add a page to the rendered document | Add a page to the rendered document | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L103 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 103 | ||
*Signature: protected function addPage($textProps) | *Signature: protected function addPage($textProps) | ||
*Parameters: | *Parameters: | ||
| Line 29: | Line 29: | ||
===display()=== | ===display()=== | ||
Abstract method to retreive/display the contents of the rendered forms | Abstract method to retreive/display the contents of the rendered forms | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L43 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 43 | ||
*Signature: public function display($as_string) | *Signature: public function display($as_string) | ||
*Parameters: | *Parameters: | ||
| Line 35: | Line 35: | ||
***Default Value: 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 | *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 | ||
===getFileName()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L286 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 286 | |||
*Signature: public function getFileName() | |||
===getMimeType()=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L290 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 290 | |||
*Signature: public function getMimeType() | |||
===processElement_image()=== | ===processElement_image()=== | ||
Abstract business method to render a text element from the elements tree | Abstract business method to render a text element from the elements tree | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L200 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 200 | ||
*Signature: protected function processElement_image($left_x,$top_y,$formData,$textProps,$elementConfig) | *Signature: protected function processElement_image($left_x,$top_y,$formData,$textProps,$elementConfig) | ||
*Parameters: | *Parameters: | ||
| Line 48: | Line 54: | ||
===processElement_text()=== | ===processElement_text()=== | ||
Abstract business method to render a text element from the elements tree | Abstract business method to render a text element from the elements tree | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L133 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 133 | ||
*Signature: protected function processElement_text($left_x,$top_y,$formData,$textProps,$elementConfig) | *Signature: protected function processElement_text($left_x,$top_y,$formData,$textProps,$elementConfig) | ||
*Parameters: | *Parameters: | ||
| Line 59: | Line 65: | ||
===setTextProps()=== | ===setTextProps()=== | ||
Sets the text properties for the pdf | Sets the text properties for the pdf | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php#L80 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php] on line 80 | ||
*Signature: protected function setTextProps($textProps) | *Signature: protected function setTextProps($textProps) | ||
*Parameters: | *Parameters: | ||
Latest revision as of 09:18, 6 May 2015
For other versions, see Class: I2CE_PrintedForm_Render_PDF (versions) .
This article describes the class I2CE_PrintedForm_Render_PDF .
- Extends the class: I2CE_PrintedForm_Render.
- Location: Part of the module PrintedForms in the package I2CE 4.1-dev
- Source: Defined in the file modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 33
- Author: Carl Leitner <litlfred@ibiblio.org>
- Since: v4.0.5
@filesource Class I2CE_PrintedForm_Render_PDF
Variables
The PDF we are rendering
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 37
- Type: protected I2CE_PDF $pdf
Methods
_render()
business method to render the forms
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 62
- Signature: protected function _render($textProps)
- Parameters:
- array $textProps
- Returns: boolean
true on sucess.
addPage()
Add a page to the rendered document
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 103
- Signature: protected function addPage($textProps)
- Parameters:
- array $textProps
display()
Abstract method to retreive/display the contents of the rendered forms
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 43
- Signature: public function display($as_string)
- Parameters:
- boolean $as_string
Defaults to false- Default Value: false
- boolean $as_string
- Returns: mixed.
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
getFileName()
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 286
- Signature: public function getFileName()
getMimeType()
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 290
- Signature: public function getMimeType()
processElement_image()
Abstract business method to render a text element from the elements tree
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 200
- Signature: protected function processElement_image($left_x,$top_y,$formData,$textProps,$elementConfig)
- Parameters:
- int $left_x
- int $top_y
- array $formData
of I2CE_Form - array $textProps
- I2CE_MagicDataNode $elementConfig
The node defining the element
- Returns: boolean.
True on success
processElement_text()
Abstract business method to render a text element from the elements tree
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 133
- Signature: protected function processElement_text($left_x,$top_y,$formData,$textProps,$elementConfig)
- Parameters:
- int $left_x
- int $top_y
- array $formData
of I2CE_Form - array $textProps
- I2CE_MagicDataNode $elementConfig
The node defining the element
- Returns: boolean.
True on success
setTextProps()
Sets the text properties for the pdf
- Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render_PDF.php on line 80
- Signature: protected function setTextProps($textProps)
- Parameters:
- $textProps
Inherited Methods
__construct()
This public method is inherited from I2CE_PrintedForm_Render->__construct()
getFormData()
This public method is inherited from I2CE_PrintedForm_Render->getFormData()
render()
This public method is inherited from I2CE_PrintedForm_Render->render()
addForm()
This protected method is inherited from I2CE_PrintedForm_Render->addForm()
getCurrentId()
This protected method is inherited from I2CE_PrintedForm_Render->getCurrentId()
processTextString()
This protected method is inherited from I2CE_PrintedForm_Render->processTextString()
setCurrentId()
This protected method is inherited from I2CE_PrintedForm_Render->setCurrentId()
validateTextProps()
This protected method is inherited from I2CE_PrintedForm_Render->validateTextProps()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$std_form
Theis protected variable is inherited from I2CE_PrintedForm_Render->$std_form
$ids
Theis protected variable is inherited from I2CE_PrintedForm_Render->$ids
$base_rel_config
Theis protected variable is inherited from I2CE_PrintedForm_Render->$base_rel_config
$rel
Theis protected variable is inherited from I2CE_PrintedForm_Render->$rel
$stdConfig
Theis protected variable is inherited from I2CE_PrintedForm_Render->$stdConfig
$layoutOptions
Theis protected variable is inherited from I2CE_PrintedForm_Render->$layoutOptions
$content
Theis protected variable is inherited from I2CE_PrintedForm_Render->$content
$forms
Theis protected variable is inherited from I2CE_PrintedForm_Render->$forms
$id
Theis protected variable is inherited from I2CE_PrintedForm_Render->$id
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()
