The AMI_Package_Common class

• Introduction

Installation/uninstallation common functionality and data.

• Class synopsis

AMI_Package_Common {

/* Constants */

const AMI_Package_Common::LOG_FAILURE = 2;

const AMI_Package_Common::LOG_FINISH = 3;

const AMI_Package_Common::LOG_START = 1;

/* Properties */

// Package info

protected array $aPkgInfo;

// Filesystem path to config depending on hypermodule/config

protected string $configPath;

// Filesystem path to shared hyper resources

protected string $hyperPath;

// Package install Id

protected int $installId;

// Flag specifying that local (custom) config is used

protected bool $isLocalConfigUsed = FALSE;

// Filesystem path to local module resources

protected string $localModPath;

// Filesystem path to local resources

protected string $localPath;

// Package Id

protected string $pkgId;

// Package uninstall Id

protected int $uninstallId;

/* Methods */

// Adds status message during installation/uninstallation.

public static addStatusMessage ( $message, [ $aParams = array() ], [ $type = AMI_Sesponse::STATUS_MESSAGE ], [ $modId = '' ] ) returns void;

// Returns dependent packages information.

public static getDependentPackages ( string $pkgId ) returns array;

// Loads extra status messages locales from file stored in configuration folder.

public loadStatusMessages ( string $file ) returns void;

// Getter returning protected object properties.

public __get ( string $name ) returns mixed;

}

Tags:

property-read	string $hyperPath: Filesystem path to shared hyper resources
property-read	string $localPath: Filesystem path to local resources
property-read	string $localModPath: Filesystem path to local module resources
property-read	string $configPath: Filesystem path to config depending on hypermodule/config
property-read	bool $isLocalConfigUsed: Flag specifying that local (custom) config is used
property-read	string $pkgId: Package Id
property-read	array $aPkgInfo: Package info
property-read	bool $installId: Package install Id
property-read	bool $uninstallId: Package uninstall Id
since	6.0.6

• Class Constants

LOG_FAILURE

LOG_FINISH

LOG_START

• Class Properies

protected array $aPkgInfo: Package info

protected string $configPath: Filesystem path to config depending on hypermodule/config

protected string $hyperPath: Filesystem path to shared hyper resources

protected int $installId: Package install Id

protected bool $isLocalConfigUsed: Flag specifying that local (custom) config is used

protected string $localModPath: Filesystem path to local module resources

protected string $localPath: Filesystem path to local resources

protected string $pkgId: Package Id

protected int $uninstallId: Package uninstall Id

• Class Methods