src/Eccube/Entity/Layout.php line 28

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of EC-CUBE
  5. *
  6. * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
  7. *
  8. * http://www.ec-cube.co.jp/
  9. *
  10. * For the full copyright and license information, please view the LICENSE
  11. * file that was distributed with this source code.
  12. */
  14. namespace Eccube\Entity;
  16. use Doctrine\ORM\Mapping as ORM;
  18. if (!class_exists('\Eccube\Entity\Layout')) {
  19. /**
  20. * Layout
  21. *
  22. * @ORM\Table(name="dtb_layout")
  23. * @ORM\InheritanceType("SINGLE_TABLE")
  24. * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
  25. * @ORM\HasLifecycleCallbacks()
  26. * @ORM\Entity(repositoryClass="Eccube\Repository\LayoutRepository")
  27. */
  28. class Layout extends AbstractEntity
  29. {
  30. // 配置ID
  31. /** 配置ID: 未使用 */
  32. public const TARGET_ID_UNUSED = 0;
  33. public const TARGET_ID_HEAD = 1;
  34. public const TARGET_ID_BODY_AFTER = 2;
  35. public const TARGET_ID_HEADER = 3;
  36. public const TARGET_ID_CONTENTS_TOP = 4;
  37. public const TARGET_ID_SIDE_LEFT = 5;
  38. public const TARGET_ID_MAIN_TOP = 6;
  39. public const TARGET_ID_MAIN_BOTTOM = 7;
  40. public const TARGET_ID_SIDE_RIGHT = 8;
  41. public const TARGET_ID_CONTENTS_BOTTOM = 9;
  42. public const TARGET_ID_FOOTER = 10;
  43. public const TARGET_ID_DRAWER = 11;
  44. public const TARGET_ID_CLOSE_BODY_BEFORE = 12;
  46. /**
  47. * プレビュー用レイアウト
  48. */
  49. public const DEFAULT_LAYOUT_PREVIEW_PAGE = 0;
  51. /**
  52. * トップページ用レイアウト
  53. */
  54. public const DEFAULT_LAYOUT_TOP_PAGE = 1;
  56. /**
  57. * 下層ページ用レイアウト
  58. */
  59. public const DEFAULT_LAYOUT_UNDERLAYER_PAGE = 2;
  61. /**
  62. * @return string
  63. */
  64. public function __toString()
  65. {
  66. return (string) $this->name;
  67. }
  69. public function isDefault()
  70. {
  71. return in_array($this->id, [self::DEFAULT_LAYOUT_PREVIEW_PAGE, self::DEFAULT_LAYOUT_TOP_PAGE, self::DEFAULT_LAYOUT_UNDERLAYER_PAGE]);
  72. }
  74. /**
  75. * @return Page[]
  76. */
  77. public function getPages()
  78. {
  79. $Pages = [];
  80. foreach ($this->PageLayouts as $PageLayout) {
  81. $Pages[] = $PageLayout->getPage();
  82. }
  84. return $Pages;
  85. }
  87. /**
  88. * @param integer|null $targetId
  89. *
  90. * @return Block[]
  91. */
  92. public function getBlocks($targetId = null)
  93. {
  94. /** @var BlockPosition[] $TargetBlockPositions */
  95. $TargetBlockPositions = [];
  96. // $targetIdのBlockPositionのみ抽出
  97. foreach ($this->BlockPositions as $BlockPosition) {
  98. if (is_null($targetId)) {
  99. $TargetBlockPositions[] = $BlockPosition;
  100. continue;
  101. }
  103. if ($BlockPosition->getSection() == $targetId) {
  104. $TargetBlockPositions[] = $BlockPosition;
  105. }
  106. }
  108. // blockRow順にsort
  109. uasort($TargetBlockPositions, function (BlockPosition $a, BlockPosition $b) {
  110. return ($a->getBlockRow() < $b->getBlockRow()) ? -1 : 1;
  111. });
  113. // Blockの配列を作成
  114. $TargetBlocks = [];
  115. foreach ($TargetBlockPositions as $BlockPosition) {
  116. $TargetBlocks[] = $BlockPosition->getBlock();
  117. }
  119. return $TargetBlocks;
  120. }
  122. /**
  123. * @param integer $targetId
  124. *
  125. * @return BlockPosition[]
  126. */
  127. public function getBlockPositionsByTargetId($targetId)
  128. {
  129. return $this->BlockPositions->filter(
  130. function ($BlockPosition) use ($targetId) {
  131. return $BlockPosition->getSection() == $targetId;
  132. }
  133. );
  134. }
  136. public function getUnused()
  137. {
  138. return $this->getBlocks(self::TARGET_ID_UNUSED);
  139. }
  141. public function getHead()
  142. {
  143. return $this->getBlocks(self::TARGET_ID_HEAD);
  144. }
  146. public function getBodyAfter()
  147. {
  148. return $this->getBlocks(self::TARGET_ID_BODY_AFTER);
  149. }
  151. public function getHeader()
  152. {
  153. return $this->getBlocks(self::TARGET_ID_HEADER);
  154. }
  156. public function getContentsTop()
  157. {
  158. return $this->getBlocks(self::TARGET_ID_CONTENTS_TOP);
  159. }
  161. public function getSideLeft()
  162. {
  163. return $this->getBlocks(self::TARGET_ID_SIDE_LEFT);
  164. }
  166. public function getMainTop()
  167. {
  168. return $this->getBlocks(self::TARGET_ID_MAIN_TOP);
  169. }
  171. public function getMainBottom()
  172. {
  173. return $this->getBlocks(self::TARGET_ID_MAIN_BOTTOM);
  174. }
  176. public function getSideRight()
  177. {
  178. return $this->getBlocks(self::TARGET_ID_SIDE_RIGHT);
  179. }
  181. public function getContentsBottom()
  182. {
  183. return $this->getBlocks(self::TARGET_ID_CONTENTS_BOTTOM);
  184. }
  186. public function getFooter()
  187. {
  188. return $this->getBlocks(self::TARGET_ID_FOOTER);
  189. }
  191. public function getDrawer()
  192. {
  193. return $this->getBlocks(self::TARGET_ID_DRAWER);
  194. }
  196. public function getCloseBodyBefore()
  197. {
  198. return $this->getBlocks(self::TARGET_ID_CLOSE_BODY_BEFORE);
  199. }
  201. /**
  202. * Get ColumnNum
  203. *
  204. * @return integer
  205. */
  206. public function getColumnNum()
  207. {
  208. return 1 + ($this->getSideLeft() ? 1 : 0) + ($this->getSideRight() ? 1 : 0);
  209. }
  211. // -----------------------
  212. // generated by doctrine
  213. // -----------------------
  215. /**
  216. * @var integer
  217. *
  218. * @ORM\Column(name="id", type="integer", options={"unsigned":true})
  219. * @ORM\Id
  220. * @ORM\GeneratedValue(strategy="IDENTITY")
  221. */
  222. private $id;
  224. /**
  225. * @var string
  226. *
  227. * @ORM\Column(name="layout_name", type="string", length=255, nullable=true)
  228. */
  229. private $name;
  231. /**
  232. * @var \DateTime
  233. *
  234. * @ORM\Column(name="create_date", type="datetimetz")
  235. */
  236. private $create_date;
  238. /**
  239. * @var \DateTime
  240. *
  241. * @ORM\Column(name="update_date", type="datetimetz")
  242. */
  243. private $update_date;
  245. /**
  246. * @var \Doctrine\Common\Collections\Collection
  247. *
  248. * @ORM\OneToMany(targetEntity="Eccube\Entity\BlockPosition", mappedBy="Layout", cascade={"persist","remove"})
  249. */
  250. private $BlockPositions;
  252. /**
  253. * @var \Doctrine\Common\Collections\Collection
  254. *
  255. * @ORM\OneToMany(targetEntity="Eccube\Entity\PageLayout", mappedBy="Layout", cascade={"persist","remove"})
  256. * @ORM\OrderBy({"sort_no" = "ASC"})
  257. */
  258. private $PageLayouts;
  260. /**
  261. * @var \Eccube\Entity\Master\DeviceType
  262. *
  263. * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\DeviceType")
  264. * @ORM\JoinColumns({
  265. * @ORM\JoinColumn(name="device_type_id", referencedColumnName="id")
  266. * })
  267. */
  268. private $DeviceType;
  270. /**
  271. * Constructor
  272. */
  273. public function __construct()
  274. {
  275. $this->BlockPositions = new \Doctrine\Common\Collections\ArrayCollection();
  276. $this->PageLayouts = new \Doctrine\Common\Collections\ArrayCollection();
  277. }
  279. /**
  280. * Get id
  281. *
  282. * @return integer
  283. */
  284. public function getId()
  285. {
  286. return $this->id;
  287. }
  289. /**
  290. * Set name
  291. *
  292. * @param string $name
  293. *
  294. * @return Layout
  295. */
  296. public function setName($name)
  297. {
  298. $this->name = $name;
  300. return $this;
  301. }
  303. /**
  304. * Get name
  305. *
  306. * @return string
  307. */
  308. public function getName()
  309. {
  310. return $this->name;
  311. }
  313. /**
  314. * Set createDate
  315. *
  316. * @param \DateTime $createDate
  317. *
  318. * @return Layout
  319. */
  320. public function setCreateDate($createDate)
  321. {
  322. $this->create_date = $createDate;
  324. return $this;
  325. }
  327. /**
  328. * Get createDate
  329. *
  330. * @return \DateTime
  331. */
  332. public function getCreateDate()
  333. {
  334. return $this->create_date;
  335. }
  337. /**
  338. * Set updateDate
  339. *
  340. * @param \DateTime $updateDate
  341. *
  342. * @return Layout
  343. */
  344. public function setUpdateDate($updateDate)
  345. {
  346. $this->update_date = $updateDate;
  348. return $this;
  349. }
  351. /**
  352. * Get updateDate
  353. *
  354. * @return \DateTime
  355. */
  356. public function getUpdateDate()
  357. {
  358. return $this->update_date;
  359. }
  361. /**
  362. * Add blockPosition
  363. *
  364. * @param \Eccube\Entity\BlockPosition $blockPosition
  365. *
  366. * @return Layout
  367. */
  368. public function addBlockPosition(BlockPosition $blockPosition)
  369. {
  370. $this->BlockPositions[] = $blockPosition;
  372. return $this;
  373. }
  375. /**
  376. * Remove blockPosition
  377. *
  378. * @param \Eccube\Entity\BlockPosition $blockPosition
  379. */
  380. public function removeBlockPosition(BlockPosition $blockPosition)
  381. {
  382. $this->BlockPositions->removeElement($blockPosition);
  383. }
  385. /**
  386. * Get blockPositions
  387. *
  388. * @return \Doctrine\Common\Collections\Collection
  389. */
  390. public function getBlockPositions()
  391. {
  392. return $this->BlockPositions;
  393. }
  395. /**
  396. * Add pageLayoutLayout
  397. *
  398. * @param \Eccube\Entity\PageLayout $PageLayout
  399. *
  400. * @return Layout
  401. */
  402. public function addPageLayout(PageLayout $PageLayout)
  403. {
  404. $this->PageLayouts[] = $PageLayout;
  406. return $this;
  407. }
  409. /**
  410. * Remove pageLayoutLayout
  411. *
  412. * @param \Eccube\Entity\PageLayout $PageLayout
  413. */
  414. public function removePageLayout(PageLayout $PageLayout)
  415. {
  416. $this->PageLayouts->removeElement($PageLayout);
  417. }
  419. /**
  420. * Get pageLayoutLayouts
  421. *
  422. * @return \Doctrine\Common\Collections\Collection
  423. */
  424. public function getPageLayouts()
  425. {
  426. return $this->PageLayouts;
  427. }
  429. /**
  430. * Set deviceType
  431. *
  432. * @param \Eccube\Entity\Master\DeviceType $deviceType
  433. *
  434. * @return Layout
  435. */
  436. public function setDeviceType(Master\DeviceType $deviceType = null)
  437. {
  438. $this->DeviceType = $deviceType;
  440. return $this;
  441. }
  443. /**
  444. * Get deviceType
  445. *
  446. * @return \Eccube\Entity\Master\DeviceType
  447. */
  448. public function getDeviceType()
  449. {
  450. return $this->DeviceType;
  451. }
  453. /**
  454. * Check layout can delete or not
  455. *
  456. * @return boolean
  457. */
  458. public function isDeletable()
  459. {
  460. if (!$this->getPageLayouts()->isEmpty()) {
  461. return false;
  462. }
  464. return true;
  465. }
  466. }
  467. }