SPFlatFile Class Reference

List of all members.

---

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPFlatFile.

Note:

the class SPFlatFile requires a prior instance of a SPSignWare object

See also:

ACTIVESWLib.ISPFlatFile

Public Member Functions
	createFromBase64Data ($aBase64Data)
	Set the data in a SPFlatFile instance.
	createFromImage ($spImage, $aFmt)
	Set the data in a SPFlatFile instance, the data equals the serialized SPImage object.
	createFromNibbleHex ($strData)
	Set the data in a SPFlatFile instance.
	createFromRawData ($aRawData)
	Set the data in a SPFlatFile instance.
	createFromReference ($spReference)
	Set the data in a SPFlatFile instance, the data equals the serialized SPReference object.
	getBase64Data ()
	Get the base64-encoded data in a SPFlatFile instance.
	getRawData ()
	Get the raw data in a SPFlatFile instance.
	SPFlatFile ()
	Constructor.
Static Public Member Functions
static	convertNibbleHex ($strData)
Public Attributes
	$className = "SPFlatFile"
	Name of this class.
	$com = false
	native COM handle

---

Constructor & Destructor Documentation

SPFlatFile.SPFlatFile (   )

Constructor. Exceptions: Exception  on errors

---

Member Function Documentation

static SPFlatFile.convertNibbleHex (  $  strData  )  [static]

Decode a NibbleHex string

SPFlatFile.createFromBase64Data (  $  aBase64Data  )

Set the data in a SPFlatFile instance. Parameters: $aBase64Data  [i] base64-encoded data Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.CreateFromBase64RawData

SPFlatFile.createFromImage (  $  spImage, $  aFmt )

Set the data in a SPFlatFile instance, the data equals the serialized SPImage object. Parameters: $spImage  [i] SPImage, the image object $aFmt  [i] the format, SP_IMAGE_BMP_WIN, SP_IMAGE_GIF, SP_IMAGE_PNG, SP_IMAGE_TIFF Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.CreateFromImage

SPFlatFile.createFromNibbleHex (  $  strData  )

Set the data in a SPFlatFile instance. Parameters: $strData  [i] nibble-hex encoded data Exceptions: Exception  on errors

SPFlatFile.createFromRawData (  $  aRawData  )

Set the data in a SPFlatFile instance. Parameters: $aRawData  [i] binary raw data Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.CreateFromBase64RawData

SPFlatFile.createFromReference (  $  spReference  )

Set the data in a SPFlatFile instance, the data equals the serialized SPReference object. Parameters: $spReference  [i] SPReference, the reference object Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.CreateFromReference

SPFlatFile.getBase64Data (   )

Get the base64-encoded data in a SPFlatFile instance. Returns: String the base64-encoded binary data Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.GetBase64RawData

SPFlatFile.getRawData (   )

Get the raw data in a SPFlatFile instance. Returns: String the raw binary data Exceptions: Exception  on errors See also: ACTIVESWLib.ISPFlatFile.GetBase64RawData

---

Member Data Documentation

SPFlatFile.$className = "SPFlatFile"

Name of this class.

SPFlatFile.$com = false

native COM handle

---

The documentation for this class was generated from the following file:

• signware_xapi.php