ImageComponentBuilder
in package
implements
ComponentBuilder
A builder class for image component.
Tags
Interfaces, Classes and Traits
- ComponentBuilder
- The interface that has a responsibility to build component.
Table of Contents
- $actionBuilder : TemplateActionBuilder
- $align : ComponentAlign
- $animated : bool
- $aspectMode : ComponentImageAspectMode
- $aspectRatio : ComponentImageAspectRatio
- $backgroundColor : string
- $component : array<string|int, mixed>|null
- $flex : int
- $gravity : ComponentGravity
- $margin : ComponentMargin
- $offsetBottom : string
- $offsetEnd : string
- $offsetStart : string
- $offsetTop : string
- $position : string
- $size : ComponentImageSize
- $url : string
- __construct() : mixed
- ImageComponentBuilder constructor.
- build() : array<string|int, mixed>
- Builds image component structure.
- builder() : ImageComponentBuilder
- Create empty ImageComponentBuilder.
- setAction() : ImageComponentBuilder
- Set action.
- setAlign() : ImageComponentBuilder
- Set align.
- setAnimated() : $this
- Set animated.
- setAspectMode() : ImageComponentBuilder
- Set aspectMode.
- setAspectRatio() : ImageComponentBuilder
- Set aspectRatio.
- setBackgroundColor() : ImageComponentBuilder
- Set backgroundColor.
- setFlex() : ImageComponentBuilder
- Set flex.
- setGravity() : ImageComponentBuilder
- Set gravity.
- setMargin() : ImageComponentBuilder
- Set margin.
- setOffsetBottom() : $this
- Set offsetBottom.
- setOffsetEnd() : $this
- Set offsetEnd.
- setOffsetStart() : $this
- Set offsetStart.
- setOffsetTop() : $this
- Set offsetTop.
- setPosition() : $this
- Set position.
- setSize() : ImageComponentBuilder
- Set size.
- setUrl() : ImageComponentBuilder
- Set url.
Properties
$actionBuilder
private
TemplateActionBuilder
$actionBuilder
$align
private
ComponentAlign
$align
$animated
private
bool
$animated
$aspectMode
private
ComponentImageAspectMode
$aspectMode
$aspectRatio
private
ComponentImageAspectRatio
$aspectRatio
$backgroundColor
private
string
$backgroundColor
$component
private
array<string|int, mixed>|null
$component
$flex
private
int
$flex
$gravity
private
ComponentGravity
$gravity
$margin
private
ComponentMargin
$margin
$offsetBottom
private
string
$offsetBottom
$offsetEnd
private
string
$offsetEnd
$offsetStart
private
string
$offsetStart
$offsetTop
private
string
$offsetTop
$position
private
string
$position
$size
private
ComponentImageSize
$size
$url
private
string
$url
Methods
__construct()
ImageComponentBuilder constructor.
public
__construct(string|null $url[, int|null $flex = null ][, ComponentMargin|null $margin = null ][, ComponentAlign|null $align = null ][, ComponentGravity|null $gravity = null ][, ComponentImageSize|string|null $size = null ][, ComponentImageAspectRatio|null $aspectRatio = null ][, ComponentImageAspectMode|null $aspectMode = null ][, string|null $backgroundColor = null ][, TemplateActionBuilder|null $actionBuilder = null ]) : mixed
Parameters
- $url : string|null
- $flex : int|null = null
- $margin : ComponentMargin|null = null
- $align : ComponentAlign|null = null
- $gravity : ComponentGravity|null = null
- $size : ComponentImageSize|string|null = null
- $aspectRatio : ComponentImageAspectRatio|null = null
- $aspectMode : ComponentImageAspectMode|null = null
- $backgroundColor : string|null = null
- $actionBuilder : TemplateActionBuilder|null = null
Return values
mixed —build()
Builds image component structure.
public
build() : array<string|int, mixed>
Return values
array<string|int, mixed> —builder()
Create empty ImageComponentBuilder.
public
static builder() : ImageComponentBuilder
Return values
ImageComponentBuilder —setAction()
Set action.
public
setAction(TemplateActionBuilder|null $actionBuilder) : ImageComponentBuilder
Parameters
- $actionBuilder : TemplateActionBuilder|null
Return values
ImageComponentBuilder —setAlign()
Set align.
public
setAlign(ComponentAlign|string|null $align) : ImageComponentBuilder
Parameters
- $align : ComponentAlign|string|null
Return values
ImageComponentBuilder —setAnimated()
Set animated.
public
setAnimated([bool $animated = false ]) : $this
When this is true, an animated image (APNG) plays. default: false
Parameters
- $animated : bool = false
Return values
$this —setAspectMode()
Set aspectMode.
public
setAspectMode(ComponentImageAspectMode|string|null $aspectMode) : ImageComponentBuilder
Parameters
- $aspectMode : ComponentImageAspectMode|string|null
Return values
ImageComponentBuilder —setAspectRatio()
Set aspectRatio.
public
setAspectRatio(ComponentImageAspectRatio|string|null $aspectRatio) : ImageComponentBuilder
Parameters
- $aspectRatio : ComponentImageAspectRatio|string|null
Return values
ImageComponentBuilder —setBackgroundColor()
Set backgroundColor.
public
setBackgroundColor(string|null $backgroundColor) : ImageComponentBuilder
Parameters
- $backgroundColor : string|null
Return values
ImageComponentBuilder —setFlex()
Set flex.
public
setFlex(int|null $flex) : ImageComponentBuilder
Parameters
- $flex : int|null
Return values
ImageComponentBuilder —setGravity()
Set gravity.
public
setGravity(ComponentGravity|string|null $gravity) : ImageComponentBuilder
Parameters
- $gravity : ComponentGravity|string|null
Return values
ImageComponentBuilder —setMargin()
Set margin.
public
setMargin(ComponentMargin|string|null $margin) : ImageComponentBuilder
Parameters
- $margin : ComponentMargin|string|null
Return values
ImageComponentBuilder —setOffsetBottom()
Set offsetBottom.
public
setOffsetBottom(string|ComponentSpacing|null $offsetBottom) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetBottom : string|ComponentSpacing|null
Return values
$this —setOffsetEnd()
Set offsetEnd.
public
setOffsetEnd(string|ComponentSpacing|null $offsetEnd) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetEnd : string|ComponentSpacing|null
Return values
$this —setOffsetStart()
Set offsetStart.
public
setOffsetStart(string|ComponentSpacing|null $offsetStart) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetStart : string|ComponentSpacing|null
Return values
$this —setOffsetTop()
Set offsetTop.
public
setOffsetTop(string|ComponentSpacing|null $offsetTop) : $this
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: none (defined in ComponentSpacing)
Parameters
- $offsetTop : string|ComponentSpacing|null
Return values
$this —setPosition()
Set position.
public
setPosition(string|ComponentPosition|null $position) : $this
specifiable relative or absolute
Parameters
- $position : string|ComponentPosition|null
Return values
$this —setSize()
Set size.
public
setSize(ComponentImageSize|string|null $size) : ImageComponentBuilder
specifiable percentage, pixel and keyword. (e.g. percentage: 5% pixel: 5px keyword: xxs (defined in ComponentImageSize)
Parameters
- $size : ComponentImageSize|string|null
Return values
ImageComponentBuilder —setUrl()
Set url.
public
setUrl(string $url) : ImageComponentBuilder
Parameters
- $url : string