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: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: <?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\ComponentLayout;
use LINE\LINEBot\Constant\Flex\ComponentMargin;
use LINE\LINEBot\Constant\Flex\ComponentSpacing;
use LINE\LINEBot\Constant\Flex\ComponentType;
use LINE\LINEBot\Constant\Flex\ComponentPosition;
use LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder;
use LINE\LINEBot\Util\BuildUtil;
/**
* A builder class for box component.
*
* @package LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder
*/
class BoxComponentBuilder implements ComponentBuilder
{
/** @var ComponentLayout */
private $layout;
/** @var ComponentBuilder[] */
private $componentBuilders;
/** @var int */
private $flex;
/** @var ComponentSpacing */
private $spacing;
/** @var ComponentMargin */
private $margin;
/** @var TemplateActionBuilder */
private $actionBuilder;
/** @var string */
private $paddingAll;
/** @var string */
private $paddingTop;
/** @var string */
private $paddingBottom;
/** @var string */
private $paddingStart;
/** @var string */
private $paddingEnd;
/** @var string */
private $backgroundColor;
/** @var string */
private $borderColor;
/** @var string */
private $borderWidth;
/** @var string */
private $cornerRadius;
/** @var string */
private $width;
/** @var string */
private $height;
/** @var string */
private $position;
/** @var string */
private $offsetTop;
/** @var string */
private $offsetBottom;
/** @var string */
private $offsetStart;
/** @var string */
private $offsetEnd;
/** @var array */
private $component;
/**
* BoxComponentBuilder constructor.
*
* @param ComponentLayout|string $layout
* @param ComponentBuilder[] $componentBuilders
* @param int|null $flex
* @param ComponentSpacing|string|null $spacing
* @param ComponentMargin|null $margin
*/
public function __construct(
$layout,
$componentBuilders,
$flex = null,
$spacing = null,
$margin = null,
$actionBuilder = null
) {
$this->layout = $layout;
$this->componentBuilders = $componentBuilders;
$this->flex = $flex;
$this->spacing = $spacing;
$this->margin = $margin;
$this->actionBuilder = $actionBuilder;
}
/**
* Create empty BoxComponentBuilder.
*
* @return BoxComponentBuilder
*/
public static function builder()
{
return new self(null, null);
}
/**
* Set laytout.
*
* @param ComponentLayout|string $layout
* @return $this
*/
public function setLayout($layout)
{
$this->layout = $layout;
return $this;
}
/**
* Set contents.
*
* @param ComponentBuilder[] $componentBuilders
* @return $this
*/
public function setContents($componentBuilders)
{
$this->componentBuilders = $componentBuilders;
return $this;
}
/**
* Set flex.
*
* @param int|null $flex
* @return $this
*/
public function setFlex($flex)
{
$this->flex = $flex;
return $this;
}
/**
* Set spacing.
*
* @param ComponentSpacing|string|null $spacing
* @return $this
*/
public function setSpacing($spacing)
{
$this->spacing = $spacing;
return $this;
}
/**
* Set margin.
*
* @param ComponentMargin|string|null $margin
* @return $this
*/
public function setMargin($margin)
{
$this->margin = $margin;
return $this;
}
/**
* Set action.
*
* @param TemplateActionBuilder|null $actionBuilder
* @return $this
*/
public function setAction($actionBuilder)
{
$this->actionBuilder = $actionBuilder;
return $this;
}
/**
* Set paddingAll.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $paddingAll
* @return $this
*/
public function setPaddingAll($paddingAll)
{
$this->paddingAll = $paddingAll;
return $this;
}
/**
* Set paddingTop.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $paddingTop
* @return $this
*/
public function setPaddingTop($paddingTop)
{
$this->paddingTop = $paddingTop;
return $this;
}
/**
* Set paddingBottom.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $paddingBottom
* @return $this
*/
public function setPaddingBottom($paddingBottom)
{
$this->paddingBottom = $paddingBottom;
return $this;
}
/**
* Set paddingStart.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $paddingStart
* @return $this
*/
public function setPaddingStart($paddingStart)
{
$this->paddingStart = $paddingStart;
return $this;
}
/**
* Set paddingEnd.
*
* specifiable percentage, pixel and keyword.
* (e.g.
* percentage: 5%
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param string|ComponentSpacing|null $paddingEnd
* @return $this
*/
public function setPaddingEnd($paddingEnd)
{
$this->paddingEnd = $paddingEnd;
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;
}
/**
* Set background color
*
* Hex color string: #RRGGBB or #RRGGBBAA
*
* @param string|null $backgroundColor
* @return $this
*/
public function setBackgroundColor($backgroundColor)
{
$this->backgroundColor = $backgroundColor;
return $this;
}
/**
* Set border color
*
* Hex color string: #RRGGBB or #RRGGBBAA
*
* @param string|null $borderColor
* @return $this
*/
public function setBorderColor($borderColor)
{
$this->borderColor = $borderColor;
return $this;
}
/**
* Set border width
*
* specifiable pixel and keyword.
* (e.g.
* pixel: 5px
* keyword: none (defined in ComponentBorderWidth)
*
* @param ComponentBorderWidth|string|null $borderWidth
* @return $this
*/
public function setBorderWidth($borderWidth)
{
$this->borderWidth = $borderWidth;
return $this;
}
/**
* Set corner radius
*
* specifiable pixel and keyword.
* (e.g.
* pixel: 5px
* keyword: none (defined in ComponentSpacing)
*
* @param ComponentSpacing|string|null $cornerRadius
* @return $this
*/
public function setCornerRadius($cornerRadius)
{
$this->cornerRadius = $cornerRadius;
return $this;
}
/**
* Set width
*
* specifiable percentage and pixel.
* (e.g.
* percentage: 5%
* pixel: 5px
*
* ※In horizontal and baseline box,
* `flex` property is ignored and the value is regarded as 0
*
* @param string|null $width
* @return $this
*/
public function setWidth($width)
{
$this->width = $width;
return $this;
}
/**
* Set height
*
* specifiable percentage and pixel.
* (e.g.
* percentage: 5%
* pixel: 5px
*
* ※In horizontal and baseline box,
* `flex` property is ignored and the value is regarded as 0
*
* @param string|null $height
* @return $this
*/
public function setHeight($height)
{
$this->height = $height;
return $this;
}
/**
* Builds box component structure.
*
* @return array
*/
public function build()
{
if (isset($this->component)) {
return $this->component;
}
$contents = array_map(function ($componentBuilder) {
/** @var ComponentBuilder $componentBuilder */
return $componentBuilder->build();
}, $this->componentBuilders);
$this->component = BuildUtil::removeNullElements([
'type' => ComponentType::BOX,
'layout' => $this->layout,
'contents' => $contents,
'flex' => $this->flex,
'spacing' => $this->spacing,
'margin' => $this->margin,
'action' => BuildUtil::build($this->actionBuilder, 'buildTemplateAction'),
'paddingAll' => $this->paddingAll,
'paddingTop' => $this->paddingTop,
'paddingBottom' => $this->paddingBottom,
'paddingStart' => $this->paddingStart,
'paddingEnd' => $this->paddingEnd,
'backgroundColor' => $this->backgroundColor,
'borderColor' => $this->borderColor,
'borderWidth' => $this->borderWidth,
'cornerRadius' => $this->cornerRadius,
'width' => $this->width,
'height' => $this->height,
'position' => $this->position,
'offsetTop' => $this->offsetTop,
'offsetBottom' => $this->offsetBottom,
'offsetStart' => $this->offsetStart,
'offsetEnd' => $this->offsetEnd,
]);
return $this->component;
}
}