Product_Gallery
- Full name:
\BigCommerce\Templates\Product_Gallery - Parent class:
\BigCommerce\Templates\Controller
Constants
| Constant | Visibility | Type | Value |
|---|---|---|---|
PRODUCT | public | ’product’ | |
IMAGE_IDS | public | ’image_ids’ | |
YOUTUBE_VIDEOS | public | ’youtube_videos’ | |
FALLBACK | public | ’fallback_image’ | |
SIZE | public | ’image_size’ | |
THUMBNAIL | public | ’thumbnail_size’ | |
ZOOM | public | ’zoom’ | |
ZOOM_SIZE | public | ’zoom_size’ | |
CDN_IMAGES | public | ’cdn_images’ |
Properties
template
protected $templatewrapper_tag
protected string $wrapper_tagwrapper_classes
protected string[] $wrapper_classesMethods
parse_options
protected parse_options(array $options): arrayParameters:
| Parameter | Type | Description |
|---|---|---|
$options | array |
zoom_size
protected zoom_size(): mixedget_data
Build the data that will be available to the template
public get_data(): arrayget_fallback
protected get_fallback(): mixedget_videos
protected get_videos(\BigCommerce\Post_Types\Product\Product $product): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$product | \BigCommerce\Post_Types\Product\Product |
get_wrapper_classes
Add a class with the image size we’re using
protected get_wrapper_classes(): string[]enable_zoom
protected enable_zoom(): mixedInherited 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 |
get_images_cdn_url
Get list of cdn url for each image
public get_images_cdn_url(array $images_ids = []): arrayParameters:
| Parameter | Type | Description |
|---|---|---|
$images_ids | array |
get_headless_images
public get_headless_images(\BigCommerce\Post_Types\Product\Product $product): array|array[]Parameters:
| Parameter | Type | Description |
|---|---|---|
$product | \BigCommerce\Post_Types\Product\Product |
Automatically generated on 2025-01-21