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

The AMI_Tx_Cmd_PHP_ContentModifier class

AMI_Tx_Cmd
   |
   --AMI_Tx_Cmd_Storage
      |
      --AMI_Tx_Cmd_Storage_ContentModifier
         |
         --AMI_Tx_Cmd_PHP_ContentModifier

• Introduction

PHP-file content modifier.

• Class synopsis

AMI_Tx_Cmd_PHP_ContentModifier extends AMI_Tx_Cmd_Storage_ContentModifier {
/* 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 */
// Creates new if no content present.
protected createNewContent ( ) returns string;
// Returns closing marker.
protected getClosingMarker ( ) returns string;
// Returns opening marker.
protected getOpeningMarker ( ) returns string;
/* Inherited Methods */
// 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;
}
Tags:
abstract
since 6.0.2

• Class Methods

// Creates new if no content present.
protected createNewContent ( ) returns string;
// Returns closing marker.
protected getClosingMarker ( ) returns string;
// Returns opening marker.
protected getOpeningMarker ( ) returns string;