PEAR Manual
Prev |  | Next

# PEAR_Installer::install()

PEAR_Installer::install() -- Installs package files

## Synopsis

    require_once 'PEAR/Installer.php';

``array PEAR_Installer::install` (string $pkgfile [, array $options = array()])`

## Description

Installs the files within the package file specified.

## Parameter

string `$pkgfile`

  path to the package file

array `$options`

  installating options, to enable an option use the option name as array key and `TRUE` or `1` as value.

  - `$options['force'] = 1` - force installation

  - `$options['register-only'] = 1` - update registry but don't install files

  - `$options['upgrade'] = 1` - upgrade existing install

  - `$options['soft'] = 1` - fail silently

## Return value

`array` package info if successful

## Throws

Table 27-1. Possible PEAR_Error values

Error code | Error value | Meaning | Solution
--- | --- | --- | ---
| "" |  |

## Note

This function can not be called statically.

Prev | Home | Next
PEAR_Installer::PEAR_Installer() | Up | PEAR