FlexImage
extends FlexComponent
in package
FlexImage Class Doc Comment
Tags
Table of Contents
- ALIGN_CENTER = 'center'
- ALIGN_END = 'end'
- ALIGN_START = 'start'
- ASPECT_MODE_COVER = 'cover'
- ASPECT_MODE_FIT = 'fit'
- DISCRIMINATOR = null
- GRAVITY_BOTTOM = 'bottom'
- GRAVITY_CENTER = 'center'
- GRAVITY_TOP = 'top'
- POSITION_ABSOLUTE = 'absolute'
- POSITION_RELATIVE = 'relative'
- $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|null
- Gets action
- getAlign() : string|null
- Gets align
- getAlignAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAnimated() : bool|null
- Gets animated
- getAspectMode() : string|null
- Gets aspectMode
- getAspectModeAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getAspectRatio() : string|null
- Gets aspectRatio
- getBackgroundColor() : string|null
- Gets backgroundColor
- getFlex() : int|null
- Gets flex
- getGravity() : string|null
- Gets gravity
- getGravityAllowableValues() : 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
- getSize() : string|null
- Gets size
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string
- Gets type
- getUrl() : string
- Gets url
- 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
- setAlign() : self
- Sets align
- setAnimated() : self
- Sets animated
- setAspectMode() : self
- Sets aspectMode
- setAspectRatio() : self
- Sets aspectRatio
- setBackgroundColor() : self
- Sets backgroundColor
- setFlex() : self
- Sets flex
- setGravity() : self
- Sets gravity
- setMargin() : self
- Sets margin
- setOffsetBottom() : self
- Sets offsetBottom
- setOffsetEnd() : self
- Sets offsetEnd
- setOffsetStart() : self
- Sets offsetStart
- setOffsetTop() : self
- Sets offsetTop
- setPosition() : self
- Sets position
- setSize() : self
- Sets size
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : self
- Sets type
- setUrl() : self
- Sets url
- 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
ALIGN_CENTER
public
mixed
ALIGN_CENTER
= 'center'
ALIGN_END
public
mixed
ALIGN_END
= 'end'
ALIGN_START
public
mixed
ALIGN_START
= 'start'
ASPECT_MODE_COVER
public
mixed
ASPECT_MODE_COVER
= 'cover'
ASPECT_MODE_FIT
public
mixed
ASPECT_MODE_FIT
= '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'
POSITION_ABSOLUTE
public
mixed
POSITION_ABSOLUTE
= 'absolute'
POSITION_RELATIVE
public
mixed
POSITION_RELATIVE
= 'relative'
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
= ['url' => 'url', 'flex' => 'flex', 'margin' => 'margin', 'position' => 'position', 'offsetTop' => 'offsetTop', 'offsetBottom' => 'offsetBottom', 'offsetStart' => 'offsetStart', 'offsetEnd' => 'offsetEnd', 'align' => 'align', 'gravity' => 'gravity', 'size' => 'size', 'aspectRatio' => 'aspectRatio', 'aspectMode' => 'aspectMode', 'backgroundColor' => 'backgroundColor', 'action' => 'action', 'animated' => 'animated']
$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
= ['url' => 'getUrl', 'flex' => 'getFlex', 'margin' => 'getMargin', 'position' => 'getPosition', 'offsetTop' => 'getOffsetTop', 'offsetBottom' => 'getOffsetBottom', 'offsetStart' => 'getOffsetStart', 'offsetEnd' => 'getOffsetEnd', 'align' => 'getAlign', 'gravity' => 'getGravity', 'size' => 'getSize', 'aspectRatio' => 'getAspectRatio', 'aspectMode' => 'getAspectMode', 'backgroundColor' => 'getBackgroundColor', 'action' => 'getAction', 'animated' => 'getAnimated']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['url' => 'uri', 'flex' => 'int32', 'margin' => null, 'position' => null, 'offsetTop' => null, 'offsetBottom' => null, 'offsetStart' => null, 'offsetEnd' => null, 'align' => null, 'gravity' => null, 'size' => null, 'aspectRatio' => null, 'aspectMode' => null, 'backgroundColor' => null, 'action' => null, 'animated' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'FlexImage'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['url' => false, 'flex' => false, 'margin' => false, 'position' => false, 'offsetTop' => false, 'offsetBottom' => false, 'offsetStart' => false, 'offsetEnd' => false, 'align' => false, 'gravity' => false, 'size' => false, 'aspectRatio' => false, 'aspectMode' => false, 'backgroundColor' => false, 'action' => false, 'animated' => 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
= ['url' => 'string', 'flex' => 'int', 'margin' => 'string', 'position' => 'string', 'offsetTop' => 'string', 'offsetBottom' => 'string', 'offsetStart' => 'string', 'offsetEnd' => 'string', 'align' => 'string', 'gravity' => 'string', 'size' => 'string', 'aspectRatio' => 'string', 'aspectMode' => 'string', 'backgroundColor' => 'string', 'action' => '\\LINE\\Clients\\MessagingApi\\Model\\Action', 'animated' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['url' => 'setUrl', 'flex' => 'setFlex', 'margin' => 'setMargin', 'position' => 'setPosition', 'offsetTop' => 'setOffsetTop', 'offsetBottom' => 'setOffsetBottom', 'offsetStart' => 'setOffsetStart', 'offsetEnd' => 'setOffsetEnd', 'align' => 'setAlign', 'gravity' => 'setGravity', 'size' => 'setSize', 'aspectRatio' => 'setAspectRatio', 'aspectMode' => 'setAspectMode', 'backgroundColor' => 'setBackgroundColor', 'action' => 'setAction', 'animated' => 'setAnimated']
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|null
Return values
Action|null —getAlign()
Gets align
public
getAlign() : string|null
Return values
string|null —getAlignAllowableValues()
Gets allowable values of the enum
public
getAlignAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAnimated()
Gets animated
public
getAnimated() : bool|null
Return values
bool|null —getAspectMode()
Gets aspectMode
public
getAspectMode() : string|null
Return values
string|null —getAspectModeAllowableValues()
Gets allowable values of the enum
public
getAspectModeAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getAspectRatio()
Gets aspectRatio
public
getAspectRatio() : string|null
Return values
string|null —getBackgroundColor()
Gets backgroundColor
public
getBackgroundColor() : 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> —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> —getSize()
Gets size
public
getSize() : string|null
Return values
string|null —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 —getUrl()
Gets url
public
getUrl() : 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|null $action) : self
Parameters
- $action : Action|null
-
action
Return values
self —setAlign()
Sets align
public
setAlign(string|null $align) : self
Parameters
- $align : string|null
-
Alignment style in horizontal direction.
Return values
self —setAnimated()
Sets animated
public
setAnimated(bool|null $animated) : self
Parameters
- $animated : bool|null
-
When this is
true
, an animated image (APNG) plays. You can specify a value of true up to 10 images in a single message. You can't send messages that exceed this limit. This isfalse
by default. Animated images larger than 300 KB aren't played back.
Return values
self —setAspectMode()
Sets aspectMode
public
setAspectMode(string|null $aspectMode) : self
Parameters
- $aspectMode : string|null
-
The display style of the image if the aspect ratio of the image and that specified by the aspectRatio property do not match.
Return values
self —setAspectRatio()
Sets aspectRatio
public
setAspectRatio(string|null $aspectRatio) : self
Parameters
- $aspectRatio : string|null
-
Aspect ratio of the image.
{width}:{height}
format. Specify the value of{width}
and{height}
in the range from1
to100000
. However, you cannot set{height}
to a value that is more than three times the value of{width}
. The default value is1:1
.
Return values
self —setBackgroundColor()
Sets backgroundColor
public
setBackgroundColor(string|null $backgroundColor) : self
Parameters
- $backgroundColor : string|null
-
Background color of the image. Use a hexadecimal color code.
Return values
self —setFlex()
Sets flex
public
setFlex(int|null $flex) : self
Parameters
- $flex : int|null
-
The ratio of the width or height of this component within the parent box.
Return values
self —setGravity()
Sets gravity
public
setGravity(string|null $gravity) : self
Parameters
- $gravity : string|null
-
Alignment style in vertical direction.
Return values
self —setMargin()
Sets margin
public
setMargin(string|null $margin) : self
Parameters
- $margin : string|null
-
The minimum amount of space to include before this component in its parent container.
Return values
self —setOffsetBottom()
Sets offsetBottom
public
setOffsetBottom(string|null $offsetBottom) : self
Parameters
- $offsetBottom : string|null
-
Offset.
Return values
self —setOffsetEnd()
Sets offsetEnd
public
setOffsetEnd(string|null $offsetEnd) : self
Parameters
- $offsetEnd : string|null
-
Offset.
Return values
self —setOffsetStart()
Sets offsetStart
public
setOffsetStart(string|null $offsetStart) : self
Parameters
- $offsetStart : string|null
-
Offset.
Return values
self —setOffsetTop()
Sets offsetTop
public
setOffsetTop(string|null $offsetTop) : self
Parameters
- $offsetTop : string|null
-
Offset.
Return values
self —setPosition()
Sets position
public
setPosition(string|null $position) : self
Parameters
- $position : string|null
-
Reference for offsetTop, offsetBottom, offsetStart, and offsetEnd. Specify one of the following values:
relative
: Use the previous box as reference.absolute
: Use the top left of parent element as reference. The default value is relative.
Return values
self —setSize()
Sets size
public
setSize(string|null $size) : self
Parameters
- $size : string|null
-
The maximum image width. This is md by default.
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 —setUrl()
Sets url
public
setUrl(string $url) : self
Parameters
- $url : string
-
Image URL (Max character limit: 2000) Protocol: HTTPS (TLS 1.2 or later) Image format: JPEG or PNG Maximum image size: 1024×1024 pixels Maximum file size: 10 MB (300 KB when the animated property is true)
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>