# NativeManager

> Provides the native asset manager: installs package.json dependencies from the npm registry in PHP, recording them in foxy.lock, without a Node.js package manager.

[API reference](/docs/api/index.md) › [Foxy](/docs/extensions/foxy/reference/index.md) › [Asset](/docs/extensions/foxy/reference/asset/index.md) › NativeManager

| final class | `Foxy\Asset\NativeManager` |
| --- | --- |
| Extends | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| Implements | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| Source | [`src/Asset/NativeManager.php`](https://github.com/php-forge/foxy/blob/main/src/Asset/NativeManager.php#L38) |

Provides the `native` asset manager: installs `package.json` dependencies from the npm registry in PHP, recording
them in `foxy.lock`, without a Node.js package manager.

Never selected automatically unless `foxy.lock` exists; `manager: native` selects it explicitly. Packages are installed
into the `native-install-dir` directory (`node_modules` by default).

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-config"></span>[`$config`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-config) protected constructor | [`Foxy\Config\Config`](/docs/extensions/foxy/reference/config/config/index.md) | Foxy configuration. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-fs"></span>[`$fs`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-fs) protected constructor | `Composer\Util\Filesystem` | Filesystem used to resolve and update manifest paths. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-io"></span>[`$io`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-io) protected constructor | `Composer\IO\IOInterface` | Composer output used for progress messages. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-updatable"></span>[`$updatable`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-updatable) protected | `bool` | Whether an existing frontend installation may be updated. Default: `true`. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`__construct()`](#method-__construct) | Creates the native manager with its installer and npm registry client. | `NativeManager` |
| <span id="method-addDependencies"></span>[`addDependencies()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-addDependencies) | Merges Composer asset dependencies into the frontend package manifest. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`audit()`](#method-audit) | Runs the security audit of the locked registry packages with one request to the registry's bulk advisories endpoint. | `NativeManager` |
| [`getAuditParser()`](#method-getAuditParser) | Returns the parser for npm bulk-advisory documents. | `NativeManager` |
| [`getLockPackageName()`](#method-getLockPackageName) | Returns the native manager lock-file name. | `NativeManager` |
| [`getName()`](#method-getName) | Returns the manager name used in Foxy configuration. | `NativeManager` |
| <span id="method-getPackageJsonPath"></span>[`getPackageJsonPath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getPackageJsonPath) | Returns the frontend package manifest path. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getPackageName"></span>[`getPackageName()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getPackageName) | Returns the frontend package manifest filename. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`getVersionConstraint()`](#method-getVersionConstraint) | Returns the unrestricted version constraint because this manager runs in PHP. | `NativeManager` |
| <span id="method-hasLockFile"></span>[`hasLockFile()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-hasLockFile) | Returns whether the manager lock file exists. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`isAvailable()`](#method-isAvailable) | Returns whether `foxy.lock` exists; the native manager needs no executable. | `NativeManager` |
| [`isInstalled()`](#method-isInstalled) | Returns whether the install directory and `package.json` exist. | `NativeManager` |
| <span id="method-isUpdatable"></span>[`isUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-isUpdatable) | Returns whether an existing frontend installation may be updated. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`run()`](#method-run) | Installs the dependencies, or updates them when updates are allowed by [`setUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-setUpdatable), as `composer update` does, even if nothing is installed yet. | `NativeManager` |
| <span id="method-setUpdatable"></span>[`setUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-setUpdatable) | Enables or disables updates of an existing frontend installation. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`validate()`](#method-validate) | Checks that the `zlib` extension, which reads the gzip-compressed tarballs, is loaded. | `NativeManager` |
| <span id="method-actionWhenComposerDependenciesAreAlreadyInstalled"></span>[`actionWhenComposerDependenciesAreAlreadyInstalled()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-actionWhenComposerDependenciesAreAlreadyInstalled) protected | Handles dependencies already present in the frontend installation. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-actionWhenComposerDependenciesAreMerged"></span>[`actionWhenComposerDependenciesAreMerged()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-actionWhenComposerDependenciesAreMerged) protected | Runs after the Composer asset dependencies are merged and before the asset package is written. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getLockFilePath"></span>[`getLockFilePath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getLockFilePath) protected | Returns the manager lock-file path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getManagerConfig"></span>[`getManagerConfig()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getManagerConfig) protected | Returns the configuration scoped to this manager, so `manager-*` map entries resolve to its own value. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getManagerWorkingDirectory"></span>[`getManagerWorkingDirectory()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getManagerWorkingDirectory) protected | Returns the configured manager working directory, or `null` to use the process default. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getNodeModulesPath"></span>[`getNodeModulesPath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getNodeModulesPath) protected | Returns the `node_modules` path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getRootPackageDir"></span>[`getRootPackageDir()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getRootPackageDir) protected | Returns the resolved root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getRootPackagePath"></span>[`getRootPackagePath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getRootPackagePath) protected | Resolves a path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-NODE_MODULES_PATH"></span>[`NODE_MODULES_PATH`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#const-NODE_MODULES_PATH) | `'./node_modules'` |  | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |

## Method details

### __construct() <span id="method-__construct"></span>

```php
public function __construct(Composer\IO\IOInterface $io, Foxy\Config\Config $config, Composer\Util\Filesystem $fs, Foxy\Native\NativeInstallerInterface $installer, Foxy\Native\NpmRegistryInterface $registry)
```

Creates the native manager with its installer and npm registry client.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$io` | `Composer\IO\IOInterface` | Output for the progress line. |
| `$config` | [`Foxy\Config\Config`](/docs/extensions/foxy/reference/config/config/index.md) | Foxy configuration. |
| `$fs` | `Composer\Util\Filesystem` | Filesystem used by the manifest handling. |
| `$installer` | [`Foxy\Native\NativeInstallerInterface`](/docs/extensions/foxy/reference/native/nativeinstallerinterface/index.md) | Installer that populates the install directory. |
| `$registry` | [`Foxy\Native\NpmRegistryInterface`](/docs/extensions/foxy/reference/native/npmregistryinterface/index.md) | Registry that answers the security audit. |

### audit() <span id="method-audit"></span>

```php
public function audit(bool $noDev): Foxy\Audit\AuditProcessResult
```

Runs the security audit of the locked registry packages with one request to the registry's bulk advisories
endpoint.

Local `file:` packages are skipped, and a lock without registry packages is clean without a request. The exit
code is `1` when the document reports an advisory and `0` otherwise; the error output is always empty.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$noDev` | `bool` | Whether to exclude development dependencies, which the native manager cannot do. |

**Returns**

[`Foxy\Audit\AuditProcessResult`](/docs/extensions/foxy/reference/audit/auditprocessresult/index.md)

**Throws**

- [`Foxy\Exception\RuntimeException`](/docs/extensions/foxy/reference/exception/runtimeexception/index.md): if `foxy.lock` is missing or malformed, `$noDev` is `true`, the registry request fails, or the advisories document is malformed.

### getAuditParser() <span id="method-getAuditParser"></span>

```php
public function getAuditParser(): Foxy\Audit\AuditParserInterface
```

Returns the parser for npm bulk-advisory documents.

**Returns**

[`Foxy\Audit\AuditParserInterface`](/docs/extensions/foxy/reference/audit/auditparserinterface/index.md)

### getLockPackageName() <span id="method-getLockPackageName"></span>

```php
public function getLockPackageName(): string
```

Returns the native manager lock-file name.

**Returns**

`string`

### getName() <span id="method-getName"></span>

```php
public function getName(): string
```

Returns the manager name used in Foxy configuration.

**Returns**

`string`

### getVersionConstraint() <span id="method-getVersionConstraint"></span>

```php
public function getVersionConstraint(): string
```

Returns the unrestricted version constraint because this manager runs in PHP.

**Returns**

`string`

### isAvailable() <span id="method-isAvailable"></span>

```php
public function isAvailable(): bool
```

Returns whether `foxy.lock` exists; the native manager needs no executable.

**Returns**

`bool`

### isInstalled() <span id="method-isInstalled"></span>

```php
public function isInstalled(): bool
```

Returns whether the install directory and `package.json` exist.

**Returns**

`bool`

**Throws**

- [`Foxy\Exception\RuntimeException`](/docs/extensions/foxy/reference/exception/runtimeexception/index.md): if the configured install directory is the root package directory, one of its parents, or a filesystem root, or if a symbolic link in it or in the root package directory cannot be resolved.

### run() <span id="method-run"></span>

```php
public function run(): int
```

Installs the dependencies, or updates them when updates are allowed by [`setUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-setUpdatable), as `composer update`
does, even if nothing is installed yet.

Returns `0` without doing anything when `run-asset-manager` is disabled. An installer exception propagates
unchanged.

**Returns**

`int`

**Throws**

- [`Foxy\Exception\RuntimeException`](/docs/extensions/foxy/reference/exception/runtimeexception/index.md): if the `zlib` extension is missing, the configured root package directory does not exist, the install directory is invalid, or the installation fails.

### validate() <span id="method-validate"></span>

```php
public function validate(): void
```

Checks that the `zlib` extension, which reads the gzip-compressed tarballs, is loaded.

**Throws**

- [`Foxy\Exception\RuntimeException`](/docs/extensions/foxy/reference/exception/runtimeexception/index.md): if the `zlib` extension is missing.