Class: I2CE Odf (Development)

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

This article describes the class I2CE_Odf .

• Extends the class: Odf.
• 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_Odf.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.4

@filesource Class I2CE_PrintedForm_Render

Variables

$stylesXml

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 35
• Type: protected $stylesXml

$styleVars

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 65
• Type: protected $styleVars

$global_segment

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 110
• Type: protected $global_segment

$image_blobs

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 263
• Type: protected $image_blobs

Methods

__construct()

Class constructor @param string $filename the name of the odt file @throws OdfException

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 44
• Signature: public function __construct($file,$config)
• Parameters:
  • $file
  • $config
    • Default Value: array()

_parse()

Merge template variables Called automatically for a save

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 91
• Signature: protected function _parse()
• Returns: void

_save()

Internal save @throws OdfException

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 273
• Signature: protected function _save()
• Returns: void

addImageBlob()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 259
• Signature: public function addImageBlob($filename,$value)
• Parameters:
  • $filename
  • $value

addImageToManifest()

Update Manifest file according to added image files

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 304
• Signature: public function addImageToManifest($file)
• Parameters:
  • string $file
    Image file to add into manifest content

mergeGlobalSegment()

Add the merged segment to the document @throws OdfException

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 125
• Signature: public function mergeGlobalSegment()
• Returns: odf

mergeSegment()

Add the merged segment to the document

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 170
• Signature: public function mergeSegment($segment)
• Parameters:
  • Segment $segment @throws OdfException
• Returns: odf

setField()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 99
• Signature: public function setField($key,$fieldObj,$extra)
• Parameters:
  • $key
  • $fieldObj
  • $extra
    • Default Value: array()

setGlobalSegment()

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 111
• Signature: public function setGlobalSegment()

setImageFromField()

Assign a template variable as a picture @param string $value path to the picture @throws OdfException

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 192
• Signature: protected function setImageFromField($key,$fieldObj,$extra)
• Parameters:
  • string $key
    name of the variable within the template
  • $fieldObj
  • $extra
    • Default Value: array()
• Returns: odf

setSegment()

Declare a segment in order to use it in a loop

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 147
• Signature: public function setSegment($segment)
• Parameters:
  • string $segment @throws OdfException
• Returns: Segment

setStyleVars()

Assing a style template variable

• Defined in i2ce/modules/Forms/modules/PrintedForms/modules/PrintedFormODT/lib/I2CE_Odf.php on line 75
• Signature: public function setStyleVars($key,$value,$encode,$charset)
• Parameters:
  • string $key
    name of the variable within the template
  • string $value
    replacement value
  • bool $encode
    if true, special XML characters are encoded @throws OdfException
    • Default Value: true
  • $charset
    • Default Value: 'ISO-8859'
• Returns: odf