Amiro.CMS API Reference
Amiro.Ru / Manual
Loading search...

The AMI_PseudoPackage class

AMI_Package_Manipulator
   |
   --AMI_PseudoPackage

• Introduction

Common class for transaction installing/uninstailing pseudoinstance.

• Class synopsis

AMI_PseudoPackage extends AMI_Package_Manipulator {
/* Properties */
// Package info
protected array $aPkgInfo;
// Pseudo records.
protected array $aRecords;
// Package install Id
protected int $installId;
// Installation mode
protected int $mode;
// Transaction arguments
protected AMI_Tx_Cmd_Args $oArgs;
// Package metadata
protected array $oMeta;
// Object to manipulate pseudo records file
// Path to pseudo records file
protected type $path;
// Package Id
protected string $pkgId;
/* Inherited Properties */
// 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
// Name for transactions, must be filled in children
/* Methods */
// Returns module Id.
public getModId ( ) returns string;
// Returns package info.
public getPkgInfo ( ) returns array;
// Initializes transactions.
public init ( ) returns void;
// Drops front and template cache.
protected dropCache ( ) returns void;
// Update state in record of mod manager history table.
protected logFinish ( ) returns void;
// Create record in mod manager history table.
protected logStart ( ) returns void;
// Saves pseudo records.
protected saveRecords ( ) returns void;
// Validates initial data.
protected validate ( ) returns void;
/* Inherited Methods */
// 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;
}
Tags:
abstract
since 6.0.2

• Class Properies

protected array $aPkgInfo

Package info

protected array $aRecords

Pseudo records.

protected int $installId

Package install Id

protected int $mode

Installation mode

protected AMI_Tx_Cmd_Args $oArgs

Transaction arguments

protected array $oMeta

Package metadata

protected AMI_Storage_FS $oStorage

Object to manipulate pseudo records file

protected type $path

Path to pseudo records file

protected string $pkgId

Package Id

• Class Methods

// Returns module Id.
public getModId ( ) returns string;
// Returns package info.
public getPkgInfo ( ) returns array;
// Initializes transactions.
public init ( ) returns void;

Overridden in child classes as: AMI_PseudoPackage_Uninstall::init().

// Drops front and template cache.
protected dropCache ( ) returns void;
// Update state in record of mod manager history table.
protected logFinish ( ) returns void;
Tags:
throws AMI_Tx_Exception In case of problems.
// Create record in mod manager history table.
protected logStart ( ) returns void;
// Saves pseudo records.
protected saveRecords ( ) returns void;
// Validates initial data.
protected validate ( ) returns void;

Overrides: AMI_Package_Manipulator::validate().

Overridden in child classes as: AMI_PseudoPackage_Uninstall::validate().

Tags:
throws AMI_Package_Exception In case of problems.