GravityKit\GravityMigrate\Schema\GfNormalizer
Fills a Gravity Forms form, field, notification or confirmation out to the shape Gravity Forms
itself expects.
A form built by an adapter carries only what the source platform had. Gravity Forms reads many properties unconditionally, so a field arriving without them raises notices on render or, worse, behaves as though a setting were deliberately off. These defaults are what a form created in the Gravity Forms editor would have.
Since: %ver%
Source: src/Schema/GfNormalizer.php:21
Details
- Kind:
class - Namespace:
GravityKit\GravityMigrate\Schema
Methods
| Method | Description |
|---|---|
get_field_defaults() | Returns default properties for a Gravity Forms field type. |
get_input_defaults() | Returns default properties for field inputs. |
get_choice_defaults() | Returns default properties for field choices. |
get_button_defaults() | Returns default properties for form buttons. |
get_form_defaults() | Returns default properties for a form. |
get_notification_defaults() | Returns default properties for form notifications. |
get_confirmation_defaults() | Returns default properties for form confirmations. |
normalize_field() | Normalizes a single field to include known properties. |
field_list() | One list property of a Gravity Forms field, as a list. |
flatten_fields() | Every field of a form, a repeater's children included, parent before child. |
normalize_fields() | Normalizes a list of fields. |
normalize_button() | Normalizes a form button configuration. |
normalize_notifications() | Normalizes a notification collection. |
normalize_confirmations() | Normalizes a confirmation collection. |
normalize_form() | Normalizes a Gravity Forms form payload. |
filter_optional_props() | Removes empty optional values to avoid overriding defaults. |
Method Reference
get_field_defaults()
public static function get_field_defaults( string $type ): array
Returns default properties for a Gravity Forms field type.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$type | string | Field type. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:32
get_input_defaults()
public static function get_input_defaults(): array
Returns default properties for field inputs.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:50
get_choice_defaults()
public static function get_choice_defaults(): array
Returns default properties for field choices.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:62
get_button_defaults()
public static function get_button_defaults(): array
Returns default properties for form buttons.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:74
get_form_defaults()
public static function get_form_defaults(): array
Returns default properties for a form.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:86
get_notification_defaults()
public static function get_notification_defaults(): array
Returns default properties for form notifications.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:98
get_confirmation_defaults()
public static function get_confirmation_defaults(): array
Returns default properties for form confirmations.
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:110
normalize_field()
public static function normalize_field( array $field ): array
Normalizes a single field to include known properties.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field | array | Field configuration. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:124
field_list()
public static function field_list( array $field, string $property ): array
One list property of a Gravity Forms field, as a list.
choices and inputs are declared on GF_Field itself, so EVERY field carries them whatever
its type -- and a field type that has neither stores the empty string rather than null or an
empty array. $field['choices'] ?? [] therefore hands back a STRING for every non-choice
field, and iterating it raises "foreach() argument must be of type array|object, string
given" on stderr for each one. Contact Form 7 raised it on every field of every export.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field | array | The Gravity Forms field. | |
$property | string | The property to read. |
Returns
array— Its entries, or none where the field holds no list under that name.
Since: %ver%
Source: src/Schema/GfNormalizer.php:329
flatten_fields()
public static function flatten_fields( array $fields ): array
Every field of a form, a repeater's children included, parent before child.
Gravity Forms nests the fields of a repeater inside it and the API returns them that way, so anything that walks only the top level counts a sixteen-field repeater as one field. WPForms stores those children as fields of the form in their own right -- its repeater holds only their ids -- so a count taken from the top level alone disagrees with what the destination ends up holding.
Objects and arrays both, because GFAPI::get_form() returns GF_Field objects while a decoded export is arrays.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$fields | array | Fields, possibly holding nested fields. |
Returns
array— A flat list, in the order a reader meets them.
Since: %ver%
Source: src/Schema/GfNormalizer.php:353
normalize_fields()
public static function normalize_fields( array $fields ): array
Normalizes a list of fields.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$fields | array | Field list. |
Returns
array— Each entry normalized; anything that is not an array is passed through as it arrived.
Since: %ver%
Source: src/Schema/GfNormalizer.php:379
normalize_button()
public static function normalize_button( array $button ): array
Normalizes a form button configuration.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$button | array | Button configuration. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:402
normalize_notifications()
public static function normalize_notifications( array $notifications ): array
Normalizes a notification collection.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$notifications | array | Notification collection. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:416
normalize_confirmations()
public static function normalize_confirmations( array $confirmations ): array
Normalizes a confirmation collection.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$confirmations | array | Confirmation collection. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:444
normalize_form()
public static function normalize_form( array $form ): array
Normalizes a Gravity Forms form payload.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form | array | Form payload. |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:472
filter_optional_props()
public static function filter_optional_props( array $props, array $keep_empty_keys=[] ): array
Removes empty optional values to avoid overriding defaults.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$props | array | Optional properties. | |
$keep_empty_keys | array | [] | Keys to keep even when empty, for a setting whose empty value means something other than "unset". |
Returns
array
Since: %ver%
Source: src/Schema/GfNormalizer.php:507