1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143:
<?php
/**
* Copyright 2018 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
namespace LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder;
use LINE\LINEBot\Constant\Flex\ComponentIconAspectRatio;
use LINE\LINEBot\Constant\Flex\ComponentIconSize;
use LINE\LINEBot\Constant\Flex\ComponentMargin;
use LINE\LINEBot\Constant\Flex\ComponentType;
use LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder;
use LINE\LINEBot\Util\BuildUtil;
/**
* A builder class for icon component.
*
* @package LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder
*/
class IconComponentBuilder implements ComponentBuilder
{
/** @var string */
private $url;
/** @var ComponentMargin */
private $margin;
/** @var ComponentIconSize */
private $size;
/** @var ComponentIconAspectRatio */
private $aspectRatio;
/** @var array */
private $component;
/**
* IconComponentBuilder constructor.
*
* @param string $url
* @param ComponentMargin|null $margin
* @param ComponentIconSize|null $size
* @param ComponentIconAspectRatio|null $aspectRatio
*/
public function __construct($url, $margin = null, $size = null, $aspectRatio = null)
{
$this->url = $url;
$this->margin = $margin;
$this->size = $size;
$this->aspectRatio = $aspectRatio;
}
/**
* Create empty IconComponentBuilder.
*
* @return IconComponentBuilder
*/
public static function builder()
{
return new self(null);
}
/**
* Set url.
*
* @param string $url
* @return IconComponentBuilder
*/
public function setUrl($url)
{
$this->url = $url;
return $this;
}
/**
* Set margin.
*
* @param ComponentMargin|string|null $margin
* @return IconComponentBuilder
*/
public function setMargin($margin)
{
$this->margin = $margin;
return $this;
}
/**
* Set size.
*
* @param ComponentIconSize|string|null $size
* @return IconComponentBuilder
*/
public function setSize($size)
{
$this->size = $size;
return $this;
}
/**
* Set aspectRatio.
*
* @param ComponentIconAspectRatio|string|null $aspectRatio
* @return IconComponentBuilder
*/
public function setAspectRatio($aspectRatio)
{
$this->aspectRatio = $aspectRatio;
return $this;
}
/**
* Builds icon component structure.
*
* @return array
*/
public function build()
{
if (isset($this->component)) {
return $this->component;
}
$this->component = BuildUtil::removeNullElements([
'type' => ComponentType::ICON,
'url' => $this->url,
'margin' => $this->margin,
'size' => $this->size,
'aspectRatio' => $this->aspectRatio,
]);
return $this->component;
}
}