GravityKit\GravityMigrate\Importers\SourceRegistry
Manages the available importer instances.
Since: %ver%
Source: src/Importers/SourceRegistry.php:17
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Importers
Properties
| Property | Type | Description |
|---|---|---|
$factories | array<string, | callable|string> |
$instances | array<string, | ImporterInterface> |
$tracker | ImportTracker | Import tracker. |
$util | Util | Utility helper. |
Methods
| Method | Description |
|---|---|
__construct() | Class constructor. |
register_importer() | Registers an importer factory or instance. |
get_importers() | Returns all importer instances. |
get_importer_metadata() | Returns importer metadata for UI consumption. |
get_importer() | Returns a single importer instance. |
get_available_importers() | Returns importers that are currently available. |
has_available_importers() | Whether any importer is currently available. |
get_tracker() | Returns the tracker instance. |
Method Reference
__construct()
public function __construct( ImportTracker $tracker, Util $util )
Class constructor.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$tracker | ImportTracker | Import tracker instance. | |
$util | Util | Utility helper instance. |
Since: %ver%
Source: src/Importers/SourceRegistry.php:63
register_importer()
public function register_importer( string $slug, $factory ): void
Registers an importer factory or instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$slug | string | Importer slug. | |
$factory | callable | ImporterInterface | string | Importer factory, class name, or instance. |
Returns
void
Since: %ver%
Source: src/Importers/SourceRegistry.php:78
get_importers()
public function get_importers(): array
Returns all importer instances.
Returns
ImporterInterface[]
Since: %ver%
Source: src/Importers/SourceRegistry.php:101
get_importer_metadata()
public function get_importer_metadata(): array
Returns importer metadata for UI consumption.
Returns
array
Since: %ver%
Source: src/Importers/SourceRegistry.php:116
get_importer()
public function get_importer( string $slug ): ?ImporterInterface
Returns a single importer instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$slug | string | Importer slug. |
Returns
ImporterInterface|null
Since: %ver%
Source: src/Importers/SourceRegistry.php:140
get_available_importers()
public function get_available_importers(): array
Returns importers that are currently available.
Returns
ImporterInterface[]
Since: %ver%
Source: src/Importers/SourceRegistry.php:157
has_available_importers()
public function has_available_importers(): bool
Whether any importer is currently available.
Returns
bool
Since: %ver%
Source: src/Importers/SourceRegistry.php:173
get_tracker()
public function get_tracker(): ImportTracker
Returns the tracker instance.
Returns
ImportTracker
Since: %ver%
Source: src/Importers/SourceRegistry.php:184