The AMI_PseudoPackage_Uninstall class

AMI_Package_Manipulator
   |
   --AMI_PseudoPackage
      |
      --AMI_PseudoPackage_Uninstall

• Introduction

Transaction uninstalling pseudoinstance (package having no instance).

• Class synopsis

AMI_PseudoPackage_Uninstall extends AMI_PseudoPackage {

/* Properties */

// Audit status for successfull transaction

protected string $auditSuccessStatus = 'deleted';

// Found pseudo record index

protected int $recordIndex;

// Transaction type for audit

protected string $transactionType = 'uninstall';

/* Inherited Properties */

// Package info

protected AMI_PseudoPackage::$aPkgInfo;

// Pseudo records.

protected AMI_PseudoPackage::$aRecords;

// Package install Id

protected AMI_PseudoPackage::$installId;

// Installation mode

protected AMI_PseudoPackage::$mode;

// Transaction arguments

protected AMI_PseudoPackage::$oArgs;

// Package metadata

protected AMI_PseudoPackage::$oMeta;

// Object to manipulate pseudo records file

protected AMI_PseudoPackage::$oStorage;

// Path to pseudo records file

protected AMI_PseudoPackage::$path;

// Package Id

protected AMI_PseudoPackage::$pkgId;

public AMI_Package_Manipulator::$oPkgCommon;

// Array containing class methods to run

protected AMI_Package_Manipulator::$aActions = array();

// Array of transactions

protected AMI_Package_Manipulator::$aTx = array();

// Used to store previous exception

protected AMI_Package_Manipulator::$oException;

// Name for transactions, must be filled in children

protected AMI_Package_Manipulator::$txName;

/* Methods */

// Constructor.

public __construct ( int $installId, [ int $mode = AMI_iTx_Cmd::MODE_COMMON ] ) returns AMI_PseudoPackage_Uninstall;

// Initialization.

protected init ( ) returns void;

// Executes PHP-code during uninstallation.

protected uninstall ( ) returns void;

// Executes PHP-code during hardcore uninstallation.

protected uninstallAll ( ) returns void;

// Updates data in separate declaration file.

protected updateData ( ) returns void;

// Validates initial data.

protected validate ( ) returns void;

/* Inherited Methods */

// Returns module Id.

public AMI_PseudoPackage::getModId ( ) returns string;

// Returns package info.

public AMI_PseudoPackage::getPkgInfo ( ) returns array;

// Initializes transactions.

public AMI_PseudoPackage::init ( ) returns void;

// Drops front and template cache.

protected AMI_PseudoPackage::dropCache ( ) returns void;

// Update state in record of mod manager history table.

protected AMI_PseudoPackage::logFinish ( ) returns void;

// Create record in mod manager history table.

protected AMI_PseudoPackage::logStart ( ) returns void;

// Saves pseudo records.

protected AMI_PseudoPackage::saveRecords ( ) returns void;

// Validates initial data.

protected AMI_PseudoPackage::validate ( ) returns void;

// Do actions.

public AMI_Package_Manipulator::doActions ( ) returns void;

// Runs transactions.

public AMI_Package_Manipulator::run ( ) returns void;

// Adds action.

protected AMI_Package_Manipulator::addAction ( string $method, [ $aArgs = null ] ) returns void;

// Commits transactions.

protected AMI_Package_Manipulator::commit ( ) returns void;

// Converts mode to string representation for logging.

protected AMI_Package_Manipulator::getModeAsString ( int $mode ) returns string;

// Initializes transactions.

protected AMI_Package_Manipulator::initTx ( ) returns void;

// Rollbacks transactions.

protected AMI_Package_Manipulator::rollback ( [ int $index = 0 ] ) returns void;

// Validates initial data.

protected AMI_Package_Manipulator::validate ( ) returns void;

}

• Class Details

Example:

// Root script context
$AMI_ENV_SETTINGS = array(
'mode' => 'full',
'disable_cache' => TRUE
);
require_once 'ami_env.php';
$oResponse = AMI::getSingleton('response');
$oResponse->start();
// 'installId' key value from record at file "_local/modules/declaration/pseudo.php"
$installId = ...;
$oModManipulator = new AMI_PseudoPackage_Uninstall(
$installId,
AMI_iTx_Cmd::MODE_COMMON
);
try{
$oModManipulator->run();
// Success uninstallation
// ...
}catch(AMI_Exception $oExeception){
// Uninstallation failed
d::w('<span style="color: red;">' . $oException->getMessage() . '</span>');
d::trace($oException->getTrace());
}
$oResponse->send();

Tags:

since

6.0.2

• Class Properies

protected string $auditSuccessStatus: Audit status for successfull transaction

protected int $recordIndex: Found pseudo record index

protected string $transactionType: Transaction type for audit

• Class Methods

// Constructor.

public __construct ( int $installId, [ int $mode = AMI_iTx_Cmd::MODE_COMMON ] ) returns AMI_PseudoPackage_Uninstall;

int $installId
Install Id
int $mode
Flags specifying deinstallation mode, AMI_iTx_Cmd::MODE_*

// Initialization.

protected init ( ) returns void;

Overrides: AMI_PseudoPackage::init().

// Executes PHP-code during uninstallation.

protected uninstall ( ) returns void;

// Executes PHP-code during hardcore uninstallation.

protected uninstallAll ( ) returns void;

// Updates data in separate declaration file.

protected updateData ( ) returns void;

// Validates initial data.

protected validate ( ) returns void;

Overrides: AMI_PseudoPackage::validate().

Tags:

throws

AMI_Package_Exception In case of problems.