Amiro.CMS API Reference
 Amiro.Ru / Manual

Interfaces:
Controller
   AMI_iTx_Cmd
Orphus
Loading search...

The AMI_Tx_Cmd_Storage_ContentModifier class

AMI_Tx_Cmd
   |
   --AMI_Tx_Cmd_Storage
      |
      --AMI_Tx_Cmd_Storage_ContentModifier

• Introduction

Storage content modifier transaction command.

• Class synopsis

AMI_Tx_Cmd_Storage_ContentModifier extends AMI_Tx_Cmd_Storage {
/* Properties */
protected bool $isContentModifier = TRUE;
/* Inherited Properties */
// Flag specifies if previous file was backuped
protected AMI_Tx_Cmd_Storage::$backuped = FALSE;
// Path for backup file
protected AMI_Tx_Cmd_Storage::$backupPath;
// EOL style for conent modifiers
protected AMI_Tx_Cmd_Storage::$eol = "\r\n";
// Storage driver
protected AMI_Tx_Cmd_Storage::$oStorage;
// Backup name
protected AMI_Tx_Cmd::$backupName;
// 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 */
// Add/replace markers.
protected checkMarkers ( string &$content, string $opener, string $closer ) returns bool;
// Creates new if no content present.
protected createNewContent ( ) returns string;
// 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 */
// 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

Sets content to target.
Tags:
abstract
since 6.0.2

• Class Properies

protected bool $isContentModifier

• Class Methods

// Add/replace markers.
protected checkMarkers ( string &$content, string $opener, string $closer ) returns bool;
  • string &$content
    Content
  • string $opener
    Opening marker
  • string $closer
    Closing marker
Add if not found, wipe content if found and have appropriate mode.
// Creates new if no content present.
protected createNewContent ( ) returns string;

Overridden in child classes as: AMI_Tx_Cmd_PHP_ContentModifier::createNewContent(), AMI_Tx_Cmd_Package_HandlersInstaller::createNewContent(), AMI_Tx_Cmd_Tpl_ContentModifier::createNewContent(), AMI_Tx_Cmd_INI_ContentModifier::createNewContent().

Tags:
abstract
// Returns closing marker.
protected getClosingMarker ( ) returns string;

Overridden in child classes as: AMI_Tx_Cmd_PHP_ContentModifier::getClosingMarker(), AMI_Tx_Cmd_Package_HandlersUninstaller::getClosingMarker(), AMI_Tx_Cmd_Tpl_ContentModifier::getClosingMarker(), AMI_Tx_Cmd_INI_ContentModifier::getClosingMarker().

Tags:
abstract
// Returns opening marker.
protected getOpeningMarker ( ) returns string;

Overridden in child classes as: AMI_Tx_Cmd_PHP_ContentModifier::getOpeningMarker(), AMI_Tx_Cmd_Package_HandlersUninstaller::getOpeningMarker(), AMI_Tx_Cmd_Tpl_ContentModifier::getOpeningMarker(), AMI_Tx_Cmd_INI_ContentModifier::getOpeningMarker().

Tags:
abstract
// Content modifier.
protected modify ( string &$content, string $opener, string $closer ) returns void;
  • string &$content
    Content
  • string $opener
    Opening marker
  • string $closer
    Closing marker

Overridden in child classes as: AMI_Tx_Cmd_PHP_ContentIntsall::modify(), AMI_Tx_Cmd_PHP_ContentUninstall::modify(), AMI_Tx_Cmd_Package_HandlersUninstaller::modify(), AMI_Tx_Cmd_Tpl_ContentInstall::modify(), AMI_Tx_Cmd_Tpl_ContentUninstall::modify(), AMI_Tx_Cmd_INI_ContentInstall::modify(), AMI_Tx_Cmd_INI_ContentUninstall::modify().

Tags:
abstract
// Runs command.
protected run ( ) returns void;

Overrides: AMI_Tx_Cmd::run().

Overridden in child classes as: AMI_Tx_Cmd_Package_HandlersInstaller::run(), AMI_Tx_Cmd_Package_HandlersUninstaller::run().

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

Overrides: AMI_Tx_Cmd_Storage::validateArgs().

Overridden in child classes as: AMI_Tx_Cmd_PHP_ContentIntsall::validateArgs(), AMI_Tx_Cmd_Package_HandlersInstaller::validateArgs(), AMI_Tx_Cmd_PHP_ContentUninstall::validateArgs(), AMI_Tx_Cmd_Package_HandlersUninstaller::validateArgs(), AMI_Tx_Cmd_Tpl_ContentModifier::validateArgs(), AMI_Tx_Cmd_Tpl_ContentInstall::validateArgs(), AMI_Tx_Cmd_INI_ContentModifier::validateArgs(), AMI_Tx_Cmd_INI_ContentInstall::validateArgs().