Address_Form
- Full name:
\BigCommerce\Templates\Address_Form - Parent class:
\BigCommerce\Templates\Controller
Constants
| Constant | Visibility | Type | Value |
|---|---|---|---|
ADDRESS_ID | public | ’id’ | |
FIRST_NAME | public | ’first_name’ | |
LAST_NAME | public | ’last_name’ | |
COMPANY | public | ’company’ | |
STREET_1 | public | ’street_1’ | |
STREET_2 | public | ’street_2’ | |
CITY | public | ’city’ | |
STATE | public | ’state’ | |
ZIP | public | ’zip’ | |
COUNTRY | public | ’country’ | |
PHONE | public | ’phone’ | |
COUNTRIES | public | ’countries’ | |
STATES | public | ’states’ | |
ERRORS | public | ’errors’ |
Properties
template
protected $templateMethods
parse_options
protected parse_options(array $options): arrayParameters:
| Parameter | Type | Description |
|---|---|---|
$options | array |
get_data
Build the data that will be available to the template
public get_data(): arrayget_countries_and_states
protected get_countries_and_states(mixed $current_country): mixedParameters:
| 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 = ''): stringParameters:
| 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 = ''): static- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$options | array | |
$template | string |
__construct
public __construct(array $options = [], string $template = ''): mixedParameters:
| 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(): stringReturn Value:
The rendered template
get_data
Build the data that will be available to the template
public get_data(): array- This method is abstract.
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): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$html | string |
get_wrapper_tag
protected get_wrapper_tag(): mixedget_wrapper_classes
protected get_wrapper_classes(): mixedget_wrapper_attributes
protected get_wrapper_attributes(): mixedbuild_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): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$attributes | array |
Automatically generated on 2025-01-21