Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes

WobTransactionBase Class Reference

List of all members.

Public Member Functions

 getHeader ($hd)
 notAuthenticated ()
 xmlParserError ()
 handleException ($ex)
 abortWithError ($text, $type="server")

Static Public Member Functions

static getExecutingName ()
static getInstance ()
 returns the currently running instance of a transaction
static getTransactionNameWob ()
static getTransactionNameSoap ()
static noSuchTransaction ()

Public Attributes

const WobEncoding = 0
const Soap12Encoding = 1

Protected Member Functions

 __construct ()
 getRequestXml ()
 abortNotImplemented ()
 startTransaction ($updating)
 commitTransaction ()
 abortTransaction ()
 isAuthenticated ()
 isAuthorized ($transactioName)
 userName ()
 xmlCreate ($elem)
 xmlToString ($xml)

Protected Attributes

 $ainput
 $tinput
 $aoutput
 $toutput
 $headers = array()

Static Protected Attributes

static $running = ""
static $instance = null

Detailed Description

Ancestor of all Transactions


Constructor & Destructor Documentation

WobTransactionBase::__construct (  )  [protected]

Member Function Documentation

WobTransactionBase::abortNotImplemented (  )  [protected]

called internally if a transaction is not implemented

WobTransactionBase::abortTransaction (  )  [protected]

stub: overwrite this to implement a real transaction abort action (eg. sending the DB a "ROLLBACK TRANSACTION" statement)

WobTransactionBase::abortWithError ( text,
type = "server" 
)

called to abort a transactions flow

Parameters:
$type optional defines the source of the error (should be only one word, defaults to "server")
$text the human readable text returned to the client
WobTransactionBase::commitTransaction (  )  [protected]

stub: overwrite this to implement a real transaction commit action (eg. sending the DB a "COMMIT TRANSACTION" statement)

static WobTransactionBase::getExecutingName (  )  [static]

returns the name of the currently running transaction

WobTransactionBase::getHeader ( hd  ) 

called to determine the session id or other headers

static WobTransactionBase::getInstance (  )  [static]

returns the currently running instance of a transaction

WobTransactionBase::getRequestXml (  )  [protected]

retrieves the XML data from the request and parses headers

static WobTransactionBase::getTransactionNameSoap (  )  [static]

called to determine the correct transaction, aborts the script if there is none.

static WobTransactionBase::getTransactionNameWob (  )  [static]

Wob message encoding: called to determine the correct transaction, aborts the script if there is none.

WobTransactionBase::handleException ( ex  ) 

called for generic exception handling

WobTransactionBase::isAuthenticated (  )  [protected]

stub: returns whether the user is authenticated, overwrite if you want to use authenticated or authorized transactions

WobTransactionBase::isAuthorized ( transactioName  )  [protected]

stub: returns whether the user is authorized to run a specific transaction, overwrite if you want to use authorized transactions

static WobTransactionBase::noSuchTransaction (  )  [static]

called if the transaction is not known. aborts the script.

WobTransactionBase::notAuthenticated (  ) 

called if authentication fails

WobTransactionBase::startTransaction ( updating  )  [protected]

stub: overwrite this to implement a real transaction start action (eg. sending the DB a "BEGIN TRANSACTION" statement); the $updating parameter is set to true for transactions marked as updating

WobTransactionBase::userName (  )  [protected]

stub: returns the name of the user (default returns empty string)

WobTransactionBase::xmlCreate ( elem  )  [protected]

internal: returns an initialized XML array ("doc"=>DomDocument, "root"=>transaction rool DomElement)

WobTransactionBase::xmlParserError (  ) 

called if XML parsing fails

WobTransactionBase::xmlToString ( xml  )  [protected]

internal: converts XML array to string representation


Member Data Documentation

WobTransactionBase::$ainput [protected]
WobTransactionBase::$aoutput [protected]
WobTransactionBase::$headers = array() [protected]
WobTransactionBase::$instance = null [static, protected]
WobTransactionBase::$running = "" [static, protected]
WobTransactionBase::$tinput [protected]
WobTransactionBase::$toutput [protected]

encode messages in a mode compatible with SOAP 1.2, which is much less effective than WobEncoding

encode messages according to PACK standard - with minimal XML levels


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