PEAR Manual
Prev |  | Next

# PEAR_PackageFileManager::addReplacement()

PEAR_PackageFileManager::addReplacement() -- Add a replacement option for a file

## Synopsis

    require_once 'PEAR/PackageFileManager.php';

``void PEAR_PackageFileManager::addReplacement` (string $path, string $type, string $from, string $to)`

## Description

This sets an install-time complex search-and-replace function allowing the setting of platform-specific variables in an installed file.

if $type is php-const, then $to must be the name of a PHP Constant. If $type is pear-config, then $to must be the name of a PEAR config variable accessible through a PEAR_Config::get() method. If type is package-info, then $to must be the name of a section from the package.xml file used to install this file.

## Parameter

string `$path`

  relative path of file (relative to packagedirectory option)

string `$type`

  variable type, either php-const, pear-config or package-info

string `$from`

  text to replace in the source file

string `$to`

  variable name to use for replacement

## Throws

throws PEAR_PACKAGEFILEMANAGER_INVALID_REPLACETYPE

## Note

This function can not be called statically.

Prev | Home | Next
PEAR_PackageFileManager::addGlobalReplacement() | Up | PEAR_PackageFileManager::addRole()