GravityKit\GravityMigrate\Abilities\ReportSchema
One description of the report both migration abilities return.
ExternalMigration::migrate() returns the same entries whether it wrote anything or not; the
two abilities differ only in the status values they can produce and whether a written form
is named. The common part is declared once so both schemas describe that array the same way.
Since: %ver%
Source: src/Abilities/ReportSchema.php:22
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Abilities
Methods
| Method | Description |
|---|---|
envelope() | The envelope both abilities return, wrapped around one form entry's schema. |
shared_form_properties() | The properties every form entry carries, whichever ability produced it. |
field_rows() | One row per source field: what it was, what it became, what happened to it. |
Method Reference
envelope()
public static function envelope( array $form_entry ): array
The envelope both abilities return, wrapped around one form entry's schema.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form_entry | array | JSON Schema for one entry of the forms array. |
Returns
array
Since: %ver%
Source: src/Abilities/ReportSchema.php:33
shared_form_properties()
public static function shared_form_properties(): array
The properties every form entry carries, whichever ability produced it.
Returns
array
Since: %ver%
Source: src/Abilities/ReportSchema.php:64
field_rows()
public static function field_rows(): array
One row per source field: what it was, what it became, what happened to it.
Returns
array
Since: %ver%
Source: src/Abilities/ReportSchema.php:100