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

The AMI_Tx_Cmd_Package_HandlersUninstaller class

AMI_Tx_Cmd
   |
   --AMI_Tx_Cmd_Storage
      |
      --AMI_Tx_Cmd_Storage_ContentModifier
         |
         --AMI_Tx_Cmd_PHP_ContentModifier
            |
            --AMI_Tx_Cmd_PHP_ContentUninstall
               |
               --AMI_Tx_Cmd_Package_HandlersUninstaller

• Introduction

Event handlers uninstallation transaction command.

• Class synopsis

AMI_Tx_Cmd_Package_HandlersUninstaller extends AMI_Tx_Cmd_PHP_ContentUninstall {
/* Inherited Properties */
// Flag specifies if previous file was backuped
protected AMI_Tx_Cmd_Storage::$backuped = FALSE;
// Path for backup file
// EOL style for conent modifiers
protected AMI_Tx_Cmd_Storage::$eol = "\r\n";
// Storage driver
// Backup name
// Command arguments
protected AMI_Tx_Cmd::$oArgs;
// Current transaction object
protected AMI_Tx_Cmd::$oTx;
// Flag specifying to replace original file on commit
protected AMI_Tx_Cmd::$replaceOnCommit = TRUE;
/* Methods */
// Returns closing marker.
protected getClosingMarker ( ) returns string;
// Returns opening marker.
protected getOpeningMarker ( ) returns string;
// Content modifier.
protected modify ( string &$content, string $opener, string $closer ) returns void;
// Runs command.
protected run ( ) returns void;
// Validates passed arguments.
protected validateArgs ( ) returns void;
/* Inherited Methods */
// Initializes command.
protected AMI_Tx_Cmd_PHP_ContentUninstall::init ( ) returns void;
// Content modifier.
protected AMI_Tx_Cmd_PHP_ContentUninstall::modify ( string &$content, string $opener, string $closer ) returns void;
// Validates passed arguments.
protected AMI_Tx_Cmd_PHP_ContentUninstall::validateArgs ( ) returns void;
// Creates new if no content present.
protected AMI_Tx_Cmd_PHP_ContentModifier::createNewContent ( ) returns string;
// Returns closing marker.
protected AMI_Tx_Cmd_PHP_ContentModifier::getClosingMarker ( ) returns string;
// Returns opening marker.
protected AMI_Tx_Cmd_PHP_ContentModifier::getOpeningMarker ( ) returns string;
// Add/replace markers.
protected AMI_Tx_Cmd_Storage_ContentModifier::checkMarkers ( string &$content, string $opener, string $closer ) returns bool;
// Creates new if no content present.
// Returns closing marker.
// Returns opening marker.
// Content modifier.
protected AMI_Tx_Cmd_Storage_ContentModifier::modify ( string &$content, string $opener, string $closer ) returns void;
// Runs command.
protected AMI_Tx_Cmd_Storage_ContentModifier::run ( ) returns void;
// Validates passed arguments.
// Adds resources of available commands.
public static AMI_Tx_Cmd_Storage::addResources ( ) returns void;
// Commits command.
public AMI_Tx_Cmd_Storage::commit ( ) returns void;
// Rollbacks command.
public AMI_Tx_Cmd_Storage::rollback ( ) returns void;
// Backups target file.
protected AMI_Tx_Cmd_Storage::backup ( ) returns void;
// Copies source to target file.
protected AMI_Tx_Cmd_Storage::copy ( ) returns void;
// Initializes command.
protected AMI_Tx_Cmd_Storage::init ( ) returns void;
// Sets target file content.
protected AMI_Tx_Cmd_Storage::set ( [ string $content = null ] ) returns void;
// Validates passed arguments.
protected AMI_Tx_Cmd_Storage::validateArgs ( ) returns void;
// 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

  Example:
  •  // "uninstall_before.php" / "uninstall_after.php" / "uninstall.php" / "uninstall_all.php" context
  •  
  •  $srcPath dirname(__FILE__'/';
  •  $targetPath AMI_Registry::get('path/root''_local/';
  •  
  •  $oStorage AMI::getResource('storage/fs');
  •  
  •  $file 'common_functions.php';
  •  $oArgs new AMI_Tx_Cmd_Args(
  •      array(
  •          // Package Id
  •          'pkgId'    => $this->oArgs->pkgId,
  •          // Hypermodule
  •          'hypermod' => $this->oArgs->hypermod,
  •          // Configuration
  •          'config'   => $this->oArgs->config,
  •          // Instance Id
  •          'modId'    => $this->oArgs->modId,
  •          // Installation mode
  •          'mode'     => $this->oArgs->mode,
  •          // Target PHP-file to patch
  •          'target'   => $targetPath $file,
  •          // Storage driver
  •          'oStorage' => $oStorage
  •      )
  •  );
  •  $this->aTx['storage']->addCommand('pkg/handlers/uninstall'$oArgs);
Tags:
resource tx/cmd/pkg/handlers/uninstall AMI::getResource('tx/cmd/pkg/handlers/uninstall')
since 6.0.6

• Class Methods

// Returns closing marker.
protected getClosingMarker ( ) returns string;
// Returns opening marker.
protected getOpeningMarker ( ) returns string;
// Content modifier.
protected modify ( string &$content, string $opener, string $closer ) returns void;
  • string &$content
    Content
  • string $opener
    Opening marker
  • string $closer
    Closing marker

Overrides: AMI_Tx_Cmd_PHP_ContentUninstall::modify().

Wipes all configure/hypermodule content.
// Runs command.
protected run ( ) returns void;

Overrides: AMI_Tx_Cmd_Storage_ContentModifier::run().

Patches passed file.
Tags:
throws AMI_Tx_Exception In case of missing obligatory argument.
// Validates passed arguments.
protected validateArgs ( ) returns void;

Overrides: AMI_Tx_Cmd_PHP_ContentUninstall::validateArgs().

Tags:
see AMI_Cmd::__construct()