ClassesBigCommerceTemplatesCart Footer

Cart_Footer

Constants

ConstantVisibilityTypeValue
CARTpublic’cart’
SUMMARYpublic’summary’
ACTIONSpublic’actions’
SHIPPINGpublic’shipping’

Properties

template

protected $template

wrapper_tag

protected string $wrapper_tag

wrapper_classes

protected string[] $wrapper_classes

Methods

parse_options

protected parse_options(array $options): array

Parameters:

ParameterTypeDescription
$optionsarray

get_data

Build the data that will be available to the template

public get_data(): array

get_actions

protected get_actions(mixed $cart): mixed

Parameters:

ParameterTypeDescription
$cartmixed

get_summary

protected get_summary(mixed $cart): mixed

Parameters:

ParameterTypeDescription
$cartmixed

get_shipping

protected get_shipping(mixed $cart): mixed

Parameters:

ParameterTypeDescription
$cartmixed

is_physical_item_in_cart

protected is_physical_item_in_cart(mixed $cart): mixed

Parameters:

ParameterTypeDescription
$cartmixed

Inherited methods

format_currency

Formats a numeric value as a currency string.

protected format_currency(float $value, string $empty_value = ''): string

Parameters:

ParameterTypeDescription
$valuefloatThe currency value to format.
$empty_valuestringThe 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:

ParameterTypeDescription
$optionsarray
$templatestring

__construct

public __construct(array $options = [], string $template = ''): mixed

Parameters:

ParameterTypeDescription
$optionsarray
$templatestring

parse_options

protected parse_options(array $options): array
  • This method is abstract.

Parameters:

ParameterTypeDescription
$optionsarray

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
  • 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): string

Parameters:

ParameterTypeDescription
$htmlstring

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:

ParameterTypeDescription
$attributesarray


Automatically generated on 2025-01-21