FlexButton
extends FlexComponent
in package
FlexButton Class Doc Comment
Tags
Table of Contents
- ADJUST_MODE_SHRINK_TO_FIT = 'shrink-to-fit'
- DISCRIMINATOR = null
- GRAVITY_BOTTOM = 'bottom'
- GRAVITY_CENTER = 'center'
- GRAVITY_TOP = 'top'
- HEIGHT_MD = 'md'
- HEIGHT_SM = 'sm'
- POSITION_ABSOLUTE = 'absolute'
- POSITION_RELATIVE = 'relative'
- STYLE_LINK = 'link'
- STYLE_PRIMARY = 'primary'
- STYLE_SECONDARY = 'secondary'
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAction() : Action
- Gets action
- getAdjustMode() : string|null
- Gets adjustMode
- getAdjustModeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getColor() : string|null
- Gets color
- getFlex() : int|null
- Gets flex
- getGravity() : string|null
- Gets gravity
- getGravityAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getHeight() : string|null
- Gets height
- getHeightAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getMargin() : string|null
- Gets margin
- getModelName() : string
- The original name of the model.
- getOffsetBottom() : string|null
- Gets offsetBottom
- getOffsetEnd() : string|null
- Gets offsetEnd
- getOffsetStart() : string|null
- Gets offsetStart
- getOffsetTop() : string|null
- Gets offsetTop
- getPosition() : string|null
- Gets position
- getPositionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getScaling() : bool|null
- Gets scaling
- getStyle() : string|null
- Gets style
- getStyleAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAction() : self
- Sets action
- setAdjustMode() : self
- Sets adjustMode
- setColor() : self
- Sets color
- setFlex() : self
- Sets flex
- setGravity() : self
- Sets gravity
- setHeight() : self
- Sets height
- setMargin() : self
- Sets margin
- setOffsetBottom() : self
- Sets offsetBottom
- setOffsetEnd() : self
- Sets offsetEnd
- setOffsetStart() : self
- Sets offsetStart
- setOffsetTop() : self
- Sets offsetTop
- setPosition() : self
- Sets position
- setScaling() : self
- Sets scaling
- setStyle() : self
- Sets style
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : self
- Sets type
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
ADJUST_MODE_SHRINK_TO_FIT
public
mixed
ADJUST_MODE_SHRINK_TO_FIT
= 'shrink-to-fit'
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
GRAVITY_BOTTOM
public
mixed
GRAVITY_BOTTOM
= 'bottom'
GRAVITY_CENTER
public
mixed
GRAVITY_CENTER
= 'center'
GRAVITY_TOP
public
mixed
GRAVITY_TOP
= 'top'
HEIGHT_MD
public
mixed
HEIGHT_MD
= 'md'
HEIGHT_SM
public
mixed
HEIGHT_SM
= 'sm'
POSITION_ABSOLUTE
public
mixed
POSITION_ABSOLUTE
= 'absolute'
POSITION_RELATIVE
public
mixed
POSITION_RELATIVE
= 'relative'
STYLE_LINK
public
mixed
STYLE_LINK
= 'link'
STYLE_PRIMARY
public
mixed
STYLE_PRIMARY
= 'primary'
STYLE_SECONDARY
public
mixed
STYLE_SECONDARY
= 'secondary'
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['flex' => 'flex', 'color' => 'color', 'style' => 'style', 'action' => 'action', 'gravity' => 'gravity', 'margin' => 'margin', 'position' => 'position', 'offsetTop' => 'offsetTop', 'offsetBottom' => 'offsetBottom', 'offsetStart' => 'offsetStart', 'offsetEnd' => 'offsetEnd', 'height' => 'height', 'adjustMode' => 'adjustMode', 'scaling' => 'scaling']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['flex' => 'getFlex', 'color' => 'getColor', 'style' => 'getStyle', 'action' => 'getAction', 'gravity' => 'getGravity', 'margin' => 'getMargin', 'position' => 'getPosition', 'offsetTop' => 'getOffsetTop', 'offsetBottom' => 'getOffsetBottom', 'offsetStart' => 'getOffsetStart', 'offsetEnd' => 'getOffsetEnd', 'height' => 'getHeight', 'adjustMode' => 'getAdjustMode', 'scaling' => 'getScaling']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['flex' => 'int32', 'color' => null, 'style' => null, 'action' => null, 'gravity' => null, 'margin' => null, 'position' => null, 'offsetTop' => null, 'offsetBottom' => null, 'offsetStart' => null, 'offsetEnd' => null, 'height' => null, 'adjustMode' => null, 'scaling' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'FlexButton'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['flex' => false, 'color' => false, 'style' => false, 'action' => false, 'gravity' => false, 'margin' => false, 'position' => false, 'offsetTop' => false, 'offsetBottom' => false, 'offsetStart' => false, 'offsetEnd' => false, 'height' => false, 'adjustMode' => false, 'scaling' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['flex' => 'int', 'color' => 'string', 'style' => 'string', 'action' => '\\LINE\\Clients\\MessagingApi\\Model\\Action', 'gravity' => 'string', 'margin' => 'string', 'position' => 'string', 'offsetTop' => 'string', 'offsetBottom' => 'string', 'offsetStart' => 'string', 'offsetEnd' => 'string', 'height' => 'string', 'adjustMode' => 'string', 'scaling' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['flex' => 'setFlex', 'color' => 'setColor', 'style' => 'setStyle', 'action' => 'setAction', 'gravity' => 'setGravity', 'margin' => 'setMargin', 'position' => 'setPosition', 'offsetTop' => 'setOffsetTop', 'offsetBottom' => 'setOffsetBottom', 'offsetStart' => 'setOffsetStart', 'offsetEnd' => 'setOffsetEnd', 'height' => 'setHeight', 'adjustMode' => 'setAdjustMode', 'scaling' => 'setScaling']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAction()
Gets action
public
getAction() : Action
Return values
Action —getAdjustMode()
Gets adjustMode
public
getAdjustMode() : string|null
Return values
string|null —getAdjustModeAllowableValues()
Gets allowable values of the enum
public
getAdjustModeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getColor()
Gets color
public
getColor() : string|null
Return values
string|null —getFlex()
Gets flex
public
getFlex() : int|null
Return values
int|null —getGravity()
Gets gravity
public
getGravity() : string|null
Return values
string|null —getGravityAllowableValues()
Gets allowable values of the enum
public
getGravityAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getHeight()
Gets height
public
getHeight() : string|null
Return values
string|null —getHeightAllowableValues()
Gets allowable values of the enum
public
getHeightAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getMargin()
Gets margin
public
getMargin() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getOffsetBottom()
Gets offsetBottom
public
getOffsetBottom() : string|null
Return values
string|null —getOffsetEnd()
Gets offsetEnd
public
getOffsetEnd() : string|null
Return values
string|null —getOffsetStart()
Gets offsetStart
public
getOffsetStart() : string|null
Return values
string|null —getOffsetTop()
Gets offsetTop
public
getOffsetTop() : string|null
Return values
string|null —getPosition()
Gets position
public
getPosition() : string|null
Return values
string|null —getPositionAllowableValues()
Gets allowable values of the enum
public
getPositionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getScaling()
Gets scaling
public
getScaling() : bool|null
Return values
bool|null —getStyle()
Gets style
public
getStyle() : string|null
Return values
string|null —getStyleAllowableValues()
Gets allowable values of the enum
public
getStyleAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
Gets type
public
getType() : string
Return values
string —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAction()
Sets action
public
setAction(Action $action) : self
Parameters
- $action : Action
-
action
Return values
self —setAdjustMode()
Sets adjustMode
public
setAdjustMode(string|null $adjustMode) : self
Parameters
- $adjustMode : string|null
-
adjustMode
Return values
self —setColor()
Sets color
public
setColor(string|null $color) : self
Parameters
- $color : string|null
-
color
Return values
self —setFlex()
Sets flex
public
setFlex(int|null $flex) : self
Parameters
- $flex : int|null
-
flex
Return values
self —setGravity()
Sets gravity
public
setGravity(string|null $gravity) : self
Parameters
- $gravity : string|null
-
gravity
Return values
self —setHeight()
Sets height
public
setHeight(string|null $height) : self
Parameters
- $height : string|null
-
height
Return values
self —setMargin()
Sets margin
public
setMargin(string|null $margin) : self
Parameters
- $margin : string|null
-
margin
Return values
self —setOffsetBottom()
Sets offsetBottom
public
setOffsetBottom(string|null $offsetBottom) : self
Parameters
- $offsetBottom : string|null
-
offsetBottom
Return values
self —setOffsetEnd()
Sets offsetEnd
public
setOffsetEnd(string|null $offsetEnd) : self
Parameters
- $offsetEnd : string|null
-
offsetEnd
Return values
self —setOffsetStart()
Sets offsetStart
public
setOffsetStart(string|null $offsetStart) : self
Parameters
- $offsetStart : string|null
-
offsetStart
Return values
self —setOffsetTop()
Sets offsetTop
public
setOffsetTop(string|null $offsetTop) : self
Parameters
- $offsetTop : string|null
-
offsetTop
Return values
self —setPosition()
Sets position
public
setPosition(string|null $position) : self
Parameters
- $position : string|null
-
position
Return values
self —setScaling()
Sets scaling
public
setScaling(bool|null $scaling) : self
Parameters
- $scaling : bool|null
-
scaling
Return values
self —setStyle()
Sets style
public
setStyle(string|null $style) : self
Parameters
- $style : string|null
-
style
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setType()
Sets type
public
setType(string $type) : self
Parameters
- $type : string
-
type
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>