Class: I2CE PrintedForm Render ODT (Development)

For other versions, see Class: I2CE_PrintedForm_Render_ODT (versions) .

This article describes the class I2CE_PrintedForm_Render_ODT .

• Extends the class: I2CE_PrintedForm_Render.
• Location: Part of the module PrintedFormsODT in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.4

@filesource Class I2CE_PrintedForm_Render

Variables

$images

array $images of binary image data . Keys are the file names to be stored in the Pictures directory, values are the blob data.

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 50
• Type: protected procted $images

$odf

odf

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 67
• Type: protected Odf $odf

$template_file

. The absolute file location of the template we are reading from

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 173
• Type: protected string $template_file

$template_vars

An array of the referenced template variables in content.xml

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 178
• Type: protected array $template_vars

$output

. Indedx by id's of the output files

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 183
• Type: protected array $output

$formData

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 185
• Type: protected $formData

$user

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 187
• Type: protected $user

Methods

__construct()

Constructor

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 58
• Signature: public function __construct($std_form,$ids,$base_rel_config)
• Parameters:
  • string $std_form
    The standardized printed form we are rendeding @parm array $ids of string. The ids of the primary form in the relationship
  • $ids
  • string $base_rel_config
    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 i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 193
• Signature: protected function _render($textProps)
• Parameters:
  • array $textProps
• Returns: boolean
  true on sucess.

addPage()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 43
• Signature: protected function addPage($textProps)
• Parameters:
  • $textProps

display()

Abstract method to retreive/display the contents of the rendered forms

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 280
• Signature: public function display($as_string)
• Parameters:
  • boolean $as_string
    Defaults to false
    • Default Value: false
• 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/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 300
• Signature: public function getFileName()

getMimeType()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 296
• Signature: public function getMimeType()

processElement_image()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 39
• Signature: protected function processElement_image($left_x,$top_y,$formData,$textProps,$elementConfig)
• Parameters:
  • $left_x
  • $top_y
  • $formData
  • $textProps
  • $elementConfig

processElement_text()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 35
• Signature: protected function processElement_text($left_x,$top_y,$formData,$textProps,$elementConfig)
• Parameters:
  • $left_x
  • $top_y
  • $formData
  • $textProps
  • $elementConfig

render()

Abstract method to render the form. Makes sure all ducks are in a row

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_PrintedForm_Render_ODT.php on line 73
• Signature: public function render()
• Returns: boolean
  true on sucess.

Inherited Methods

getFormData()

This public method is inherited from I2CE_PrintedForm_Render->getFormData()

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()