Amiro.CMS API Reference
 Amiro.Ru / Manual

Interfaces:
Controller
   AMI_iTx_Cmd
Orphus
Loading search...

The AMI_Tx_Cmd_DB class

AMI_Tx_Cmd
   |
   --AMI_Tx_Cmd_DB

• Introduction

Abstract database transaction command.

• Class synopsis

AMI_Tx_Cmd_DB extends AMI_Tx_Cmd {
/* Properties */
// Array containing queries to rollback
protected array $aRollback = array();
// DB object
protected AMI_iDB $oDB;
// Flag specifying to replace original file on commit
protected bool $replaceOnCommit;
/* Inherited Properties */
// Backup name
protected AMI_Tx_Cmd::$backupName;
// Command arguments
protected AMI_Tx_Cmd::$oArgs;
// Current transaction object
protected AMI_Tx_Cmd::$oTx;
/* Methods */
// Adds resources of available commands.
public static addResources ( ) returns void;
// Rollbacks command.
public rollback ( ) returns void;
// Executes db query.
protected execSQL ( string $sql, int $type, [ int $flags = 0 ] ) returns void;
// Initializes command.
protected init ( ) returns void;
// Validates passed arguments.
protected validateArgs ( ) returns void;
/* Inherited Methods */
// Constructor.
public AMI_Tx_Cmd::__construct ( $oTx, AMI_Tx_Cmd_Args $oArgs ) returns AMI_Tx_Cmd;
// Returns string containing argements for logging.
public AMI_Tx_Cmd::getLoggingArgs ( ) returns string;
// Returns string containing specifying arguments and values.
protected AMI_Tx_Cmd::argsToString ( [ $aArgs = array() ] ) returns string;
// Initializes command.
protected AMI_Tx_Cmd::init ( ) returns void;
// Runs command.
protected AMI_Tx_Cmd::run ( ) returns void;
// Validates passed arguments.
protected AMI_Tx_Cmd::validateArgs ( ) returns void;
// Validates obligatory arguments.
protected AMI_Tx_Cmd::validateObligatoryArgs ( $aArgs ) returns void;
}

• Class Details

Expects in $oArgs constructor arguments:
  • mode - command execustion mode (AMI_iTx_Cmd::MODE_* constants);
  • source - "create table" query,
  • target - table name.
Tags:
abstract
since 6.0.2

• Class Properies

protected array $aRollback

Array containing queries to rollback

protected AMI_iDB $oDB

DB object

protected bool $replaceOnCommit

Flag specifying to replace original file on commit

• Class Methods

// Adds resources of available commands.
public static addResources ( ) returns void;
// Rollbacks command.
public rollback ( ) returns void;
// Executes db query.
protected execSQL ( string $sql, int $type, [ int $flags = 0 ] ) returns void;
  • string $sql
    DB query
  • int $type
    Query type for throwing exception
  • int $flags
    Flags
Tags:
throws AMI_Tx_Exception In case of db table creation failed.
// Initializes command.
protected init ( ) returns void;

Overrides: AMI_Tx_Cmd::init().

// Validates passed arguments.
protected validateArgs ( ) returns void;

Overrides: AMI_Tx_Cmd::validateArgs().

Overridden in child classes as: AMI_Tx_Cmd_DB_CreateTable::validateArgs(), AMI_Tx_Cmd_DB_Query::validateArgs().