Eccube\Entity\Layout

Complexity

Total Complexity

45

Size/Duplication

Total Lines	434
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	4

Importance

Changes

0

36 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	4	1
A	isDefault()	0	4	1
A	getPages()	0	9	2
B	getBlocks()	0	29	6
A	getBlockPositionsByTargetId()	0	8	1
A	getUnused()	0	4	1
A	getHead()	0	4	1
A	getBodyAfter()	0	4	1
A	getHeader()	0	4	1
A	getContentsTop()	0	4	1
A	getSideLeft()	0	4	1
A	getMainTop()	0	4	1
A	getMainBottom()	0	4	1
A	getSideRight()	0	4	1
A	getContentsBottom()	0	4	1
A	getFooter()	0	4	1
A	getDrawer()	0	4	1
A	getCloseBodyBefore()	0	4	1
A	getColumnNum()	0	4	3
A	__construct()	0	5	1
A	getId()	0	4	1
A	setName()	0	6	1
A	getName()	0	4	1
A	setCreateDate()	0	6	1
A	getCreateDate()	0	4	1
A	setUpdateDate()	0	6	1
A	getUpdateDate()	0	4	1
A	addBlockPosition()	0	6	1
A	removeBlockPosition()	0	4	1
A	getBlockPositions()	0	4	1
A	addPageLayout()	0	6	1
A	removePageLayout()	0	4	1
A	getPageLayouts()	0	4	1
A	setDeviceType()	0	6	1
A	getDeviceType()	0	4	1
A	isDeletable()	0	8	2

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Entity;

use Doctrine\ORM\Mapping as ORM;

