SPSignWare Class Reference

Detailed Description

PHP Wrapper around the COM object ActiveSW.SPSignWare.

See also:: ACTIVESWLib.ISPSignware

Public Member Functions

getBrowserTicket ($aRequest)

Calculate the Browser Ticket for the specified response URL.

getCurrentTime ()

Query the current time.

getDaysLM ()

Query the license expiry.

getErrorString ($aNum)

Convert an error code to a readable string.

getInstallationCode ()

Query the SignWare installation code.

getVersion ()

Query the SignWare version.

SPSignWare ()

Constructor.

Public Attributes

$className = "SPSignWare"

Name of this class.

$com = false

native COM handle

$iNeedTicket = 0

flag, boolean, true: license manager is configured for ticket licenses

Constructor & Destructor Documentation

SPSignWare.SPSignWare ( )

Constructor.

Exceptions:

Exception on errors

Note:
The constructor creates and loads tickets if required.
The constructor checks License and minimum SignWare Version

Member Function Documentation

SPSignWare.getBrowserTicket ( $ aRequest )

Calculate the Browser Ticket for the specified response URL.

Parameters:

$aRequest [i] the response URL

Exceptions:

Exception on errors

Note:
A SignWare Ticket will be created and charged if required

See also:
ACTIVESWLib.ISPSignware.GetBrowserTicket

SPSignWare.getCurrentTime ( )

Query the current time.

Exceptions:

Exception on errors

Note:
The SignWare time is returned as a unix timestamp, number of seconds since 1st January 1970, GMT
Make sure that the time zone is correctly set in the PHP configuration php.ini

SPSignWare.getDaysLM ( )

Query the license expiry.

Returns:
int number of days until the license expres, -1 license is expired, 0: license expires today

Exceptions:

Exception on errors

See also:
ACTIVESWLib.ISPSignware.DaysLM

SPSignWare.getErrorString ( $ aNum )

Convert an error code to a readable string.

Exceptions:

Exception on errors

Returns:
The SignWare error string

Note:
Function GetErrorString was added in SignWare COM Library Version 2.0, SignWare V 2.5. The string "Unknown Error" will be returned if SignWare COM library is too old

See also:
ACTIVESWLib.ISPSignware.GetErrorString

SPSignWare.getInstallationCode ( )

Query the SignWare installation code.

Returns:
Installation code as String

Exceptions:

Exception on errors

Note:
The SignWare installation code is required to buy a license which will be registered for the installation code. The installation code may depend on the actual hardware and installation of signware; this means you cannot copy or move a license.

See also:
ACTIVESWLib.ISPSignware.GetInstallationCode

SPSignWare.getVersion ( )

Query the SignWare version.

Exceptions:

Exception on errors

Note:
The SignWare version is returned as an int Mmm00rrr where M is the Major, mm the Minor and rrr the Revision numbers

See also:
ACTIVESWLib.ISPSignware.GetVersionInt

Member Data Documentation

SPSignWare.$className = "SPSignWare"

Name of this class.

SPSignWare.$com = false

native COM handle

SPSignWare.$iNeedTicket = 0

flag, boolean, true: license manager is configured for ticket licenses

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

signware_xapi.php


Public Member Functions
	getBrowserTicket ($aRequest)
	Calculate the Browser Ticket for the specified response URL.
	getCurrentTime ()
	Query the current time.
	getDaysLM ()
	Query the license expiry.
	getErrorString ($aNum)
	Convert an error code to a readable string.
	getInstallationCode ()
	Query the SignWare installation code.
	getVersion ()
	Query the SignWare version.
	SPSignWare ()
	Constructor.
Public Attributes
	$className = "SPSignWare"
	Name of this class.
	$com = false
	native COM handle
	$iNeedTicket = 0
	flag, boolean, true: license manager is configured for ticket licenses