Amiro.CMS API Reference
 Amiro.Ru / Manual

Interfaces:
Controller
   AMI_iTx_Cmd
Orphus
Loading search...

The AMI_Tx_Cmd class

• Introduction

Transaction command abstraction.

• Class synopsis

AMI_Tx_Cmd implements AMI_iTx_Cmd {
/* Properties */
// Backup name
protected string $backupName;
// Command arguments
protected AMI_Tx_Cmd_Args $oArgs;
// Current transaction object
protected AMI_iTx $oTx;
// Flag specifying to replace original file on commit
protected bool $replaceOnCommit = TRUE;
/* Methods */
// Constructor.
public __construct ( $oTx, AMI_Tx_Cmd_Args $oArgs ) returns AMI_Tx_Cmd;
// Returns string containing argements for logging.
public getLoggingArgs ( ) returns string;
// Returns string containing specifying arguments and values.
protected argsToString ( [ $aArgs = array() ] ) returns string;
// Initializes command.
protected init ( ) returns void;
// Runs command.
protected run ( ) returns void;
// Validates passed arguments.
protected validateArgs ( ) returns void;
// Validates obligatory arguments.
protected validateObligatoryArgs ( $aArgs ) returns void;
}
Tags:
abstract
since 6.0.2

• Class Properies

protected string $backupName

Backup name

protected AMI_Tx_Cmd_Args $oArgs

Command arguments

protected AMI_iTx $oTx

Current transaction object

protected bool $replaceOnCommit

Flag specifying to replace original file on commit

• Class Methods

// Constructor.
public __construct ( $oTx, AMI_Tx_Cmd_Args $oArgs ) returns AMI_Tx_Cmd;
// Returns string containing argements for logging.
public getLoggingArgs ( ) returns string;

Implementation of: AMI_iTx_Cmd::getLoggingArgs().

Override method to log only useful argements using AMI_Tx_Cmd::argsToString().
// Returns string containing specifying arguments and values.
protected argsToString ( [ $aArgs = array() ] ) returns string;
  • array $aArgs
    Argument names
Tags:
since 6.0.6
// Initializes command.
protected init ( ) returns void;

Overridden in child classes as: AMI_Tx_Cmd_DB::init(), AMI_Tx_Cmd_Storage::init(), AMI_Tx_Cmd_Storage_Cleaner::init(), AMI_Tx_Cmd_PHP_ContentIntsall::init(), AMI_Tx_Cmd_Package_HandlersInstaller::init(), AMI_Tx_Cmd_PHP_ContentUninstall::init(), AMI_Tx_Cmd_Tpl_ContentInstall::init(), AMI_Tx_Cmd_Tpl_ContentUninstall::init(), AMI_Tx_Cmd_INI_ContentInstall::init(), AMI_Tx_Cmd_INI_ContentUninstall::init().

Tags:
see AMI_Tx_Cmd::__construct()
abstract
// Runs command.
protected run ( ) returns void;

Overridden in child classes as: AMI_Tx_Cmd_DB_CreateTable::run(), AMI_Tx_Cmd_DB_DropTable::run(), AMI_Tx_Cmd_DB_Query::run(), AMI_Tx_Cmd_Storage_ContentSetter::run(), AMI_Tx_Cmd_Storage_Copier::run(), AMI_Tx_Cmd_Storage_Cleaner::run(), AMI_Tx_Cmd_Storage_ContentModifier::run(), AMI_Tx_Cmd_Package_HandlersInstaller::run(), AMI_Tx_Cmd_Package_HandlersUninstaller::run().

Tags:
see AMI_Tx_Cmd::__construct()
abstract
// Validates passed arguments.
protected validateArgs ( ) returns void;

Overridden in child classes as: AMI_Tx_Cmd_DB::validateArgs(), AMI_Tx_Cmd_DB_CreateTable::validateArgs(), AMI_Tx_Cmd_DB_Query::validateArgs(), AMI_Tx_Cmd_Storage::validateArgs(), AMI_Tx_Cmd_Storage_Copier::validateArgs(), AMI_Tx_Cmd_Storage_ContentModifier::validateArgs(), AMI_Tx_Cmd_PHP_ContentIntsall::validateArgs(), AMI_Tx_Cmd_Package_HandlersInstaller::validateArgs(), AMI_Tx_Cmd_PHP_ContentUninstall::validateArgs(), AMI_Tx_Cmd_Package_HandlersUninstaller::validateArgs(), AMI_Tx_Cmd_Tpl_ContentModifier::validateArgs(), AMI_Tx_Cmd_Tpl_ContentInstall::validateArgs(), AMI_Tx_Cmd_INI_ContentModifier::validateArgs(), AMI_Tx_Cmd_INI_ContentInstall::validateArgs().

Tags:
see AMI_Tx_Cmd::__construct()
abstract
// Validates obligatory arguments.
protected validateObligatoryArgs ( $aArgs ) returns void;
  • array $aArgs
    Arguments to validate
Tags:
throws AMI_Tx_Exception In case of missing obligatory argument.