Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like CustomerRepository often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use CustomerRepository, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class CustomerRepository extends AbstractRepository |
||
| 32 | { |
||
| 33 | /** |
||
| 34 | * @var Queries |
||
| 35 | */ |
||
| 36 | protected $queries; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @var EntityManagerInterface |
||
| 40 | */ |
||
| 41 | protected $entityManager; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * @var OrderRepository |
||
| 45 | */ |
||
| 46 | protected $orderRepository; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * @var EccubeConfig |
||
| 50 | */ |
||
| 51 | protected $eccubeConfig; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var EncoderFactoryInterface |
||
| 55 | */ |
||
| 56 | protected $encoderFactory; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * CustomerRepository constructor. |
||
| 60 | * |
||
| 61 | * @param RegistryInterface $registry |
||
| 62 | * @param Queries $queries |
||
| 63 | * @param EntityManagerInterface $entityManager |
||
| 64 | * @param OrderRepository $orderRepository |
||
| 65 | * @param EncoderFactoryInterface $encoderFactory |
||
| 66 | * @param EccubeConfig $eccubeConfig |
||
| 67 | */ |
||
| 68 | public function __construct( |
||
| 84 | |||
| 85 | public function newCustomer() |
||
| 96 | |||
| 97 | public function getQueryBuilderBySearchData($searchData) |
||
| 98 | 40 | { |
|
| 99 | $qb = $this->createQueryBuilder('c') |
||
| 100 | 40 | ->select('c'); |
|
| 101 | 40 | ||
| 102 | if (isset($searchData['multi']) && StringUtil::isNotBlank($searchData['multi'])) { |
||
| 103 | 40 | //スペース除去 |
|
| 104 | $clean_key_multi = preg_replace('/\s+|[ ]+/u', '', $searchData['multi']); |
||
| 105 | 13 | $id = preg_match('/^\d{0,10}$/', $clean_key_multi) ? $clean_key_multi : null; |
|
| 106 | 13 | $qb |
|
| 107 | ->andWhere('c.id = :customer_id OR CONCAT(c.name01, c.name02) LIKE :name OR CONCAT(c.kana01, c.kana02) LIKE :kana OR c.email LIKE :email') |
||
| 108 | 13 | ->setParameter('customer_id', $id) |
|
| 109 | 13 | ->setParameter('name', '%'.$clean_key_multi.'%') |
|
| 110 | 13 | ->setParameter('kana', '%'.$clean_key_multi.'%') |
|
| 111 | 13 | ->setParameter('email', '%'.$clean_key_multi.'%'); |
|
| 112 | 13 | } |
|
| 113 | |||
| 114 | // Pref |
||
| 115 | if (!empty($searchData['pref']) && $searchData['pref']) { |
||
| 116 | 40 | $qb |
|
| 117 | ->andWhere('c.Pref = :pref') |
||
| 118 | 1 | ->setParameter('pref', $searchData['pref']->getId()); |
|
| 119 | 1 | } |
|
| 120 | |||
| 121 | // sex |
||
| 122 | if (!empty($searchData['sex']) && count($searchData['sex']) > 0) { |
||
| 123 | 40 | $sexs = []; |
|
| 124 | 2 | foreach ($searchData['sex'] as $sex) { |
|
| 125 | 2 | $sexs[] = $sex->getId(); |
|
| 126 | 2 | } |
|
| 127 | |||
| 128 | $qb |
||
| 129 | ->andWhere($qb->expr()->in('c.Sex', ':sexs')) |
||
| 130 | 2 | ->setParameter('sexs', $sexs); |
|
| 131 | 2 | } |
|
| 132 | |||
| 133 | if (!empty($searchData['birth_month']) && $searchData['birth_month']) { |
||
| 134 | 40 | $qb |
|
| 135 | ->andWhere('EXTRACT(MONTH FROM c.birth) = :birth_month') |
||
| 136 | 1 | ->setParameter('birth_month', $searchData['birth_month']); |
|
| 137 | 1 | } |
|
| 138 | |||
| 139 | // birth |
||
| 140 | if (!empty($searchData['birth_start']) && $searchData['birth_start']) { |
||
| 141 | 40 | $qb |
|
| 142 | ->andWhere('c.birth >= :birth_start') |
||
| 143 | 2 | ->setParameter('birth_start', $searchData['birth_start']); |
|
| 144 | 2 | } |
|
| 145 | View Code Duplication | if (!empty($searchData['birth_end']) && $searchData['birth_end']) { |
|
| 146 | 40 | $date = clone $searchData['birth_end']; |
|
| 147 | 2 | $date->modify('+1 days'); |
|
| 148 | 2 | $qb |
|
| 149 | ->andWhere('c.birth < :birth_end') |
||
| 150 | 2 | ->setParameter('birth_end', $date); |
|
| 151 | 2 | } |
|
| 152 | |||
| 153 | // tel |
||
| 154 | View Code Duplication | if (isset($searchData['phone_number']) && StringUtil::isNotBlank($searchData['phone_number'])) { |
|
| 155 | 40 | $tel = preg_replace('/[^0-9]/ ', '', $searchData['phone_number']); |
|
| 156 | 1 | $qb |
|
| 157 | ->andWhere('c.phone_number LIKE :phone_number') |
||
| 158 | 1 | ->setParameter('phone_number', '%'.$tel.'%'); |
|
| 159 | 1 | } |
|
| 160 | |||
| 161 | // buy_total |
||
| 162 | View Code Duplication | if (isset($searchData['buy_total_start']) && StringUtil::isNotBlank($searchData['buy_total_start'])) { |
|
| 163 | 40 | $qb |
|
| 164 | ->andWhere('c.buy_total >= :buy_total_start') |
||
| 165 | 1 | ->setParameter('buy_total_start', $searchData['buy_total_start']); |
|
| 166 | 1 | } |
|
| 167 | View Code Duplication | if (isset($searchData['buy_total_end']) && StringUtil::isNotBlank($searchData['buy_total_end'])) { |
|
| 168 | 40 | $qb |
|
| 169 | ->andWhere('c.buy_total <= :buy_total_end') |
||
| 170 | 1 | ->setParameter('buy_total_end', $searchData['buy_total_end']); |
|
| 171 | 1 | } |
|
| 172 | |||
| 173 | // buy_times |
||
| 174 | View Code Duplication | if (isset($searchData['buy_times_start']) && StringUtil::isNotBlank($searchData['buy_times_start'])) { |
|
| 175 | 40 | $qb |
|
| 176 | ->andWhere('c.buy_times >= :buy_times_start') |
||
| 177 | 1 | ->setParameter('buy_times_start', $searchData['buy_times_start']); |
|
| 178 | 1 | } |
|
| 179 | View Code Duplication | if (isset($searchData['buy_times_end']) && StringUtil::isNotBlank($searchData['buy_times_end'])) { |
|
| 180 | 40 | $qb |
|
| 181 | ->andWhere('c.buy_times <= :buy_times_end') |
||
| 182 | 1 | ->setParameter('buy_times_end', $searchData['buy_times_end']); |
|
| 183 | 1 | } |
|
| 184 | |||
| 185 | // create_date |
||
| 186 | if (!empty($searchData['create_date_start']) && $searchData['create_date_start']) { |
||
| 187 | 40 | $qb |
|
| 188 | ->andWhere('c.create_date >= :create_date_start') |
||
| 189 | 1 | ->setParameter('create_date_start', $searchData['create_date_start']); |
|
| 190 | 1 | } |
|
| 191 | View Code Duplication | if (!empty($searchData['create_date_end']) && $searchData['create_date_end']) { |
|
| 192 | 40 | $date = clone $searchData['create_date_end']; |
|
| 193 | 1 | $date->modify('+1 days'); |
|
| 194 | 1 | $qb |
|
| 195 | ->andWhere('c.create_date < :create_date_end') |
||
| 196 | 1 | ->setParameter('create_date_end', $date); |
|
| 197 | 1 | } |
|
| 198 | |||
| 199 | // update_date |
||
| 200 | if (!empty($searchData['update_date_start']) && $searchData['update_date_start']) { |
||
| 201 | 40 | $qb |
|
| 202 | ->andWhere('c.update_date >= :update_date_start') |
||
| 203 | 1 | ->setParameter('update_date_start', $searchData['update_date_start']); |
|
| 204 | 1 | } |
|
| 205 | View Code Duplication | if (!empty($searchData['update_date_end']) && $searchData['update_date_end']) { |
|
| 206 | 40 | $date = clone $searchData['update_date_end']; |
|
| 207 | 1 | $date->modify('+1 days'); |
|
| 208 | 1 | $qb |
|
| 209 | ->andWhere('c.update_date < :update_date_end') |
||
| 210 | 1 | ->setParameter('update_date_end', $date); |
|
| 211 | 1 | } |
|
| 212 | |||
| 213 | // last_buy |
||
| 214 | if (!empty($searchData['last_buy_start']) && $searchData['last_buy_start']) { |
||
| 215 | 40 | $qb |
|
| 216 | ->andWhere('c.last_buy_date >= :last_buy_start') |
||
| 217 | 1 | ->setParameter('last_buy_start', $searchData['last_buy_start']); |
|
| 218 | 1 | } |
|
| 219 | View Code Duplication | if (!empty($searchData['last_buy_end']) && $searchData['last_buy_end']) { |
|
| 220 | 40 | $date = clone $searchData['last_buy_end']; |
|
| 221 | 1 | $date->modify('+1 days'); |
|
| 222 | 1 | $qb |
|
| 223 | ->andWhere('c.last_buy_date < :last_buy_end') |
||
| 224 | 1 | ->setParameter('last_buy_end', $date); |
|
| 225 | 1 | } |
|
| 226 | |||
| 227 | // status |
||
| 228 | if (!empty($searchData['customer_status']) && count($searchData['customer_status']) > 0) { |
||
| 229 | 40 | $qb |
|
| 230 | ->andWhere($qb->expr()->in('c.Status', ':statuses')) |
||
| 231 | 4 | ->setParameter('statuses', $searchData['customer_status']); |
|
| 232 | 4 | } |
|
| 233 | |||
| 234 | // buy_product_name |
||
| 235 | if (isset($searchData['buy_product_name']) && StringUtil::isNotBlank($searchData['buy_product_name'])) { |
||
| 236 | 40 | $qb |
|
| 237 | ->leftJoin('c.Orders', 'o') |
||
| 238 | 2 | ->leftJoin('o.OrderItems', 'oi') |
|
| 239 | 2 | ->andWhere('oi.product_name LIKE :buy_product_name') |
|
| 240 | 2 | ->setParameter('buy_product_name', '%'.$searchData['buy_product_name'].'%'); |
|
| 241 | 2 | } |
|
| 242 | |||
| 243 | // Order By |
||
| 244 | $qb->addOrderBy('c.update_date', 'DESC'); |
||
| 245 | 40 | ||
| 246 | return $this->queries->customize(QueryKey::CUSTOMER_SEARCH, $qb, $searchData); |
||
| 247 | 40 | } |
|
| 248 | |||
| 249 | /** |
||
| 250 | * ユニークなシークレットキーを返す. |
||
| 251 | * |
||
| 252 | * @return string |
||
| 253 | */ |
||
| 254 | View Code Duplication | public function getUniqueSecretKey() |
|
| 263 | |||
| 264 | /** |
||
| 265 | * ユニークなパスワードリセットキーを返す |
||
| 266 | * |
||
| 267 | * @return string |
||
| 268 | */ |
||
| 269 | View Code Duplication | public function getUniqueResetKey() |
|
| 278 | |||
| 279 | /** |
||
| 280 | * 仮会員をシークレットキーで検索する. |
||
| 281 | * |
||
| 282 | * @param $secretKey |
||
| 283 | * |
||
| 284 | * @return null|Customer 見つからない場合はnullを返す. |
||
| 285 | */ |
||
| 286 | public function getProvisionalCustomerBySecretKey($secretKey) |
||
| 293 | |||
| 294 | /** |
||
| 295 | * 本会員をemailで検索する. |
||
| 296 | * |
||
| 297 | * @param $email |
||
| 298 | * |
||
| 299 | * @return null|Customer 見つからない場合はnullを返す. |
||
| 300 | */ |
||
| 301 | public function getRegularCustomerByEmail($email) |
||
| 308 | |||
| 309 | /** |
||
| 310 | * 本会員をリセットキー、またはリセットキーとメールアドレスで検索する. |
||
| 311 | * |
||
| 312 | * @param $resetKey |
||
| 313 | * @param $email |
||
| 314 | * |
||
| 315 | * @return null|Customer 見つからない場合はnullを返す. |
||
| 316 | */ |
||
| 317 | 3 | public function getRegularCustomerByResetKey($resetKey, $email = null) |
|
| 335 | |||
| 336 | 2 | /** |
|
| 337 | * リセット用パスワードを生成する. |
||
| 338 | * |
||
| 339 | * @return string |
||
| 340 | */ |
||
| 341 | public function getResetPassword() |
||
| 345 | 1 | ||
| 346 | /** |
||
| 347 | * 仮会員, 本会員の会員を返す. |
||
| 348 | * Eccube\Entity\CustomerのUniqueEntityバリデーションで使用しています. |
||
| 349 | * |
||
| 350 | 1 | * @param array $criteria |
|
| 351 | * |
||
| 352 | * @return Customer[] |
||
| 353 | */ |
||
| 354 | public function getNonWithdrawingCustomers(array $criteria = []) |
||
| 363 | } |
||
| 364 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.