Completed
Pull Request — master (#2117)
by Ryo
48:58
created

TaxRuleRepository::getByRule()   F

Complexity

Conditions 28
Paths > 20000

Size

Total Lines 152
Code Lines 91

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 76
CRAP Score 28.3075

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 28
eloc 91
c 2
b 0
f 0
nc 124741
nop 4
dl 0
loc 152
ccs 76
cts 82
cp 0.9268
crap 28.3075
rs 2

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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 Doctrine\ORM\EntityRepository;
28
use Doctrine\ORM\NoResultException;
29
use Eccube\Common\Constant;
30
31
/**
32
 * TaxRuleRepository
33
 *
34
 * This class was generated by the Doctrine ORM. Add your own custom
35
 * repository methods below.
36
 */
37
class TaxRuleRepository extends EntityRepository
38
{
39
    private $rules = array();
40
41
    protected $app;
42
43 1185
    public function setApplication($app)
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
44
    {
45 1185
        $this->app = $app;
46
    }
47
48 11
    public function newTaxRule()
0 ignored issues
show
introduced by
Missing function doc comment
Loading history...
49
    {
50 11
        $TaxRule = new \Eccube\Entity\TaxRule();
51 11
        $CalcRule = $this->getEntityManager()
52 11
            ->getRepository('Eccube\Entity\Master\Taxrule')
53 11
            ->find(1);
54 11
        $TaxRule->setCalcRule($CalcRule);
55 11
        $TaxRule->setTaxAdjust(0);
56 11
        $TaxRule->setDelFlg(0);
57
58 11
        return $TaxRule;
59
    }
60
61
    /**
62
     * 現在有効な税率設定情報を返す
63
     *
64
     * @param  int|null|\Eccube\Entity\Product        $Product      商品
65
     * @param  int|null|\Eccube\Entity\ProductClass   $ProductClass 商品規格
66
     * @param  int|null|\Eccube\Entity\Master\Pref    $Pref         都道府県
67
     * @param  int|null|\Eccube\Entity\Master\Country $Country      国
68
     * @return \Eccube\Entity\TaxRule                 税設定情報
69
     *
70
     * @throws NoResultException
71
     */
72 436
    public function getByRule($Product = null, $ProductClass = null, $Pref = null, $Country = null)
73
    {
74 436
        if (!$this->app) {
75
            throw new \LogicException();
76
        }
77
78
        // Pref Country 設定
79 436
        if (!$Pref && !$Country && $this->app['security']->getToken() && $this->app['security']->isGranted('ROLE_USER')) {
80
            /* @var $Customer \Eccube\Entity\Customer */
81 110
            $Customer = $this->app['security']->getToken()->getUser();
82 110
            $Pref = $Customer->getPref();
83 110
            $Country = $Customer->getCountry();
84
        }
85
86
        // 商品単位税率設定がOFFの場合
87
        /** @var $BaseInfo \Eccube\Entity\BaseInfo */
88 436
        $BaseInfo = $this->app['eccube.repository.base_info']->get();
89 436
        if ($BaseInfo->getOptionProductTaxRule() !== Constant::ENABLED) {
90 414
            $Product = null;
91 414
            $ProductClass = null;
92
        }
93
94
        // Cache Key 設定
95 436
        if ($Product instanceof \Eccube\Entity\Product) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\Product does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
96 25
            $productId = $Product->getId();
97 414
        } elseif ($Product) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $Product of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
98
            $productId = $Product;
99
        } else {
100 414
            $productId = '0';
101
        }
102 436
        if ($ProductClass instanceof \Eccube\Entity\ProductClass) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\ProductClass does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
103 24
            $productClassId = $ProductClass->getId();
104 414
        } elseif ($ProductClass) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $ProductClass of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
105
            $productClassId = $ProductClass;
106
        } else {
107 414
            $productClassId = '0';
108
        }
109 436
        if ($Pref instanceof \Eccube\Entity\Master\Pref) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\Master\Pref does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
110 111
            $prefId = $Pref->getId();
111 327
        } elseif ($Pref) {
112
            $prefId = $Pref;
113
        } else {
114 327
            $prefId = '0';
115
        }
116 436
        if ($Country instanceof \Eccube\Entity\Master\Country) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\Master\Country does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
117 2
            $countryId = $Country->getId();
118 436
        } elseif ($Country) {
119
            $countryId = $Country;
120
        } else {
121 436
            $countryId = '0';
122
        }
123 436
        $cacheKey = $productId.':'.$productClassId.':'.$prefId.':'.$countryId;
124
125
        // すでに取得している場合はキャッシュから
126 436
        if (isset($this->rules[$cacheKey])) {
127 434
            return $this->rules[$cacheKey];
128
        }
129
130 436
        $parameters = array();
131 436
        $qb = $this->createQueryBuilder('t')
132 436
            ->where('t.apply_date < :apply_date');
133 436
        $parameters[':apply_date'] = new \DateTime();
134
135
        // Pref
136 436
        if ($Pref) {
137 111
            $qb->andWhere('t.Pref IS NULL OR t.Pref = :Pref');
138 111
            $parameters['Pref'] = $Pref;
139
        } else {
140 327
            $qb->andWhere('t.Pref IS NULL');
141
        }
142
143
        // Country
144 436
        if ($Country) {
145 2
            $qb->andWhere('t.Country IS NULL OR t.Country = :Country');
146 2
            $parameters['Country'] = $Country;
147
        } else {
148 436
            $qb->andWhere('t.Country IS NULL');
149
        }
150
151
        /*
152
         * Product, ProductClass が persist される前に TaxRuleEventSubscriber によってアクセスされる
153
         * 場合があるため、ID の存在もチェックする.
154
         * https://github.com/EC-CUBE/ec-cube/issues/677
155
         */
