Class: I2CE PrintedForm Render (Development)

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

This article describes the abstract class I2CE_PrintedForm_Render .

• Extends the class: I2CE_Fuzzy.
• Child Classes:
  • I2CE_PrintedForm_Render_PDF
  • I2CE_PrintedForm_Render_ODT
• 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.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 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 38
• Type: protected string $std_form

$ids

. The ids of the primary form in the relationship

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 42
• Type: protected array $ids

$base_rel_config

The magic data path that we look for the base relationship in.

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 48
• Type: protected string $base_rel_config

$rel

The form relationshiop

• Defined in 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 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 70
• Type: protected $stdConfig

$layoutOptions

. Main options for page layout

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 77
• Type: protected array $layoutOptions

$content

. Content descrtiption

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 81
• Type: protected array $content

$forms

. Indedx by id's of the primary form it is an array of the forms satisfying the relationship

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 266
• Type: protected array $forms

$id

The id of the form currently being processed

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 284
• Type: protected string $id

Methods

__construct()

Constructor

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 56
• 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/lib/I2CE_PrintedForm_Render.php on line 307
• Signature: protected function _render($textProps)
• Parameters:
  • array $textProps
• Returns: boolean
  true on sucess.

addForm()

Adds the form data at the specified position on the current page.

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 390
• Signature: protected function addForm($left_x,$top_y,$formData,$textProps)
• Parameters:
  • int $left_x
  • int $top_y
  • array $formData
    of I2CE_Form
  • array $textProps
• Returns: boolean.
  True on success

addPage()

Add a page to the rendered document

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 526
• Signature: abstract 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.php on line 535
• Signature: abstract 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

getCurrentId()

Gets the id of the form currently being processsed

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 289
• Signature: protected function getCurrentId()
• Returns: string

getFileName()

• Defined in 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 i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 271
• Signature: public function getFormData($id)
• Parameters:
  • $id

getMimeType()

• Defined in 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 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:
  • 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.php on line 508
• Signature: abstract 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

processTextString()

Processes the printf string and args

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 433
• Signature: protected function processTextString($printf,$printf_args,$formData)
• Parameters:
  • string $printf
  • array $printf_args @pram array $formData of I2CE_Form.
  • $formData
• Returns: string

render()

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

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

setCurrentId()

Sets the id of the form currently being processsed

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 297
• Signature: protected function setCurrentId($id)
• Parameters:
  • string $id

validateTextProps()

Validates the text properties

• Defined in i2ce/modules/Forms/modules/PrintedForms/lib/I2CE_PrintedForm_Render.php on line 333
• Signature: protected function validateTextProps($textProps)
• Parameters:
  • array &$textProps

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()