# ProvidersService

> Lists scaffold providers recorded in scaffold-lock.json with their file counts.

[API reference](/docs/api/index.md) › [Scaffold](/docs/extensions/scaffold/reference/index.md) › [Services](/docs/extensions/scaffold/reference/services/index.md) › ProvidersService

| final class | `PHPForge\Scaffold\Services\ProvidersService` |
| --- | --- |
| Source | [`src/Services/ProvidersService.php`](https://github.com/php-forge/scaffold/blob/main/src/Services/ProvidersService.php#L16) |

Lists scaffold providers recorded in `scaffold-lock.json` with their file counts.

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`getProviders()`](#method-getProviders) | Returns the number of tracked files of every provider recorded in `scaffold-lock.json` under `$projectRoot`. | `ProvidersService` |
| [`run()`](#method-run) | Renders the providers table for the project rooted at `$projectRoot`. | `ProvidersService` |

## Method details

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

```php
public function getProviders(string $projectRoot): array<string, int>
```

Returns the number of tracked files of every provider recorded in `scaffold-lock.json` under `$projectRoot`.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$projectRoot` | `string` | Absolute path to the project root. |

**Returns**

`array<string, int>`: Map of provider package names to the number of files tracked for them.

**Throws**

- [`RuntimeException`](https://www.php.net/manual/en/class.runtimeexception.php): when the lock file cannot be read.

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

```php
public function run(string $projectRoot, PHPForge\Scaffold\Console\OutputWriter $out): int
```

Renders the providers table for the project rooted at `$projectRoot`.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$projectRoot` | `string` | Absolute path to the project root directory. |
| `$out` | [`PHPForge\Scaffold\Console\OutputWriter`](/docs/extensions/scaffold/reference/console/outputwriter/index.md) | Output sink used for stdout writes. |

**Returns**

`int`: `0` on success.

**Throws**

- [`RuntimeException`](https://www.php.net/manual/en/class.runtimeexception.php): when the lock file cannot be read.