156
157
        // Product
158 436
        if ($Product && $productId > 0) {
159 25
            $qb->andWhere('t.Product IS NULL OR t.Product = :Product');
160 25
            $parameters['Product'] = $Product;
161
        } else {
162 417
            $qb->andWhere('t.Product IS NULL');
163
        }
164
165
        // ProductClass
166 436
        if ($ProductClass && $productClassId > 0) {
167 24
            $qb->andWhere('t.ProductClass IS NULL OR t.ProductClass = :ProductClass');
168 24
            $parameters['ProductClass'] = $ProductClass;
169
        } else {
170 432
            $qb->andWhere('t.ProductClass IS NULL');
171
        }
172
173
        $TaxRules = $qb
174 436
            ->setParameters($parameters)
175 436
            ->orderBy('t.apply_date', 'DESC') // 実際は usort() でソートする
176 436
            ->getQuery()
177 436
            ->getResult();
178
179
        // 地域設定を優先するが、システムパラメーターなどに設定を持っていくか
180
        // 後に書いてあるほど優先される
181 436
        $priorityKeys = explode(',', $this->app['config']['tax_rule_priority']);
0 ignored issues
show
Unused Code introduced by
$priorityKeys is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
182 436
        $priorityKeys = array();
183 436
        foreach (explode(',', $this->app['config']['tax_rule_priority']) as $key) {
184 436
            $priorityKeys[] = str_replace('_', '', preg_replace('/_id\z/', '', $key));
185
        }
186
187 436
        foreach ($TaxRules as $TaxRule) {
188 436
            $rank = 0;
189 436
            foreach ($priorityKeys as $index => $key) {
190 436
                $arrayProperties = array_change_key_case($TaxRule->toArray());
191 436
                if ($arrayProperties[$key]) {
0 ignored issues
show
Coding Style introduced by
Blank line found at start of control structure
Loading history...
192
193
                    // 配列の数値添字を重みとして利用する
194 436
                    $rank += 1 << ($index + 1);
195
                }
196
            }
197 436
            $TaxRule->setRank($rank);
198
        }
199
200
        // 適用日降順, rank 降順にソートする
201 436
        usort($TaxRules, function($a, $b) {
0 ignored issues
show
Coding Style introduced by
Expected 1 space after FUNCTION keyword; 0 found
Loading history...
202 7
            return $a->compareTo($b);
203 436
        });
204
205 436
        if (!empty($TaxRules)) {
206 436
            $TaxRule = $TaxRules[0];
207
208
            // 商品個別税率の場合は、共通税率設定の課税規則を適用して返却
209 436
            $RelatedProduct = $TaxRule->getProduct();
210 436
            if (!empty($RelatedProduct)) {
211 1
                $CommonTaxRule = $this->getByRule();
212 1
                $CommonCalcRule = $CommonTaxRule->getCalcRule();
213 1
                $TaxRule->setCalcRule($CommonCalcRule);
214
            }
215
216
            // キャッシュに保存
217 436
            $this->rules[$cacheKey] = $TaxRule;
218
219 436
            return $TaxRule;
220
        } else {
221
            throw new NoResultException();
222
        }
223
    }
224
225
    /**
226
     * getList
227
     *
228
     * @return array|null
229
     */
230 5
    public function getList()
231
    {
232 5
        $qb = $this->createQueryBuilder('t')
233 5
            ->orderBy('t.apply_date', 'DESC')
234 5
            ->where('t.Product IS NULL AND t.ProductClass IS NULL');
235
        $TaxRules = $qb
236 5
            ->getQuery()
237 5
            ->getResult();
238
239 5
        return $TaxRules;
240
    }
241
242
    /**
243
     * getById
244
     *
245
     * @param  int   $id
0 ignored issues
show
introduced by
Expected 1 spaces after parameter type; 3 found
Loading history...
246
     * @return array
247
     */
248 1
    public function getById($id)
249
    {
250
        $criteria = array(
251 1
            'id' => $id,
252
        );
253
254 1
        return $this->findOneBy($criteria);
255
    }
256
257
    /**
258
     * getByTime
259
     *
260
     * @param  string $applyDate
261
     * @return mixed
262
     */
263
    public function getByTime($applyDate)
264
    {
265
        $criteria = array(
266
            'apply_date' => $applyDate,
267
        );
268
269
        return $this->findOneBy($criteria);
270
    }
271
272
    /**
273
     * 税規約の削除.
274
     *
275
     * @param  int|\Eccube\Entity\TaxRule $TaxRule 税規約
276
     * @return void
277
     * @throws NoResultException
278
     */
279 3
    public function delete($TaxRule)
280
    {
281 3
        if (!$TaxRule instanceof \Eccube\Entity\TaxRule) {
0 ignored issues
show
Bug introduced by
The class Eccube\Entity\TaxRule does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
282 1
            $TaxRule = $this->find($TaxRule);
283
        }
284 3
        if (!$TaxRule) {
285
            throw new NoResultException;
0 ignored issues
show
introduced by
Use parentheses when instantiating classes
Loading history...
286
        }
287 3
        $TaxRule->setDelFlg(1);
288 3
        $em = $this->getEntityManager();
289 3
        $em->persist($TaxRule);
290 3
        $em->flush();
291
    }
292
293
    /**
294
     * TaxRule のキャッシュをクリアする.
295
     *
296
     * getByRule() をコールすると、結果をキャッシュし、2回目以降はデータベースへアクセスしない.
297
     * このメソッドをコールすると、キャッシュをクリアし、再度データベースを参照して結果を取得する.
298
     */
299 7
    public function clearCache()
300
    {
301 7
        $this->rules = array();
302
    }
303
}
304