VideoComponentBuilder
in package
implements
ComponentBuilder
A builder class for video component.
Tags
Interfaces, Classes and Traits
- ComponentBuilder
- The interface that has a responsibility to build component.
Table of Contents
- $actionBuilder : TemplateActionBuilder|null
- $altContent : ImageComponentBuilder|BoxComponentBuilder
- $aspectRatio : ComponentImageAspectRatio|null
- $component : array<string|int, mixed>|null
- $previewUrl : string
- $url : string
- __construct() : mixed
- VideoComponentBuilder constructor.
- build() : array<string|int, mixed>
- Builds video component structure.
- builder() : VideoComponentBuilder
- Create empty VideoComponentBuilder.
- setAction() : VideoComponentBuilder
- Set action.
- setAltContent() : VideoComponentBuilder
- Set altContent.
- setAspectRatio() : VideoComponentBuilder
- Set aspectRatio.
- setPreviewUrl() : VideoComponentBuilder
- Set previewUrl.
- setUrl() : VideoComponentBuilder
- Set url.
Properties
$actionBuilder
private
TemplateActionBuilder|null
$actionBuilder
$altContent
private
ImageComponentBuilder|BoxComponentBuilder
$altContent
$aspectRatio
private
ComponentImageAspectRatio|null
$aspectRatio
$component
private
array<string|int, mixed>|null
$component
$previewUrl
private
string
$previewUrl
$url
private
string
$url
Methods
__construct()
VideoComponentBuilder constructor.
public
__construct(string|null $url, string|null $previewUrl, ImageComponentBuilder|BoxComponentBuilder|null $altContent[, ComponentImageAspectRatio|string|null $aspectRatio = null ][, TemplateActionBuilder|null $actionBuilder = null ]) : mixed
Parameters
- $url : string|null
- $previewUrl : string|null
- $altContent : ImageComponentBuilder|BoxComponentBuilder|null
- $aspectRatio : ComponentImageAspectRatio|string|null = null
- $actionBuilder : TemplateActionBuilder|null = null
Return values
mixed —build()
Builds video component structure.
public
build() : array<string|int, mixed>
Return values
array<string|int, mixed> —builder()
Create empty VideoComponentBuilder.
public
static builder() : VideoComponentBuilder
Return values
VideoComponentBuilder —setAction()
Set action.
public
setAction(TemplateActionBuilder|null $actionBuilder) : VideoComponentBuilder
Parameters
- $actionBuilder : TemplateActionBuilder|null
Return values
VideoComponentBuilder —setAltContent()
Set altContent.
public
setAltContent(ImageComponentBuilder|BoxComponentBuilder $altContent) : VideoComponentBuilder
Parameters
- $altContent : ImageComponentBuilder|BoxComponentBuilder
Return values
VideoComponentBuilder —setAspectRatio()
Set aspectRatio.
public
setAspectRatio(ComponentImageAspectRatio|string|null $aspectRatio) : VideoComponentBuilder
Parameters
- $aspectRatio : ComponentImageAspectRatio|string|null
Return values
VideoComponentBuilder —setPreviewUrl()
Set previewUrl.
public
setPreviewUrl(string $previewUrl) : VideoComponentBuilder
Parameters
- $previewUrl : string
Return values
VideoComponentBuilder —setUrl()
Set url.
public
setUrl(string $url) : VideoComponentBuilder
Parameters
- $url : string