The AMI_Tx_Cmd_PHP_ContentIntsall class

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

• Introduction

Transaction command adding PHP-file content.

• Class synopsis

AMI_Tx_Cmd_PHP_ContentIntsall extends AMI_Tx_Cmd_PHP_ContentModifier {

/* Properties */

// Obligatory arguments.

protected array $aObligatoryArgs = array('source');

/* Inherited Properties */

protected AMI_Tx_Cmd_Storage_ContentModifier::$isContentModifier = TRUE;

// 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 */

// Callback filterring objects from arguments.

protected cbFilterObjects ( mixed $value ) returns bool;

// Callback converting key to template variable name.

protected cbToTplVar ( string $key ) returns string;

// Initializes command.

protected init ( ) returns void;

// Content modifier.

protected modify ( string &$content, string $opener, string $closer ) returns void;

// Validates passed arguments.

protected validateArgs ( ) returns void;

/* Inherited Methods */

// 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.

protected AMI_Tx_Cmd_Storage_ContentModifier::createNewContent ( ) returns string;

// Returns closing marker.

protected AMI_Tx_Cmd_Storage_ContentModifier::getClosingMarker ( ) returns string;

// Returns opening marker.

protected AMI_Tx_Cmd_Storage_ContentModifier::getOpeningMarker ( ) returns string;

// 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.

protected AMI_Tx_Cmd_Storage_ContentModifier::validateArgs ( ) returns void;

// 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:

// "install_after.php" / "install.php" context
$srcPath = dirname(__FILE__) . '/';
$destPath = AMI_Registry::get('path/root') . '_local/';
$oStorage = AMI::getResource('storage/fs');
$file = 'common_functions.php';
$oArgs = new AMI_Tx_Cmd_Args(
array(
// Instance Id
'modId' => $this->oArgs->modId,
// Installation mode
'mode' => $this->oArgs->mode,
// Source PHP-file path
'source' => $srcPath . $file,
// Target PHP-file to patch
'target' => $destPath . $file,
// Storage driver
'oStorage' => $oStorage
)
);
$this->aTx['storage']->addCommand('php/install', $oArgs);
// File 'common_functions.php' contains PHP-template:
<?php
....
// {{}} <- PHP-code template start marker
include_once('ami_redirect.php');
...

Tags:

resource	tx/cmd/php/install AMI::getResource('tx/cmd/php/install')
since	6.0.2

• Class Properies

protected array $aObligatoryArgs

Obligatory arguments.

To give ability to override obligatory arguments

• Class Methods

// Callback filterring objects from arguments.

protected cbFilterObjects ( mixed $value ) returns bool;

mixed $value
Value

Tags:

see

AMI_Tx_Cmd_PHP_ContentIntsaller::modify()

// Callback converting key to template variable name.

protected cbToTplVar ( string $key ) returns string;

string $key
Name

Tags:

see

AMI_Tx_Cmd_PHP_ContentIntsaller::modify()

// Initializes command.

protected init ( ) returns void;

Overrides: AMI_Tx_Cmd_Storage::init().

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

// 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_Storage_ContentModifier::modify().

Appends target file content.

Tags:

throws

AMI_Tx_Exception In case of missing content template

// Validates passed arguments.

protected validateArgs ( ) returns void;

Overrides: AMI_Tx_Cmd_Storage_ContentModifier::validateArgs().

Overridden in child classes as: AMI_Tx_Cmd_Package_HandlersInstaller::validateArgs().

Tags:

see

AMI_Tx_Cmd::__construct()