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: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: <?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\TemplateActionBuilder;
use LINE\LINEBot\Constant\Flex\ComponentAlign;
use LINE\LINEBot\Constant\Flex\ComponentGravity;
use LINE\LINEBot\Constant\Flex\ComponentImageAspectMode;
use LINE\LINEBot\Constant\Flex\ComponentImageAspectRatio;
use LINE\LINEBot\Constant\Flex\ComponentImageSize;
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 image component.
*
* @package LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
class ImageComponentBuilder implements ComponentBuilder
{
/** @var string */
private $url;
/** @var int */
private $flex;
/** @var ComponentMargin */
private $margin;
/** @var ComponentAlign */
private $align;
/** @var ComponentGravity */
private $gravity;
/** @var ComponentImageSize */
private $size;
/** @var ComponentImageAspectRatio */
private $aspectRatio;
/** @var ComponentImageAspectMode */
private $aspectMode;
/** @var string */
private $backgroundColor;
/** @var TemplateActionBuilder */
private $actionBuilder;
/** @var string */
private $position;
/** @var string */
private $offsetTop;
/** @var string */
private $offsetBottom;
/** @var string */
private $offsetStart;
/** @var string */
private $offsetEnd;
/** @var array */
private $component;
/**
* ImageComponentBuilder constructor.
*
* @param string $url
* @param int|null $flex
* @param ComponentMargin|null $margin
* @param ComponentAlign|null $align
* @param ComponentGravity|null $gravity
* @param ComponentImageSize|null $size
* @param ComponentImageAspectRatio|null $aspectRatio
* @param ComponentImageAspectMode|null $aspectMode
* @param string|null $backgroundColor
* @param TemplateActionBuilder|null $actionBuilder
*/
public function __construct(
$url,
$flex = null,
$margin = null,
$align = null,
$gravity = null,
$size = null,
$aspectRatio = null,
$aspectMode = null,
$backgroundColor = null,
$actionBuilder = null
) {
$this->url = $url;
$this->flex = $flex;
$this->margin = $margin;
$this->align = $align;
$this->gravity = $gravity;
$this->size = $size;
$this->aspectRatio = $aspectRatio;
$this->aspectMode = $aspectMode;
$this->backgroundColor = $backgroundColor;
$this->actionBuilder = $actionBuilder;
}
/**
* Create empty ImageComponentBuilder.
*
* @return ImageComponentBuilder
*/
public static function builder()
{
return new self(null);
}
/**
* Set url.
*
* @param string $url
* @return ImageComponentBuilder
*/
public function setUrl($url)
{
$this->url = $url;
return $this;
}
/**
* Set flex.
*
* @param int|null $flex
* @return ImageComponentBuilder
*/
public function setFlex($flex)
{
$this->flex = $flex;
return $this;
}
/**
* Set margin.
*
* @param ComponentMargin|string|null $margin
* @return ImageComponentBuilder
*/
public function setMargin($margin)
{
$this->margin = $margin;
return $this;
}
/**
* Set align.
*
* @param ComponentAlign|string|null $align
* @return ImageComponentBuilder
*/
public function setAlign($align)
{
$this->align = $align;
return $this;
}
/**
* Set gravity.
*
* @param ComponentGravity|string|null $gravity
* @return ImageComponentBuilder
*/
public function setGravity($gravity)
{
$this->gravity = $gravity;
return $this;
}
/**
* Set size.
*
* @param ComponentImageSize|string|null $size
* @return ImageComponentBuilder
*/
public function setSize($size)
{
$this->size = $size;
return $this;
}
/**
* Set aspectRatio.
*
* @param ComponentImageAspectRatio|string|null $aspectRatio
* @return ImageComponentBuilder
*/
public function setAspectRatio($aspectRatio)
{
$this->aspectRatio = $aspectRatio;
return $this;
}
/**
* Set aspectMode.
*
* @param ComponentImageAspectMode|string|null $aspectMode
* @return ImageComponentBuilder
*/
public function setAspectMode($aspectMode)
{
$this->aspectMode = $aspectMode;
return $this;
}
/**
* Set backgroundColor.
*
* @param string|null $backgroundColor
* @return ImageComponentBuilder
*/
public function setBackgroundColor($backgroundColor)
{
$this->backgroundColor = $backgroundColor;
return $this;
}
/**
* Set action.
*
* @param TemplateActionBuilder|null $actionBuilder
* @return ImageComponentBuilder
*/
public function setAction($actionBuilder)
{
$this->actionBuilder = $actionBuilder;
return $this;
}
/**
* Set position.
*
* specifiable relative or absolute
*
* @param string|ComponentPosition|null $position
* @return $this
*/
public function setPosition($position)
{
$this->position = $position;
return $this;
}
/**
* Set offsetTop.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $offsetTop
* @return $this
*/
public function setOffsetTop($offsetTop)
{
$this->offsetTop = $offsetTop;
return $this;
}
/**
* Set offsetBottom.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $offsetBottom
* @return $this
*/
public function setOffsetBottom($offsetBottom)
{
$this->offsetBottom = $offsetBottom;
return $this;
}
/**
* Set offsetStart.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $offsetStart
* @return $this
*/
public function setOffsetStart($offsetStart)
{
$this->offsetStart = $offsetStart;
return $this;
}
/**
* Set offsetEnd.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $offsetEnd
* @return $this
*/
public function setOffsetEnd($offsetEnd)
{
$this->offsetEnd = $offsetEnd;
return $this;
}
/**
* Builds image component structure.
*
* @return array
*/
public function build()
{
if (isset($this->component)) {
return $this->component;
}
$this->component = BuildUtil::removeNullElements([
'type' => ComponentType::IMAGE,
'url' => $this->url,
'flex' => $this->flex,
'margin' => $this->margin,
'align' => $this->align,
'gravity' => $this->gravity,
'size' => $this->size,
'aspectRatio' => $this->aspectRatio,
'aspectMode' => $this->aspectMode,
'backgroundColor' => $this->backgroundColor,
'action' => BuildUtil::build($this->actionBuilder, 'buildTemplateAction'),
'position' => $this->position,
'offsetTop' => $this->offsetTop,
'offsetBottom' => $this->offsetBottom,
'offsetStart' => $this->offsetStart,
'offsetEnd' => $this->offsetEnd,
]);
return $this->component;
}
}