The AMI_Tx_Storage class

AMI_Tx
   |
   --AMI_Tx_Storage

• Introduction

Storage transaction.

• Class synopsis

AMI_Tx_Storage extends AMI_Tx {

/* Properties */

// Array of supported commands

protected array $aCmdResources = array( 'storage/copy' => 'tx/cmd/storage/copy', 'storage/set' => 'tx/cmd/storage/set', 'storage/clean' => 'tx/cmd/storage/clean', 'php/install' => 'tx/cmd/php/install', 'php/uninstall' => 'tx/cmd/php/uninstall', 'tpl/install' => 'tx/cmd/tpl/install', 'tpl/uninstall' => 'tx/cmd/tpl/uninstall', 'ini/install' => 'tx/cmd/ini/install', 'ini/uninstall' => 'tx/cmd/ini/uninstall' );

/* Inherited Properties */

// Array of backup data needed for revert

protected AMI_Tx::$aBackup = array();

// Array of commands

protected AMI_Tx::$aCmds = array();

// Array of executing commands

protected AMI_Tx::$aExecutingCmds = array();

// Array of entities existence flags

protected AMI_Tx::$aExistence = array();

// Array of precommited commands

protected AMI_Tx::$aPrecommitedCmds = array();

// Variable containing current transactions state, using for offline rollback.

protected AMI_Tx::$aState;

// Precommited commands count

protected AMI_Tx::$cmdsCount = 0;

// Failed commit command index in AMI_Tx::$aPrecommitedCmds

protected AMI_Tx::$index;

// Variable containing current transactions state, using for offline rollback.

protected AMI_Tx::$localStateIndex;

// Contains exception fired on commit

protected AMI_Tx::$oCommitException;

// Flag specifying is transaction started

protected AMI_Tx::$started = FALSE;

// Variable containing global transactions state, using for offline rollback.

protected AMI_Tx::$stateIndex = 0;

// State file path

protected AMI_Tx::$statePath;

/* Methods */

// Constructor.

public __construct ( ) returns AMI_Tx_Storage;

// Revert (offline rollback) last tracnsaction.

public revert ( $aRollbackData, [ bool $output = TRUE ] ) returns void;

/* Inherited Methods */

// Logs message to "_admin/_logs/tx.log".

public static AMI_Tx::log ( string $message, [ int $type = self::LOG_NOTE ] ) returns void;

// Add command executed on commit.

public AMI_Tx::addCommand ( string $cmd, [ mixed $data = null ] ) returns void;

// Adds command resources.

public AMI_Tx::addCommandResources ( $aResources ) returns void;

// Commit tracnsaction.

public AMI_Tx::commit ( ) returns void;

// Returns backup entity name or null.

public AMI_Tx::getBackupName ( string $entity, [ $oStorage = null ] ) returns string|null;

// Returns TRUE if transaction is started but not commited.

public AMI_Tx::isStarted ( ) returns bool;

// Rollback tracnsaction.

public AMI_Tx::rollback ( ) returns void;

// Set backup entity name.

public AMI_Tx::setBackupName ( string $entity, string $name, [ $oStorage = null ] ) returns void;

// Set backup entity name.

public AMI_Tx::setExistence ( string $entity, bool $exists, [ $oStorage = null ] ) returns void;

// Start transaction.

public AMI_Tx::start ( strung $name ) returns void;

// Output message.

protected AMI_Tx::output ( string $message, [ bool $output = TRUE ], [ int $type = self::LOG_NOTE ] ) returns void;

// Create and store all tracnsaction commands.

protected AMI_Tx::precommit ( ) returns void;

// Update file containing state fr possible offline rollback.

protected AMI_Tx::updateState ( ) returns void;

}

Tags:

since

6.0.2

• Class Properies

protected array $aCmdResources: Array of supported commands

• Class Methods

// Constructor.

public __construct ( ) returns AMI_Tx_Storage;

// Revert (offline rollback) last tracnsaction.

public revert ( $aRollbackData, [ bool $output = TRUE ] ) returns void;

array $aRollbackData
Rollback data
bool $output
Do output details