if (!class_exists('\Eccube\Entity\Layout')) {
    /**
     * Layout
     *
     * @ORM\Table(name="dtb_layout")
     * @ORM\InheritanceType("SINGLE_TABLE")
     * @ORM\DiscriminatorColumn(name="discriminator_type", type="string", length=255)
     * @ORM\HasLifecycleCallbacks()
     * @ORM\Entity(repositoryClass="Eccube\Repository\LayoutRepository")
     */
    class Layout extends AbstractEntity
    {
        // 配置ID
        /** 配置ID: 未使用 */
        const TARGET_ID_UNUSED = 0;
        const TARGET_ID_HEAD = 1;
        const TARGET_ID_BODY_AFTER = 2;
        const TARGET_ID_HEADER = 3;
        const TARGET_ID_CONTENTS_TOP = 4;
        const TARGET_ID_SIDE_LEFT = 5;
        const TARGET_ID_MAIN_TOP = 6;
        const TARGET_ID_MAIN_BOTTOM = 7;
        const TARGET_ID_SIDE_RIGHT = 8;
        const TARGET_ID_CONTENTS_BOTTOM = 9;
        const TARGET_ID_FOOTER = 10;
        const TARGET_ID_DRAWER = 11;
        const TARGET_ID_CLOSE_BODY_BEFORE = 12;

        /**
         * トップページ用レイアウト
         */
        const DEFAULT_LAYOUT_TOP_PAGE = 1;

        /**
         * 下層ページ用レイアウト
         */
        const DEFAULT_LAYOUT_UNDERLAYER_PAGE = 2;

        /**
         * @return string
         */
        public function __toString()
        {
            return (string) $this->name;
        }

        public function isDefault()
        {
            return in_array($this->id, [self::DEFAULT_LAYOUT_TOP_PAGE, self::DEFAULT_LAYOUT_UNDERLAYER_PAGE]);
        }

        /**
         * @return Page[]
         */
        public function getPages()
        {
            $Pages = [];
            foreach ($this->PageLayouts as $PageLayout) {
                $Pages[] = $PageLayout->getPage();
            }

            return $Pages;
        }

        /**
         * @param integer|null $targetId
         *
         * @return Block[]
         */
        public function getBlocks($targetId = null)
        {
            /** @var BlockPosition[] $TargetBlockPositions */
            $TargetBlockPositions = [];
            // $targetIdのBlockPositionのみ抽出
            foreach ($this->BlockPositions as $BlockPosition) {
                if (is_null($targetId)) {
                    $TargetBlockPositions[] = $BlockPosition;
                    continue;
                }

                if ($BlockPosition->getSection() == $targetId) {
                    $TargetBlockPositions[] = $BlockPosition;
                }
            }

            // blockRow順にsort
            uasort($TargetBlockPositions, function (BlockPosition $a, BlockPosition $b) {
                return ($a->getBlockRow() < $b->getBlockRow()) ? -1 : 1;
            });

            // Blockの配列を作成
            $TargetBlocks = [];
            foreach ($TargetBlockPositions as $BlockPosition) {
                $TargetBlocks[] = $BlockPosition->getBlock();
            }

            return $TargetBlocks;
        }

        /**
         * @param integer $targetId
         *
         * @return BlockPosition[]
         */
        public function getBlockPositionsByTargetId($targetId)
        {
            return $this->BlockPositions->filter(
                function ($BlockPosition) use ($targetId) {
                    return $BlockPosition->getSection() == $targetId;
                }
            );
        }

        public function getUnused()
        {
            return $this->getBlocks(self::TARGET_ID_UNUSED);
        }

        public function getHead()
        {
            return $this->getBlocks(self::TARGET_ID_HEAD);
        }

        public function getBodyAfter()
        {
            return $this->getBlocks(self::TARGET_ID_BODY_AFTER);
        }

        public function getHeader()
        {
            return $this->getBlocks(self::TARGET_ID_HEADER);
        }

        public function getContentsTop()
        {
            return $this->getBlocks(self::TARGET_ID_CONTENTS_TOP);
        }

        public function getSideLeft()
        {
            return $this->getBlocks(self::TARGET_ID_SIDE_LEFT);
        }

        public function getMainTop()
        {
            return $this->getBlocks(self::TARGET_ID_MAIN_TOP);
        }

        public function getMainBottom()
        {
            return $this->getBlocks(self::TARGET_ID_MAIN_BOTTOM);
        }

        public function getSideRight()
        {
            return $this->getBlocks(self::TARGET_ID_SIDE_RIGHT);
        }

        public function getContentsBottom()
        {
            return $this->getBlocks(self::TARGET_ID_CONTENTS_BOTTOM);
        }

        public function getFooter()
        {
            return $this->getBlocks(self::TARGET_ID_FOOTER);
        }

        public function getDrawer()
        {
            return $this->getBlocks(self::TARGET_ID_DRAWER);
        }

        public function getCloseBodyBefore()
        {
            return $this->getBlocks(self::TARGET_ID_CLOSE_BODY_BEFORE);
        }

        /**
         * Get ColumnNum
         *
         * @return integer
         */
        public function getColumnNum()
        {
            return 1 + ($this->getSideLeft() ? 1 : 0) + ($this->getSideRight() ? 1 : 0);
        }

        // -----------------------
        // generated by doctrine
        // -----------------------

        /**
         * @var integer
         *
         * @ORM\Column(name="id", type="integer", options={"unsigned":true})
         * @ORM\Id
         * @ORM\GeneratedValue(strategy="IDENTITY")
         */
        private $id;

        /**
         * @var string
         *
         * @ORM\Column(name="layout_name", type="string", length=255, nullable=true)
         */
        private $name;

        /**
         * @var \DateTime
         *
         * @ORM\Column(name="create_date", type="datetimetz")
         */
        private $create_date;

        /**
         * @var \DateTime
         *
         * @ORM\Column(name="update_date", type="datetimetz")
         */
        private $update_date;

        /**
         * @var \Doctrine\Common\Collections\Collection
         *
         * @ORM\OneToMany(targetEntity="Eccube\Entity\BlockPosition", mappedBy="Layout", cascade={"persist","remove"})
         */
        private $BlockPositions;

        /**
         * @var \Doctrine\Common\Collections\Collection
         *
         * @ORM\OneToMany(targetEntity="Eccube\Entity\PageLayout", mappedBy="Layout", cascade={"persist","remove"})
         * @ORM\OrderBy({"sort_no" = "ASC"})
         */
        private $PageLayouts;

        /**
         * @var \Eccube\Entity\Master\DeviceType
         *
         * @ORM\ManyToOne(targetEntity="Eccube\Entity\Master\DeviceType")
         * @ORM\JoinColumns({
         *   @ORM\JoinColumn(name="device_type_id", referencedColumnName="id")
         * })
         */
        private $DeviceType;

        /**
         * Constructor
         */
        public function __construct()
        {
            $this->BlockPositions = new \Doctrine\Common\Collections\ArrayCollection();
            $this->PageLayouts = new \Doctrine\Common\Collections\ArrayCollection();
        }

        /**
         * Get id
         *
         * @return integer
         */
        public function getId()
        {
            return $this->id;
        }

        /**
         * Set name
         *
         * @param string $name
         *
         * @return Layout
         */
        public function setName($name)
        {
            $this->name = $name;

            return $this;
        }

        /**
         * Get name
         *
         * @return string
         */
        public function getName()
        {
            return $this->name;
        }

        /**
         * Set createDate
         *
         * @param \DateTime $createDate
         *
         * @return Layout
         */
        public function setCreateDate($createDate)
        {
            $this->create_date = $createDate;

            return $this;
        }

        /**
         * Get createDate
         *
         * @return \DateTime
         */
        public function getCreateDate()
        {
            return $this->create_date;
        }

        /**
         * Set updateDate
         *
         * @param \DateTime $updateDate
         *
         * @return Layout
         */
        public function setUpdateDate($updateDate)
        {
            $this->update_date = $updateDate;

            return $this;
        }

        /**
         * Get updateDate
         *
         * @return \DateTime
         */
        public function getUpdateDate()
        {
            return $this->update_date;
        }

        /**
         * Add blockPosition
         *
         * @param \Eccube\Entity\BlockPosition $blockPosition
         *
         * @return Layout
         */
        public function addBlockPosition(\Eccube\Entity\BlockPosition $blockPosition)
        {
            $this->BlockPositions[] = $blockPosition;

            return $this;
        }

        /**
         * Remove blockPosition
         *
         * @param \Eccube\Entity\BlockPosition $blockPosition
         */
        public function removeBlockPosition(\Eccube\Entity\BlockPosition $blockPosition)
        {
            $this->BlockPositions->removeElement($blockPosition);
        }

        /**
         * Get blockPositions
         *
         * @return \Doctrine\Common\Collections\Collection
         */
        public function getBlockPositions()
        {
            return $this->BlockPositions;
        }

        /**
         * Add pageLayoutLayout
         *
         * @param \Eccube\Entity\PageLayout $PageLayout
         *
         * @return Layout
         */
        public function addPageLayout(\Eccube\Entity\PageLayout $PageLayout)
        {
            $this->PageLayouts[] = $PageLayout;

            return $this;
        }

        /**
         * Remove pageLayoutLayout
         *
         * @param \Eccube\Entity\PageLayout $PageLayout
         */
        public function removePageLayout(\Eccube\Entity\PageLayout $PageLayout)
        {
            $this->PageLayouts->removeElement($PageLayout);
        }

        /**
         * Get pageLayoutLayouts
         *
         * @return \Doctrine\Common\Collections\Collection
         */
        public function getPageLayouts()
        {
            return $this->PageLayouts;
        }

        /**
         * Set deviceType
         *
         * @param \Eccube\Entity\Master\DeviceType $deviceType
         *
         * @return Layout
         */
        public function setDeviceType(\Eccube\Entity\Master\DeviceType $deviceType = null)
        {
            $this->DeviceType = $deviceType;

            return $this;
        }

        /**
         * Get deviceType
         *
         * @return \Eccube\Entity\Master\DeviceType
         */
        public function getDeviceType()
        {
            return $this->DeviceType;
        }

        /**
         * Check layout can delete or not
         *
         * @return boolean
         */
        public function isDeletable()
        {
            if (!$this->getPageLayouts()->isEmpty()) {
                return false;
            }

            return true;
        }
    }
}