GravityKit\GravityMigrate\Migration\ImportRequest
Stages a bundle and works out what of it to import.
Forms and data types are checked against the BUNDLE, never against this site: importing form 4 means the bundle's form 4, and this site's form 4 is a different form sharing a number. A refusal names the bundle's contents for the same reason.
Since: %ver%
Source: src/Migration/ImportRequest.php:24
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Migration
Methods
| Method | Description |
|---|---|
resolve() | The staged bundle and the payload that imports it, or the refusal that stops it. |
discard() | Removes what staging left behind, for an import that will not start. |
forms() | The bundle's form ids this import covers. |
data() | The data types to import, intersected with what the bundle actually carries. |
Method Reference
resolve()
public static function resolve( array $input, Import $import )
The staged bundle and the payload that imports it, or the refusal that stops it.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Import request: path (the bundle on this server), forms (ids in the BUNDLE), all_forms, data (data types), skip_uploads. | |
$import | Import | The import engine, which reads the bundle. |
Returns
array{payload:array,— forms:array, data:array, bundle_forms:array, bundle_data:array}|WP_Error
Since: %ver%
Source: src/Migration/ImportRequest.php:72
discard()
public static function discard( string $staged, string $source ): void
Removes what staging left behind, for an import that will not start.
The extracted folder holds the source site's whole database as plain SQL. The staged copy goes too, unless it is the source itself: a bundle a person placed in the imports folder stays for them to retry.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$staged | string | The staged bundle. | |
$source | string | The bundle as the caller named it. |
Returns
void
Since: 2.1.1
Source: src/Migration/ImportRequest.php:181
forms()
public static function forms( array $input, array $bundle_forms )
The bundle's form ids this import covers.
Public because it is answerable without a bundle in hand -- given what a bundle carries, this is what an import of it would touch -- and because the rules in it are the ones worth holding to a test.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Input as received. | |
$bundle_forms | array | Every form id the bundle carries, in the bundle's own types. |
Returns
array| WP_Error
Since: %ver%
Source: src/Migration/ImportRequest.php:280
data()
public static function data( array $input, array $bundle_data )
The data types to import, intersected with what the bundle actually carries.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$input | array | Input as received. | |
$bundle_data | array | Every data type the bundle carries. |
Returns
array| WP_Error
Since: %ver%
Source: src/Migration/ImportRequest.php:329