GravityKit\GravityMigrate\Exporters\TargetRegistry
Manages the available exporter instances.
Since: %ver%
Source: src/Exporters/TargetRegistry.php:18
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Exporters
Properties
| Property | Type | Description |
|---|---|---|
$factories | array<string, | callable|string> |
$instances | array<string, | ExporterInterface> |
$util | Util | Utility helper. |
$forms_data | FormsData | Forms data helper. |
Methods
| Method | Description |
|---|---|
__construct() | Class constructor. |
register_exporter() | Registers an exporter factory or instance. |
get_exporters() | Returns all exporter instances. |
get_exporter_metadata() | Returns exporter metadata for UI consumption. |
get_exporter() | Returns a single exporter instance. |
get_available_exporters() | Returns exporters that are currently available. |
has_available_exporters() | Whether any exporter is currently available. |
Method Reference
__construct()
public function __construct( Util $util, ?FormsData $forms_data=null )
Class constructor.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$util | Util | Utility helper instance. | |
$forms_data | FormsData | null | null | Forms data helper; the shared instance when omitted. |
Since: %ver%
Source: src/Exporters/TargetRegistry.php:64
register_exporter()
public function register_exporter( string $slug, $factory ): void
Registers an exporter factory or instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$slug | string | Exporter slug. | |
$factory | callable | ExporterInterface | string | Exporter factory, class name, or instance. |
Returns
void
Since: %ver%
Source: src/Exporters/TargetRegistry.php:79
get_exporters()
public function get_exporters(): array
Returns all exporter instances.
Returns
ExporterInterface[]
Since: %ver%
Source: src/Exporters/TargetRegistry.php:102
get_exporter_metadata()
public function get_exporter_metadata(): array
Returns exporter metadata for UI consumption.
Returns
array
Since: %ver%
Source: src/Exporters/TargetRegistry.php:117
get_exporter()
public function get_exporter( string $slug ): ?ExporterInterface
Returns a single exporter instance.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$slug | string | Exporter slug. |
Returns
ExporterInterface|null
Since: %ver%
Source: src/Exporters/TargetRegistry.php:141
get_available_exporters()
public function get_available_exporters(): array
Returns exporters that are currently available.
Returns
ExporterInterface[]
Since: %ver%
Source: src/Exporters/TargetRegistry.php:158
has_available_exporters()
public function has_available_exporters(): bool
Whether any exporter is currently available.
Returns
bool
Since: %ver%
Source: src/Exporters/TargetRegistry.php:174