# AbstractManifestAssetManager

> Provides the asset manifest handling shared by every asset manager: dependency merging, root package paths, and lock file detection.

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

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

2 subclasses:

- [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md)
- [`NativeManager`](/docs/extensions/foxy/reference/asset/nativemanager/index.md)

Provides the asset manifest handling shared by every asset manager: dependency merging, root package paths, and lock
file detection.

## Properties

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

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`__construct()`](#method-__construct) | Creates a manager with the services shared by asset manifest operations. | `AbstractManifestAssetManager` |
| [`addDependencies()`](#method-addDependencies) | Merges Composer asset dependencies into the frontend package manifest. | `AbstractManifestAssetManager` |
| <span id="method-audit"></span>[`audit()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-audit) abstract | Runs the security audit of the locked dependencies. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| <span id="method-getAuditParser"></span>[`getAuditParser()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-getAuditParser) abstract | Returns the parser of this manager's audit report. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| <span id="method-getLockPackageName"></span>[`getLockPackageName()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-getLockPackageName) abstract | Get the filename of the lock file. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| <span id="method-getName"></span>[`getName()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-getName) abstract | Get the name of asset manager. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| [`getPackageJsonPath()`](#method-getPackageJsonPath) | Returns the frontend package manifest path. | `AbstractManifestAssetManager` |
| [`getPackageName()`](#method-getPackageName) | Returns the frontend package manifest filename. | `AbstractManifestAssetManager` |
| <span id="method-getVersionConstraint"></span>[`getVersionConstraint()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-getVersionConstraint) abstract | Get the supported version constraint of the asset manager. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| [`hasLockFile()`](#method-hasLockFile) | Returns whether the manager lock file exists. | `AbstractManifestAssetManager` |
| <span id="method-isAvailable"></span>[`isAvailable()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-isAvailable) abstract | Check if the asset manager is available. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| [`isInstalled()`](#method-isInstalled) | Returns whether both the dependency directory and package manifest exist. | `AbstractManifestAssetManager` |
| [`isUpdatable()`](#method-isUpdatable) | Returns whether an existing frontend installation may be updated. | `AbstractManifestAssetManager` |
| <span id="method-run"></span>[`run()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-run) abstract | Run the asset manager to install/update the asset dependencies. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| [`setUpdatable()`](#method-setUpdatable) | Enables or disables updates of an existing frontend installation. | `AbstractManifestAssetManager` |
| <span id="method-validate"></span>[`validate()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-validate) abstract | Validate the version of asset manager. | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| [`actionWhenComposerDependenciesAreAlreadyInstalled()`](#method-actionWhenComposerDependenciesAreAlreadyInstalled) protected | Handles dependencies already present in the frontend installation. | `AbstractManifestAssetManager` |
| [`actionWhenComposerDependenciesAreMerged()`](#method-actionWhenComposerDependenciesAreMerged) protected | Runs after the Composer asset dependencies are merged and before the asset package is written. | `AbstractManifestAssetManager` |
| [`getLockFilePath()`](#method-getLockFilePath) protected | Returns the manager lock-file path under the root package directory. | `AbstractManifestAssetManager` |
| [`getManagerConfig()`](#method-getManagerConfig) protected | Returns the configuration scoped to this manager, so `manager-*` map entries resolve to its own value. | `AbstractManifestAssetManager` |
| [`getManagerWorkingDirectory()`](#method-getManagerWorkingDirectory) protected | Returns the configured manager working directory, or `null` to use the process default. | `AbstractManifestAssetManager` |
| [`getNodeModulesPath()`](#method-getNodeModulesPath) protected | Returns the `node_modules` path under the root package directory. | `AbstractManifestAssetManager` |
| [`getRootPackageDir()`](#method-getRootPackageDir) protected | Returns the resolved root package directory. | `AbstractManifestAssetManager` |
| [`getRootPackagePath()`](#method-getRootPackagePath) protected | Resolves a path under the root package directory. | `AbstractManifestAssetManager` |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-NODE_MODULES_PATH"></span>`NODE_MODULES_PATH` | `'./node_modules'` |  | `AbstractManifestAssetManager` |

## Method details

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

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

Creates a manager with the services shared by asset manifest operations.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$io` | `Composer\IO\IOInterface` | Composer output used for progress messages. |
| `$config` | [`Foxy\Config\Config`](/docs/extensions/foxy/reference/config/config/index.md) | Foxy configuration. |
| `$fs` | `Composer\Util\Filesystem` | Filesystem used to resolve and update manifest paths. |

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

```php
public function addDependencies(Composer\Package\RootPackageInterface $rootPackage, array $dependencies): Foxy\Asset\AssetPackageInterface
```

Merges Composer asset dependencies into the frontend package manifest.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$rootPackage` | `Composer\Package\RootPackageInterface` |  |
| `$dependencies` | `array` |  |

**Returns**

[`AssetPackageInterface`](/docs/extensions/foxy/reference/asset/assetpackageinterface/index.md)

**Throws**

- `Exception|Seld\JsonLint\ParsingException`

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

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

Returns the frontend package manifest path.

**Returns**

`string`

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

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

Returns the frontend package manifest filename.

**Returns**

`string`

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

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

Returns whether the manager lock file exists.

**Returns**

`bool`

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

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

Returns whether both the dependency directory and package manifest exist.

**Returns**

`bool`

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

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

Returns whether an existing frontend installation may be updated.

**Returns**

`bool`

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

```php
public function setUpdatable(bool $updatable): static
```

Enables or disables updates of an existing frontend installation.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$updatable` | `bool` |  |

**Returns**

`static`

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

```php
protected function actionWhenComposerDependenciesAreAlreadyInstalled(list<string> $names): void
```

Handles dependencies already present in the frontend installation.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$names` | `list<string>` | The asset package name of composer dependencies. |

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

```php
protected function actionWhenComposerDependenciesAreMerged(Foxy\Asset\AssetPackageInterface $assetPackage, array<string, mixed> $previousDependencies): void
```

Runs after the Composer asset dependencies are merged and before the asset package is written.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$assetPackage` | [`AssetPackageInterface`](/docs/extensions/foxy/reference/asset/assetpackageinterface/index.md) | The asset package with the merged Composer dependencies. |
| `$previousDependencies` | `array<string, mixed>` | The Composer asset dependencies declared before the merge. |

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

```php
protected function getLockFilePath(): string
```

Returns the manager lock-file path under the root package directory.

**Returns**

`string`

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

```php
protected function getManagerConfig(): Foxy\Config\Config
```

Returns the configuration scoped to this manager, so `manager-*` map entries resolve to its own value.

The view is built on each call because [`getName()`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md#method-getName) must not run from a constructor.

**Returns**

[`Foxy\Config\Config`](/docs/extensions/foxy/reference/config/config/index.md)

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

```php
protected function getManagerWorkingDirectory(): string|null
```

Returns the configured manager working directory, or `null` to use the process default.

**Returns**

`string|null`

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

```php
protected function getNodeModulesPath(): string
```

Returns the `node_modules` path under the root package directory.

**Returns**

`string`

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

```php
protected function getRootPackageDir(): string
```

Returns the resolved root package directory.

**Returns**

`string`

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

```php
protected function getRootPackagePath(string $path): string
```

Resolves a path under the root package directory.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$path` | `string` |  |

**Returns**

`string`