SpanComponentBuilder
in package
implements
ComponentBuilder
A builder class for span component.
Tags
Interfaces, Classes and Traits
- ComponentBuilder
- The interface that has a responsibility to build component.
Table of Contents
- $color : string
- $decoration : ComponentTextDecoration
- $size : ComponentFontSize
- $style : ComponentTextStyle
- $text : string
- $weight : ComponentFontWeight
- __construct() : mixed
- build() : array<string|int, mixed>
- Builds component structure.
- builder() : SpanComponentBuilder
- Create empty SpanComponentBuilder.
- setColor() : SpanComponentBuilder
- Set color.
- setDecoration() : SpanComponentBuilder
- Set decoration.
- setSize() : SpanComponentBuilder
- Set size.
- setStyle() : SpanComponentBuilder
- Set style.
- setText() : SpanComponentBuilder
- Set text.
- setWeight() : SpanComponentBuilder
- Set weight.
Properties
$color
private
string
$color
$decoration
private
ComponentTextDecoration
$decoration
$size
private
ComponentFontSize
$size
$style
private
ComponentTextStyle
$style
$text
private
string
$text
$weight
private
ComponentFontWeight
$weight
Methods
__construct()
public
__construct(mixed $text[, mixed $size = null ][, mixed $color = null ][, mixed $weight = null ][, mixed $style = null ][, mixed $decoration = null ]) : mixed
Parameters
- $text : mixed
- $size : mixed = null
- $color : mixed = null
- $weight : mixed = null
- $style : mixed = null
- $decoration : mixed = null
Return values
mixed —build()
Builds component structure.
public
build() : array<string|int, mixed>
Return values
array<string|int, mixed> —builder()
Create empty SpanComponentBuilder.
public
static builder() : SpanComponentBuilder
Return values
SpanComponentBuilder —setColor()
Set color.
public
setColor(string|null $color) : SpanComponentBuilder
Parameters
- $color : string|null
Return values
SpanComponentBuilder —setDecoration()
Set decoration.
public
setDecoration(ComponentTextDecoration|string|null $decoration) : SpanComponentBuilder
Parameters
- $decoration : ComponentTextDecoration|string|null
Return values
SpanComponentBuilder —setSize()
Set size.
public
setSize(ComponentFontSize|string|null $size) : SpanComponentBuilder
specifiable pixel and keyword. (e.g. pixel: 5px keyword: xxs (defined in ComponentFontSize)
Parameters
- $size : ComponentFontSize|string|null
Return values
SpanComponentBuilder —setStyle()
Set style.
public
setStyle(ComponentTextStyle|string|null $style) : SpanComponentBuilder
Parameters
- $style : ComponentTextStyle|string|null
Return values
SpanComponentBuilder —setText()
Set text.
public
setText(string $text) : SpanComponentBuilder
Parameters
- $text : string
Return values
SpanComponentBuilder —setWeight()
Set weight.
public
setWeight(ComponentFontWeight|string|null $weight) : SpanComponentBuilder
Parameters
- $weight : ComponentFontWeight|string|null