GravityKit\GravityMigrate\Importers\Controller
Handles AJAX endpoints for third-party form importers.
Since: %ver%
Source: src/Importers/Controller.php:27
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Importers
Properties
| Property | Type | Description |
|---|---|---|
$registry | SourceRegistry | Importer registry. |
$util | Util | Utility helper. |
Methods
| Method | Description |
|---|---|
__construct() | Controller constructor. |
register_routes() | Registers controller routes with GravityKit Foundation. |
list_importers() | Returns available importers. |
list_forms() | Returns forms for a provider. |
analyze_forms() | Analyses several forms in one request. |
analyze_form() | Analyses a form. |
import_form() | Imports a form. |
Method Reference
__construct()
public function __construct( SourceRegistry $registry, ?Util $util=null )
Controller constructor.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$registry | SourceRegistry | Importer registry instance. | |
$util | Util | null | null | Utility helper; the shared instance when omitted. |
Since: %ver%
Source: src/Importers/Controller.php:81
register_routes()
public function register_routes( $routes ): array
Registers controller routes with GravityKit Foundation.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$routes | array | Existing routes. |
Returns
array
Since: %ver%
Source: src/Importers/Controller.php:97
list_importers()
public function list_importers( $payload ): array
Returns available importers.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$payload | array | Request payload. |
Returns
array
Since: %ver%
Source: src/Importers/Controller.php:114
list_forms()
public function list_forms( $payload ): array
Returns forms for a provider.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$payload | array | Request payload. |
Returns
array
Since: %ver%
Source: src/Importers/Controller.php:196
analyze_forms()
public function analyze_forms( $payload ): array
Analyses several forms in one request.
A form that cannot be read is reported against its own id rather than thrown, so one bad form does not blank the answers for the rest of the set. Only failures that apply to every id equally -- a bad nonce, a missing capability, an unavailable importer -- refuse the request.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$payload | array | Request payload. |
Returns
array— Results and errors, each keyed by the form id as it arrived.
Since: %ver%
Source: src/Importers/Controller.php:253
analyze_form()
public function analyze_form( $payload ): array
Analyses a form.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$payload | array | Request payload. |
Returns
array
Since: %ver%
Source: src/Importers/Controller.php:301
import_form()
public function import_form( $payload ): array
Imports a form.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$payload | array | Request payload. |
Returns
array
Since: %ver%
Source: src/Importers/Controller.php:356