GravityKit\GravityMigrate\Importers\AbstractImporter

Provides shared helper methods for importer implementations.

Since: %ver%

Source: src/Importers/AbstractImporter.php:32

Details

• Kind: class

• Namespace: GravityKit\GravityMigrate\Importers

• Implements: ImporterInterface, PipelineContext

Properties

Property	Type	Description
$sidecar_warnings	string[]	Warnings raised while writing the round-trip sidecar.
$slug	string	Importer slug.
$name	string	Importer display name.
$description	string	Importer description.
$minimum_capability	string	Minimum capability required to use the importer.
$tracker	ImportTracker	Tracks imported forms.
$util	Util	Utility helper instance.

Methods

Method	Description
__construct()	AbstractImporter constructor.
list_forms()	Returns a list of importable forms.
import_form()	Creates the Gravity Forms form for the requested source form.
translate_smart_tags()	Converts provider-specific smart tags or merge tags into Gravity Forms
sanitize_text()	{@inheritdoc}
sanitize_textarea()	{@inheritdoc}
get_tracked_import_id()	Returns the tracked Gravity Forms ID for a source form.
create_gravity_form_from_prepared()	Finalizes Gravity Forms creation from a prepared payload.
take_sidecar_warnings()	Returns and clears any warnings raised while writing the sidecar.
recompose_composite_fields()	{@inheritdoc}
analyze_form()	Reads a source form and reports what importing it would do, without importing it.

Method Reference

__construct()

public function __construct( ImportTracker $tracker, Util $util )

AbstractImporter constructor.

Parameters

Name	Type	Default	Description
$tracker	ImportTracker		Import tracker instance.
$util	Util		Utility helper instance.

Since: %ver%

Source: src/Importers/AbstractImporter.php:117

list_forms()

public function list_forms( array $args=[] ): array

Returns a list of importable forms.

Parameters

Name	Type	Default	Description
$args	array	[]	Optional request arguments.

Returns

• array — Associative arrays carrying at least id and title.

Since: %ver%

Source: src/Importers/AbstractImporter.php:127

import_form()

public function import_form( $form_id, array $args=[] )

Creates the Gravity Forms form for the requested source form.

Parameters

Name	Type	Default	Description
$form_id	mixed		Source form identifier.
$args	array	[]	Optional request arguments.

Returns

• array | WP_Error — gravity_form_id, edit_url, preview_url and warnings for the created form, or WP_Error describing the failure.

Since: %ver%

Source: src/Importers/AbstractImporter.php:134

translate_smart_tags()

public function translate_smart_tags( string $text, array $context=[] ): string

Converts provider-specific smart tags or merge tags into Gravity Forms

merge tags.

Parameters

Name	Type	Default	Description
$text	string		Text containing provider smart tags.
$context	array	[]	Optional context data for replacements.

Returns

• string

Since: %ver%

Source: src/Importers/AbstractImporter.php:141

sanitize_text()

public function sanitize_text( $value ): string

{@inheritdoc}

Parameters

Name	Type	Default	Description
$value

Returns

• string

See Also

• GfComposites

Source: src/Importers/AbstractImporter.php:150

sanitize_textarea()

public function sanitize_textarea( $value ): string

{@inheritdoc}

Parameters

Name	Type	Default	Description
$value

Returns

• string

See Also

• GfComposites

Source: src/Importers/AbstractImporter.php:159

get_tracked_import_id()

public function get_tracked_import_id( $source_form_id ): ?int

Returns the tracked Gravity Forms ID for a source form.

Parameters

Name	Type	Default	Description
$source_form_id	mixed		Source form identifier.

Returns

• int | null

Since: %ver%

Source: src/Importers/AbstractImporter.php:222

create_gravity_form_from_prepared()

public function create_gravity_form_from_prepared( array $prepared, int $source_form_id )

Finalizes Gravity Forms creation from a prepared payload.

Parameters

Name	Type	Default	Description
$prepared	array		Prepared data from adapter.
$source_form_id	int		Source form identifier.

Returns

• array | WP_Error

Since: %ver%

Source: src/Importers/AbstractImporter.php:236

take_sidecar_warnings()

public function take_sidecar_warnings(): array

Returns and clears any warnings raised while writing the sidecar.

Returns

• string[]

Since: %ver%

Source: src/Importers/AbstractImporter.php:463

recompose_composite_fields()

public function recompose_composite_fields( array $fields, array&$field_id_map=[], array&$warnings=[] ): array

{@inheritdoc}

Parameters

Name	Type	Default	Description
$fields	array
&$field_id_map	array	[]
&$warnings	array	[]

Returns

• array

See Also

• GfComposites

Source: src/Importers/AbstractImporter.php:494

analyze_form()

public function analyze_form( $form_id, array $args=[] )

Reads a source form and reports what importing it would do, without importing it.

Parameters

Name	Type	Default	Description
$form_id	int | string		Source form id.
$args	array	[]	Unused.

Returns

• array | WP_Error

Since: %ver%

Source: src/Importers/AbstractImporter.php:748