Registration_Form

Full name: \BigCommerce\Templates\Registration_Form
Parent class: \BigCommerce\Templates\Form_Controller

Constants

Constant	Visibility	Type	Value
`STATES`	public		’states’
`COUNTRIES`	public		’countries’

Properties

template

protected $template

submission_key

protected $submission_key

Methods

parse_options

protected parse_options(array $options): array

Parameters:

Parameter	Type	Description
`$options`	array

get_data

Build the data that will be available to the template

public get_data(): array

get_form_defaults

protected get_form_defaults(): mixed

get_countries_and_states

protected get_countries_and_states(mixed $current_country): mixed

Parameters:

Parameter	Type	Description
`$current_country`	mixed

Inherited methods

format_currency

Formats a numeric value as a currency string.

protected format_currency(float $value, string $empty_value = &#039;&#039;): string

Parameters:

Parameter	Type	Description
`$value`	float	The currency value to format.
`$empty_value`	string	The value to return if $value is empty. Pass `null` to format anyway.

Return Value:

The formatted currency string or the empty value.

factory

Creates an instance of the controller

public static factory(array $options = [], string $template = &#039;&#039;): static

This method is static.

Parameters:

Parameter	Type	Description
`$options`	array
`$template`	string

__construct

public __construct(array $options = [], string $template = &#039;&#039;): mixed

Parameters:

Parameter	Type	Description
`$options`	array
`$template`	string

parse_options

protected parse_options(array $options): array

This method is abstract.

Parameters:

Parameter	Type	Description
`$options`	array

render

Render the template and return it as a string

public render(): string

Return Value:

The rendered template

get_data

Build the data that will be available to the template

public get_data(): array

wrap

Wrap the template output in an optional tag. This provides us a mechanism to ensure that some elements and classes are consistently available for JavaScript targeting, despite possible template overrides.

protected wrap(string $html): string

Parameters:

Parameter	Type	Description
`$html`	string

get_wrapper_tag

protected get_wrapper_tag(): mixed

get_wrapper_classes

protected get_wrapper_classes(): mixed

get_wrapper_attributes

protected get_wrapper_attributes(): mixed

build_attribute_string

Build a string of HTML attributes that can safely be injected into a template out of a list of key/value pairs

protected build_attribute_string(array $attributes): string

Parameters:

Parameter	Type	Description
`$attributes`	array

get_form_defaults

protected get_form_defaults(): mixed

restore_submission

If the user has submitted the form, restore their submission so they don’t have to re-type everything

protected restore_submission(string $field, array $data, array $submission): array

Parameters:

Parameter	Type	Description
`$field`	string	The name of the field containing the values to restore
`$data`	array	The default data to render in the form
`$submission`	array	The data the user submitted

Automatically generated on 2025-01-21

Refinery Related Product