PageLayoutRepository::getReadTemplateFile() - Code Metrics - Inspection of "WIP：日時データ型の対応" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — experimental/3.1 (#2308)

by chihiro

created 2017-05-09 09:40 UTC

PageLayoutRepository::getReadTemplateFile() B

↳ Parent: PageLayoutRepository

Complexity

Conditions	4
Paths	6

Size

Total Lines	24
Code Lines	15

Duplication

Lines	10
Ratio	41.67 %

Code Coverage

Tests	7
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	15
nc	6
nop	2
dl	10
loc	24
ccs	7
cts	7
cp	1
crap	4
rs	8.6845
c	0
b	0
f	0

<?php
/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */


namespace Eccube\Repository;

use Eccube\Entity\Master\DeviceType;
use Eccube\Entity\PageLayout;
use Symfony\Component\Filesystem\Filesystem;

/**
 * PageLayoutRepository
 *
 * This class was generated by the Doctrine ORM. Add your own custom
 * repository methods below.
 */
class PageLayoutRepository extends AbstractRepository
{

    public function findUnusedBlocks(DeviceType $DeviceType, $pageId)

    {
        $em = $this
            ->getEntityManager();
        $blockRepo = $em->getRepository('Eccube\Entity\Block');
        $ownBlockPositions = $this->getByDeviceTypeAndId($DeviceType, $pageId)->getBlockPositions();
        $ids = array();
        foreach ($ownBlockPositions as $ownBlockPosition) {
            $ids[] = $ownBlockPosition->getBlock()->getId();
        }

        # $idsが空配列だと、$ids以外のblockを取得するSQLが生成されないため、存在しないidを入れる

        if (empty($ids)) {
            $ids[] = \Eccube\Entity\Block::UNUSED_BLOCK_ID;
        }

        return $blockRepo->createQueryBuilder('b')
            ->where('b.id not in (:ids)')
            ->setParameter(':ids', $ids)
            ->getQuery()
            ->getResult();
    }

    public function getByDeviceTypeAndId(DeviceType $DeviceType, $pageId)

    {
        $qb = $this->createQueryBuilder('p')
            ->select('p, bp, b')
            ->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
            ->leftJoin('bp.Block', 'b')
            ->andWhere('p.DeviceType = :DeviceType AND p.id = :pageId')
            ->addOrderBy('bp.target_id', 'ASC')
            ->addOrderBy('bp.block_row', 'ASC');

        $ownResult = $qb
            ->getQuery()
            ->setParameters(array(
                'DeviceType'  => $DeviceType,
                'pageId'        => $pageId,
            ))
            ->getSingleResult();

        $qb = $this->createQueryBuilder('p')
            ->select('p, bp, b')
            ->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
            ->leftJoin('bp.Block', 'b')
            ->andWhere('p.DeviceType = :DeviceType AND bp.anywhere = 1')
            ->addOrderBy('bp.target_id', 'ASC')
            ->addOrderBy('bp.block_row', 'ASC');

        $anyResults = $qb
            ->getQuery()
            ->setParameters(array(
                'DeviceType' => $DeviceType,
            ))
            ->getResult();

        $OwnBlockPosition = $ownResult->getBlockPositions();
        foreach ($anyResults as $anyResult) {
            $BlockPositions = $anyResult->getBlockPositions();
            foreach ($BlockPositions as $BlockPosition) {
                if (!$OwnBlockPosition->contains($BlockPosition)) {
                    $ownResult->addBlockPosition($BlockPosition);
                }
            }
        }

        return $ownResult;

    }

    public function getByUrl(DeviceType $DeviceType, $url)

    {
        $options = $this->app['config']['doctrine_cache'];
        $lifetime = $options['result_cache']['lifetime'];

        $qb = $this->createQueryBuilder('p')
            ->select('p, bp, b')
            ->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
            ->leftJoin('bp.Block', 'b')
            ->andWhere('p.DeviceType = :DeviceType AND p.url = :url')
            ->addOrderBy('bp.target_id', 'ASC')
            ->addOrderBy('bp.block_row', 'ASC');

        $ownResult = $qb
            ->getQuery()
            ->useResultCache(true, $lifetime)
            ->setParameters(array(
                'DeviceType' => $DeviceType,
                'url'  => $url,
            ))
            ->getSingleResult();

        $qb = $this->createQueryBuilder('p')
            ->select('p, bp, b')
            ->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
            ->leftJoin('bp.Block', 'b')
            ->andWhere('p.DeviceType = :DeviceType AND bp.anywhere = 1')
            ->addOrderBy('bp.target_id', 'ASC')
            ->addOrderBy('bp.block_row', 'ASC');

        $anyResults = $qb
            ->getQuery()
            ->useResultCache(true, $lifetime)
            ->setParameters(array(
                'DeviceType' => $DeviceType,
            ))
            ->getResult();

        $OwnBlockPosition = $ownResult->getBlockPositions();
        foreach ($anyResults as $anyResult) {
            $BlockPositions = $anyResult->getBlockPositions();
            foreach ($BlockPositions as $BlockPosition) {
                if (!$OwnBlockPosition->contains($BlockPosition)) {
                    $ownResult->addBlockPosition($BlockPosition);
                }
            }
        }

        return $ownResult;
    }

    public function newPageLayout(DeviceType $DeviceType)

    {
        $PageLayout = new \Eccube\Entity\PageLayout();
        $PageLayout
            ->setDeviceType($DeviceType)
            ->setEditFlg(PageLayout::EDIT_FLG_USER);

        return $PageLayout;
    }

    public function findOrCreate($page_id, DeviceType $DeviceType)

    {
        if (is_null($page_id)) {
            $PageLayout = $this
                ->newPageLayout($DeviceType);
            return $PageLayout;

        } else {
            return $this->getByDeviceTypeAndId($DeviceType, $page_id);
        }
    }

    /**
     * ページの属性を取得する.
     *
     * この関数は, dtb_pagelayout の情報を検索する.
     * $deviceTypeId は必須. デフォルト値は DEVICE_TYPE_PC.
     *
     * @access public
     * @param  \Eccube\Entity\Master\DeviceType  $DeviceType 端末種別ID

     * @param  string                            $where 追加の検索条件

     * @param  string[]                          $parameters 追加の検索パラメーター

     * @return array                             ページ属性の配列
     */
    public function getPageList(DeviceType $DeviceType, $where = null, $parameters = array())

    {
        $qb = $this->createQueryBuilder('l')
            ->orderBy('l.id', 'DESC')
            ->where('l.DeviceType = :DeviceType')
            ->setParameter('DeviceType', $DeviceType)
            ->andWhere('l.id <> 0')
            ->orderBy('l.id', 'ASC');
        if (!is_null($where)) {
            $qb->andWhere($where);
            foreach ($parameters as $key => $val) {
                $qb->setParameter($key, $val);
            }
        }

        $PageLayouts = $qb
            ->getQuery()
            ->getResult();

        return $PageLayouts;
    }

    /**
     * 書き込みパスの取得
     * User定義の場合： /html/user_data
     * そうでない場合： /app/template/{template_code}
     *
     * @param  boolean $isUser
     * @return string
     */
    public function getWriteTemplatePath($isUser = false)
    {
        return ($isUser) ? $this->app['config']['user_data_realdir'] : $this->app['config']['template_realdir'];
    }

    /**
     * 読み込みファイルの取得
     *
     * 1. template_realdir
     *      app/template/{template_code}
     * 2. template_default_readldir
     *      src/Eccube/Resource/template/default
     *
     * @param string $fileName

     * @param  boolean $isUser
     *
     * @return array
     */
    public function getReadTemplateFile($fileName, $isUser = false)
    {
        if ($isUser) {
            $readPaths = array(
                $this->app['config']['user_data_realdir'],
            );
        } else {
            $readPaths = array(
                $this->app['config']['template_realdir'],
                $this->app['config']['template_default_realdir'],
            );
        }

        foreach ($readPaths as $readPath) {
            $filePath = $readPath . '/' . $fileName . '.twig';

            $fs = new Filesystem();
            if ($fs->exists($filePath)) {
                return array(
                    'file_name' => $fileName,
                    'tpl_data' => file_get_contents($filePath),
                );
            }
        }
    }
}


1			<?php
2			/*
3			* This file is part of EC-CUBE
4			*
5			* Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
6			*
7			* http://www.lockon.co.jp/
8			*
9			* This program is free software; you can redistribute it and/or
10			* modify it under the terms of the GNU General Public License
11			* as published by the Free Software Foundation; either version 2
12			* of the License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU General Public License for more details.
18			*
19			* You should have received a copy of the GNU General Public License
20			* along with this program; if not, write to the Free Software
21			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22			*/
23
24
25			namespace Eccube\Repository;
26
27			use Eccube\Entity\Master\DeviceType;
28			use Eccube\Entity\PageLayout;
29			use Symfony\Component\Filesystem\Filesystem;
30
31			/**
32			* PageLayoutRepository
33			*
34			* This class was generated by the Doctrine ORM. Add your own custom
35			* repository methods below.
36			*/
37			class PageLayoutRepository extends AbstractRepository
38			{
39
40			public function findUnusedBlocks(DeviceType $DeviceType, $pageId)
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
41			{
42			$em = $this
43			->getEntityManager();
44	196		$blockRepo = $em->getRepository('Eccube\Entity\Block');
45			$ownBlockPositions = $this->getByDeviceTypeAndId($DeviceType, $pageId)->getBlockPositions();
46	196		$ids = array();
47			foreach ($ownBlockPositions as $ownBlockPosition) {
48			$ids[] = $ownBlockPosition->getBlock()->getId();
49	7		}
50
51			# $idsが空配列だと、$ids以外のblockを取得するSQLが生成されないため、存在しないidを入れる
			0 ignored issues – show Coding Style introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Loading history...
52	7		if (empty($ids)) {
53	7		$ids[] = \Eccube\Entity\Block::UNUSED_BLOCK_ID;
54	7		}
55	7
56	7		return $blockRepo->createQueryBuilder('b')
57	7		->where('b.id not in (:ids)')
58			->setParameter(':ids', $ids)
59			->getQuery()
60			->getResult();
61	7		}
62
63			public function getByDeviceTypeAndId(DeviceType $DeviceType, $pageId)
			0 ignored issues – show introduced 2017-04-28 11:01 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
64			{
65	7		$qb = $this->createQueryBuilder('p')
66	7		->select('p, bp, b')
67	7		->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
68	7		->leftJoin('bp.Block', 'b')
69	7		->andWhere('p.DeviceType = :DeviceType AND p.id = :pageId')
70			->addOrderBy('bp.target_id', 'ASC')
71			->addOrderBy('bp.block_row', 'ASC');
72	12
73			$ownResult = $qb
74	12		->getQuery()
75	12		->setParameters(array(
76	12		'DeviceType' => $DeviceType,
77	12		'pageId' => $pageId,
78	12		))
79	12		->getSingleResult();
80	12
81			$qb = $this->createQueryBuilder('p')
82			->select('p, bp, b')
83	12		->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
84	12		->leftJoin('bp.Block', 'b')
85	12		->andWhere('p.DeviceType = :DeviceType AND bp.anywhere = 1')
86	12		->addOrderBy('bp.target_id', 'ASC')
87			->addOrderBy('bp.block_row', 'ASC');
88	12
89			$anyResults = $qb
90	12		->getQuery()
91	12		->setParameters(array(
92	12		'DeviceType' => $DeviceType,
93	12		))
94	12		->getResult();
95	12
96	12		$OwnBlockPosition = $ownResult->getBlockPositions();
97		View Code Duplication	foreach ($anyResults as $anyResult) {
98			$BlockPositions = $anyResult->getBlockPositions();
99	12		foreach ($BlockPositions as $BlockPosition) {
100	12		if (!$OwnBlockPosition->contains($BlockPosition)) {
101	12		$ownResult->addBlockPosition($BlockPosition);
102			}
103	12		}
104			}
105	12
106	12		return $ownResult;
107	12
108	12		}
109	12
110	12		public function getByUrl(DeviceType $DeviceType, $url)
			0 ignored issues – show introduced 2017-04-17 02:04 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
111			{
112			$options = $this->app['config']['doctrine_cache'];
113			$lifetime = $options['result_cache']['lifetime'];
114
115	12		$qb = $this->createQueryBuilder('p')
116			->select('p, bp, b')
117			->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
118			->leftJoin('bp.Block', 'b')
119	171		->andWhere('p.DeviceType = :DeviceType AND p.url = :url')
120			->addOrderBy('bp.target_id', 'ASC')
121	171		->addOrderBy('bp.block_row', 'ASC');
122	171
123			$ownResult = $qb
124	171		->getQuery()
125	171		->useResultCache(true, $lifetime)
126	171		->setParameters(array(
127	171		'DeviceType' => $DeviceType,
128	171		'url' => $url,
129	171		))
130	171		->getSingleResult();
131
132			$qb = $this->createQueryBuilder('p')
133	171		->select('p, bp, b')
134	171		->leftJoin('p.BlockPositions', 'bp', 'WITH', 'p.id = bp.page_id')
135	171		->leftJoin('bp.Block', 'b')
136	171		->andWhere('p.DeviceType = :DeviceType AND bp.anywhere = 1')
137	171		->addOrderBy('bp.target_id', 'ASC')
138			->addOrderBy('bp.block_row', 'ASC');
139	171
140			$anyResults = $qb
141	102		->getQuery()
142	102		->useResultCache(true, $lifetime)
143	102		->setParameters(array(
144	102		'DeviceType' => $DeviceType,
145	102		))
146	102		->getResult();
147	102
148			$OwnBlockPosition = $ownResult->getBlockPositions();
149		View Code Duplication	foreach ($anyResults as $anyResult) {
150	102		$BlockPositions = $anyResult->getBlockPositions();
151	102		foreach ($BlockPositions as $BlockPosition) {
152	102		if (!$OwnBlockPosition->contains($BlockPosition)) {
153	102		$ownResult->addBlockPosition($BlockPosition);
154			}
155	102		}
156			}
157	102
158	102		return $ownResult;
159	102		}
160	102
161	102		public function newPageLayout(DeviceType $DeviceType)
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
162	102		{
163			$PageLayout = new \Eccube\Entity\PageLayout();
164			$PageLayout
165			->setDeviceType($DeviceType)
166			->setEditFlg(PageLayout::EDIT_FLG_USER);
167	102
168			return $PageLayout;
169			}
170	71
171			public function findOrCreate($page_id, DeviceType $DeviceType)
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Missing function doc comment Loading history...
172	71		{
173			if (is_null($page_id)) {
174	71		$PageLayout = $this
175	71		->newPageLayout($DeviceType);
176			return $PageLayout;
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Missing blank line before return statement Loading history...
177	71		} else {
178			return $this->getByDeviceTypeAndId($DeviceType, $page_id);
179			}
180	6		}
181
182	6		/**
183			* ページの属性を取得する.
184	2		*
185	2		* この関数は, dtb_pagelayout の情報を検索する.
186			* $deviceTypeId は必須. デフォルト値は DEVICE_TYPE_PC.
187	4		*
188			* @access public
189			* @param \Eccube\Entity\Master\DeviceType $DeviceType 端末種別ID
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter type; 2 found Loading history...
190			* @param string $where 追加の検索条件
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Expected 27 spaces after parameter type; 28 found Loading history... introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Expected 6 spaces after parameter name; 1 found Loading history...
191			* @param string[] $parameters 追加の検索パラメーター
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Expected 25 spaces after parameter type; 26 found Loading history...
192			* @return array ページ属性の配列
193			*/
194		View Code Duplication	public function getPageList(DeviceType $DeviceType, $where = null, $parameters = array())
			0 ignored issues – show Duplication introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195			{
196			$qb = $this->createQueryBuilder('l')
197			->orderBy('l.id', 'DESC')
198			->where('l.DeviceType = :DeviceType')
199			->setParameter('DeviceType', $DeviceType)
200			->andWhere('l.id <> 0')
201			->orderBy('l.id', 'ASC');
202			if (!is_null($where)) {
203	3		$qb->andWhere($where);
204			foreach ($parameters as $key => $val) {
205	3		$qb->setParameter($key, $val);
206	3		}
207	3		}
208	3
209	3		$PageLayouts = $qb
210	3		->getQuery()
211	3		->getResult();
212
213			return $PageLayouts;
214			}
215
216			/**
217			* 書き込みパスの取得
218			* User定義の場合： /html/user_data
219	3		* そうでない場合： /app/template/{template_code}
220	3		*
221			* @param boolean $isUser
222	3		* @return string
223			*/
224			public function getWriteTemplatePath($isUser = false)
225			{
226			return ($isUser) ? $this->app['config']['user_data_realdir'] : $this->app['config']['template_realdir'];
227			}
228
229			/**
230			* 読み込みファイルの取得
231			*
232			* 1. template_realdir
233	8		* app/template/{template_code}
234			* 2. template_default_readldir
235	8		* src/Eccube/Resource/template/default
236			*
237			* @param string $fileName
			0 ignored issues – show introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Expected 2 spaces after parameter type; 1 found Loading history...
238			* @param boolean $isUser
239			*
240			* @return array
241			*/
242			public function getReadTemplateFile($fileName, $isUser = false)
243			{
244			if ($isUser) {
245			$readPaths = array(
246			$this->app['config']['user_data_realdir'],
247			);
248			} else {
249			$readPaths = array(
250			$this->app['config']['template_realdir'],
251	6		$this->app['config']['template_default_realdir'],
252			);
253	6		}
254
255	1	View Code Duplication	foreach ($readPaths as $readPath) {
256			$filePath = $readPath . '/' . $fileName . '.twig';
			0 ignored issues – show Coding Style introduced 2015-11-21 02:41 UTC by Report Bug Copy Issue Report Concat operator must not be surrounded by spaces Loading history...
257			$fs = new Filesystem();
258			if ($fs->exists($filePath)) {
259	5		return array(
260	5		'file_name' => $fileName,
261			'tpl_data' => file_get_contents($filePath),
262			);
263			}
264	6		}
265	6		}
266			}
267

EC-CUBE / ec-cube

Pull Request — experimental/3.1 (#2308)

PageLayoutRepository::getReadTemplateFile() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like