top-think /
framework
| Total Complexity | 107 |
| Total Lines | 620 |
| Duplicated Lines | 0 % |
| Coverage | 0% |
| Changes | 0 | ||
Complex classes like Collection 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.
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 Collection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable |
||
| 25 | { |
||
| 26 | /** |
||
| 27 | * 数据集数据 |
||
| 28 | * @var array |
||
| 29 | */ |
||
| 30 | protected $items = []; |
||
| 31 | |||
| 32 | public function __construct($items = []) |
||
|
Coding Style
introduced
by
|
|||
| 33 | { |
||
| 34 | $this->items = $this->convertToArray($items); |
||
| 35 | } |
||
| 36 | |||
| 37 | public static function make($items = []) |
||
| 38 | { |
||
| 39 | return new static($items); |
||
| 40 | } |
||
| 41 | |||
| 42 | /** |
||
| 43 | * 是否为空 |
||
| 44 | * @access public |
||
| 45 | * @return bool |
||
| 46 | */ |
||
| 47 | public function isEmpty(): bool |
||
| 48 | { |
||
| 49 | return empty($this->items); |
||
| 50 | } |
||
| 51 | |||
| 52 | public function toArray(): array |
||
| 53 | { |
||
| 54 | return array_map(function ($value) { |
||
| 55 | return ($value instanceof Model || $value instanceof self) ? $value->toArray() : $value; |
||
| 56 | }, $this->items); |
||
| 57 | } |
||
| 58 | |||
| 59 | public function all(): array |
||
| 60 | { |
||
| 61 | return $this->items; |
||
| 62 | } |
||
| 63 | |||
| 64 | /** |
||
| 65 | * 合并数组 |
||
| 66 | * |
||
| 67 | * @access public |
||
| 68 | * @param mixed $items 数据 |
||
| 69 | * @return static |
||
| 70 | */ |
||
| 71 | public function merge($items) |
||
| 72 | { |
||
| 73 | return new static(array_merge($this->items, $this->convertToArray($items))); |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * 按指定键整理数据 |
||
| 78 | * |
||
| 79 | * @access public |
||
| 80 | * @param mixed $items 数据 |
||
| 81 | * @param string $indexKey 键名 |
||
| 82 | * @return array |
||
| 83 | */ |
||
| 84 | public function dictionary($items = null, string &$indexKey = null) |
||
| 85 | { |
||
| 86 | if ($items instanceof self || $items instanceof Paginator) { |
||
| 87 | $items = $items->all(); |
||
| 88 | } |
||
| 89 | |||
| 90 | $items = is_null($items) ? $this->items : $items; |
||
| 91 | |||
| 92 | if ($items && empty($indexKey)) { |
||
| 93 | $indexKey = is_array($items[0]) ? 'id' : $items[0]->getPk(); |
||
| 94 | } |
||
| 95 | |||
| 96 | if (isset($indexKey) && is_string($indexKey)) { |
||
| 97 | return array_column($items, null, $indexKey); |
||
| 98 | } |
||
| 99 | |||
| 100 | return $items; |
||
| 101 | } |
||
| 102 | |||
| 103 | /** |
||
| 104 | * 比较数组，返回差集 |
||
| 105 | * |
||
| 106 | * @access public |
||
| 107 | * @param mixed $items 数据 |
||
| 108 | * @param string $indexKey 指定比较的键名 |
||
| 109 | * @return static |
||
| 110 | */ |
||
| 111 | public function diff($items, string $indexKey = null) |
||
| 129 | } |
||
| 130 | |||
| 131 | /** |
||
| 132 | * 比较数组，返回交集 |
||
| 133 | * |
||
| 134 | * @access public |
||
| 135 | * @param mixed $items 数据 |
||
| 136 | * @param string $indexKey 指定比较的键名 |
||
| 137 | * @return static |
||
| 138 | */ |
||
| 139 | public function intersect($items, string $indexKey = null) |
||
| 140 | { |
||
| 141 | if ($this->isEmpty() || is_scalar($this->items[0])) { |
||
| 142 | return new static(array_diff($this->items, $this->convertToArray($items))); |
||
| 143 | } |
||
| 144 | |||
| 145 | $intersect = []; |
||
| 146 | $dictionary = $this->dictionary($items, $indexKey); |
||
| 147 | |||
| 148 | if (is_string($indexKey)) { |
||
| 149 | foreach ($this->items as $item) { |
||
| 150 | if (isset($dictionary[$item[$indexKey]])) { |
||
| 151 | $intersect[] = $item; |
||
| 152 | } |
||
| 153 | } |
||
| 154 | } |
||
| 155 | |||
| 156 | return new static($intersect); |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * 交换数组中的键和值 |
||
| 161 | * |
||
| 162 | * @access public |
||
| 163 | * @return static |
||
| 164 | */ |
||
| 165 | public function flip() |
||
| 166 | { |
||
| 167 | return new static(array_flip($this->items)); |
||
| 168 | } |
||
| 169 | |||
| 170 | /** |
||
| 171 | * 返回数组中所有的键名 |
||
| 172 | * |
||
| 173 | * @access public |
||
| 174 | * @return static |
||
| 175 | */ |
||
| 176 | public function keys() |
||
| 177 | { |
||
| 178 | return new static(array_keys($this->items)); |
||
| 179 | } |
||
| 180 | |||
| 181 | /** |
||
| 182 | * 返回数组中所有的值组成的新 Collection 实例 |
||
| 183 | * @access public |
||
| 184 | * @return static |
||
| 185 | */ |
||
| 186 | public function values() |
||
| 187 | { |
||
| 188 | return new static(array_values($this->items)); |
||
| 189 | } |
||
| 190 | |||
| 191 | /** |
||
| 192 | * 删除数组的最后一个元素（出栈） |
||
| 193 | * |
||
| 194 | * @access public |
||
| 195 | * @return mixed |
||
| 196 | */ |
||
| 197 | public function pop() |
||
| 198 | { |
||
| 199 | return array_pop($this->items); |
||
| 200 | } |
||
| 201 | |||
| 202 | /** |
||
| 203 | * 通过使用用户自定义函数，以字符串返回数组 |
||
| 204 | * |
||
| 205 | * @access public |
||
| 206 | * @param callable $callback 调用方法 |
||
| 207 | * @param mixed $initial |
||
| 208 | * @return mixed |
||
| 209 | */ |
||
| 210 | public function reduce(callable $callback, $initial = null) |
||
| 211 | { |
||
| 212 | return array_reduce($this->items, $callback, $initial); |
||
| 213 | } |
||
| 214 | |||
| 215 | /** |
||
| 216 | * 以相反的顺序返回数组。 |
||
| 217 | * |
||
| 218 | * @access public |
||
| 219 | * @return static |
||
| 220 | */ |
||
| 221 | public function reverse() |
||
| 222 | { |
||
| 223 | return new static(array_reverse($this->items)); |
||
| 224 | } |
||
| 225 | |||
| 226 | /** |
||
| 227 | * 删除数组中首个元素，并返回被删除元素的值 |
||
| 228 | * |
||
| 229 | * @access public |
||
| 230 | * @return mixed |
||
| 231 | */ |
||
| 232 | public function shift() |
||
| 233 | { |
||
| 234 | return array_shift($this->items); |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * 在数组结尾插入一个元素 |
||
| 239 | * @access public |
||
| 240 | * @param mixed $value 元素 |
||
| 241 | * @param string $key KEY |
||
| 242 | * @return void |
||
| 243 | */ |
||
| 244 | public function push($value, string $key = null): void |
||
| 250 | } |
||
| 251 | } |
||
| 252 | |||
| 253 | /** |
||
| 254 | * 把一个数组分割为新的数组块. |
||
| 255 | * |
||
| 256 | * @access public |
||
| 257 | * @param int $size 块大小 |
||
| 258 | * @param bool $preserveKeys |
||
| 259 | * @return static |
||
| 260 | */ |
||
| 261 | public function chunk(int $size, bool $preserveKeys = false) |
||
| 262 | { |
||
| 263 | $chunks = []; |
||
| 264 | |||
| 265 | foreach (array_chunk($this->items, $size, $preserveKeys) as $chunk) { |
||
| 266 | $chunks[] = new static($chunk); |
||
| 267 | } |
||
| 268 | |||
| 269 | return new static($chunks); |
||
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * 在数组开头插入一个元素 |
||
| 274 | * @access public |
||
| 275 | * @param mixed $value 元素 |
||
| 276 | * @param string $key KEY |
||
| 277 | * @return void |
||
| 278 | */ |
||
| 279 | public function unshift($value, string $key = null): void |
||
| 280 | { |
||
| 281 | if (is_null($key)) { |
||
| 282 | array_unshift($this->items, $value); |
||
| 283 | } else { |
||
| 284 | $this->items = [$key => $value] + $this->items; |
||
| 285 | } |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * 给每个元素执行个回调 |
||
| 290 | * |
||
| 291 | * @access public |
||
| 292 | * @param callable $callback 回调 |
||
| 293 | * @return $this |
||
| 294 | */ |
||
| 295 | public function each(callable $callback) |
||
| 296 | { |
||
| 297 | foreach ($this->items as $key => $item) { |
||
| 298 | $result = $callback($item, $key); |
||
| 299 | |||
| 300 | if (false === $result) { |
||
| 301 | break; |
||
| 302 | } elseif (!is_object($item)) { |
||
| 303 | $this->items[$key] = $result; |
||
| 304 | } |
||
| 305 | } |
||
| 306 | |||
| 307 | return $this; |
||
| 308 | } |
||
| 309 | |||
| 310 | /** |
||
| 311 | * 用回调函数处理数组中的元素 |
||
| 312 | * @access public |
||
| 313 | * @param callable|null $callback 回调 |
||
| 314 | * @return static |
||
| 315 | */ |
||
| 316 | public function map(callable $callback) |
||
| 317 | { |
||
| 318 | return new static(array_map($callback, $this->items)); |
||
| 319 | } |
||
| 320 | |||
| 321 | /** |
||
| 322 | * 用回调函数过滤数组中的元素 |
||
| 323 | * @access public |
||
| 324 | * @param callable|null $callback 回调 |
||
| 325 | * @return static |
||
| 326 | */ |
||
| 327 | public function filter(callable $callback = null) |
||
| 328 | { |
||
| 329 | if ($callback) { |
||
| 330 | return new static(array_filter($this->items, $callback)); |
||
| 331 | } |
||
| 332 | |||
| 333 | return new static(array_filter($this->items)); |
||
| 334 | } |
||
| 335 | |||
| 336 | /** |
||
| 337 | * 根据字段条件过滤数组中的元素 |
||
| 338 | * @access public |
||
| 339 | * @param string $field 字段名 |
||
| 340 | * @param mixed $operator 操作符 |
||
| 341 | * @param mixed $value 数据 |
||
| 342 | * @return static |
||
| 343 | */ |
||
| 344 | public function where(string $field, $operator, $value = null) |
||
| 345 | { |
||
| 346 | if (is_null($value)) { |
||
| 347 | $value = $operator; |
||
| 348 | $operator = '='; |
||
| 349 | } |
||
| 350 | |||
| 351 | return $this->filter(function ($data) use ($field, $operator, $value) { |
||
| 352 | if (strpos($field, '.')) { |
||
| 353 | list($field, $relation) = explode('.', $field); |
||
| 354 | |||
| 355 | $result = $data[$field][$relation] ?? null; |
||
| 356 | } else { |
||
| 357 | $result = $data[$field] ?? null; |
||
| 358 | } |
||
| 359 | |||
| 360 | switch ($operator) { |
||
| 361 | case '===': |
||
| 362 | return $result === $value; |
||
| 363 | case '!==': |
||
| 364 | return $result !== $value; |
||
| 365 | case '!=': |
||
| 366 | case '<>': |
||
| 367 | return $result != $value; |
||
| 368 | case '>': |
||
| 369 | return $result > $value; |
||
| 370 | case '>=': |
||
| 371 | return $result >= $value; |
||
| 372 | case '<': |
||
| 373 | return $result < $value; |
||
| 374 | case '<=': |
||
| 375 | return $result <= $value; |
||
| 376 | case 'like': |
||
| 377 | return is_string($result) && false !== strpos($result, $value); |
||
| 378 | case 'not like': |
||
| 379 | return is_string($result) && false === strpos($result, $value); |
||
| 380 | case 'in': |
||
| 381 | return is_scalar($result) && in_array($result, $value, true); |
||
| 382 | case 'not in': |
||
| 383 | return is_scalar($result) && !in_array($result, $value, true); |
||
| 384 | case 'between': |
||
| 385 | list($min, $max) = is_string($value) ? explode(',', $value) : $value; |
||
| 386 | return is_scalar($result) && $result >= $min && $result <= $max; |
||
| 387 | case 'not between': |
||
| 388 | list($min, $max) = is_string($value) ? explode(',', $value) : $value; |
||
| 389 | return is_scalar($result) && $result > $max || $result < $min; |
||
| 390 | case '==': |
||
| 391 | case '=': |
||
| 392 | default: |
||
| 393 | return $result == $value; |
||
| 394 | } |
||
| 395 | }); |
||
| 396 | } |
||
| 397 | |||
| 398 | /** |
||
| 399 | * LIKE过滤 |
||
| 400 | * @access public |
||
| 401 | * @param string $field 字段名 |
||
| 402 | * @param string $value 数据 |
||
| 403 | * @return static |
||
| 404 | */ |
||
| 405 | public function whereLike(string $field, string $value) |
||
| 406 | { |
||
| 407 | return $this->where($field, 'like', $value); |
||
| 408 | } |
||
| 409 | |||
| 410 | /** |
||
| 411 | * NOT LIKE过滤 |
||
| 412 | * @access public |
||
| 413 | * @param string $field 字段名 |
||
| 414 | * @param string $value 数据 |
||
| 415 | * @return static |
||
| 416 | */ |
||
| 417 | public function whereNotLike(string $field, string $value) |
||
| 418 | { |
||
| 419 | return $this->where($field, 'not like', $value); |
||
| 420 | } |
||
| 421 | |||
| 422 | /** |
||
| 423 | * IN过滤 |
||
| 424 | * @access public |
||
| 425 | * @param string $field 字段名 |
||
| 426 | * @param array $value 数据 |
||
| 427 | * @return static |
||
| 428 | */ |
||
| 429 | public function whereIn(string $field, array $value) |
||
| 430 | { |
||
| 431 | return $this->where($field, 'in', $value); |
||
| 432 | } |
||
| 433 | |||
| 434 | /** |
||
| 435 | * NOT IN过滤 |
||
| 436 | * @access public |
||
| 437 | * @param string $field 字段名 |
||
| 438 | * @param array $value 数据 |
||
| 439 | * @return static |
||
| 440 | */ |
||
| 441 | public function whereNotIn(string $field, array $value) |
||
| 442 | { |
||
| 443 | return $this->where($field, 'not in', $value); |
||
| 444 | } |
||
| 445 | |||
| 446 | /** |
||
| 447 | * BETWEEN 过滤 |
||
| 448 | * @access public |
||
| 449 | * @param string $field 字段名 |
||
| 450 | * @param mixed $value 数据 |
||
| 451 | * @return static |
||
| 452 | */ |
||
| 453 | public function whereBetween(string $field, $value) |
||
| 454 | { |
||
| 455 | return $this->where($field, 'between', $value); |
||
| 456 | } |
||
| 457 | |||
| 458 | /** |
||
| 459 | * NOT BETWEEN 过滤 |
||
| 460 | * @access public |
||
| 461 | * @param string $field 字段名 |
||
| 462 | * @param mixed $value 数据 |
||
| 463 | * @return static |
||
| 464 | */ |
||
| 465 | public function whereNotBetween(string $field, $value) |
||
| 466 | { |
||
| 467 | return $this->where($field, 'not between', $value); |
||
| 468 | } |
||
| 469 | |||
| 470 | /** |
||
| 471 | * 返回数据中指定的一列 |
||
| 472 | * @access public |
||
| 473 | * @param string $columnKey 键名 |
||
| 474 | * @param string $indexKey 作为索引值的列 |
||
| 475 | * @return array |
||
| 476 | */ |
||
| 477 | public function column(string $columnKey, string $indexKey = null) |
||
| 478 | { |
||
| 479 | return array_column($this->items, $columnKey, $indexKey); |
||
| 480 | } |
||
| 481 | |||
| 482 | /** |
||
| 483 | * 对数组排序 |
||
| 484 | * |
||
| 485 | * @access public |
||
| 486 | * @param callable|null $callback 回调 |
||
| 487 | * @return static |
||
| 488 | */ |
||
| 489 | public function sort(callable $callback = null) |
||
| 490 | { |
||
| 491 | $items = $this->items; |
||
| 492 | |||
| 493 | $callback = $callback ?: function ($a, $b) { |
||
| 494 | return $a == $b ? 0 : (($a < $b) ? -1 : 1); |
||
| 495 | |||
| 496 | }; |
||
| 497 | |||
| 498 | uasort($items, $callback); |
||
| 499 | |||
| 500 | return new static($items); |
||
| 501 | } |
||
| 502 | |||
| 503 | /** |
||
| 504 | * 指定字段排序 |
||
| 505 | * @access public |
||
| 506 | * @param string $field 排序字段 |
||
| 507 | * @param string $order 排序 |
||
| 508 | * @return $this |
||
| 509 | */ |
||
| 510 | public function order(string $field, string $order = null) |
||
| 511 | { |
||
| 512 | return $this->sort(function ($a, $b) use ($field, $order) { |
||
| 513 | $fieldA = $a[$field] ?? null; |
||
| 514 | $fieldB = $b[$field] ?? null; |
||
| 515 | |||
| 516 | return 'desc' == strtolower($order) ? strcmp($fieldB, $fieldA) : strcmp($fieldA, $fieldB); |
||
| 517 | }); |
||
| 518 | } |
||
| 519 | |||
| 520 | /** |
||
| 521 | * 将数组打乱 |
||
| 522 | * |
||
| 523 | * @access public |
||
| 524 | * @return static |
||
| 525 | */ |
||
| 526 | public function shuffle() |
||
| 533 | } |
||
| 534 | |||
| 535 | /** |
||
| 536 | * 获取最后一个单元数据 |
||
| 537 | * |
||
| 538 | * @access public |
||
| 539 | * @return mixed |
||
| 540 | */ |
||
| 541 | public function first() |
||
| 542 | { |
||
| 543 | return reset($this->items); |
||
| 544 | } |
||
| 545 | |||
| 546 | /** |
||
| 547 | * 获取第一个单元数据 |
||
| 548 | * |
||
| 549 | * @access public |
||
| 550 | * @return mixed |
||
| 551 | */ |
||
| 552 | public function last() |
||
| 553 | { |
||
| 554 | return end($this->items); |
||
| 555 | } |
||
| 556 | |||
| 557 | /** |
||
| 558 | * 截取数组 |
||
| 559 | * |
||
| 560 | * @access public |
||
| 561 | * @param int $offset 起始位置 |
||
| 562 | * @param int $length 截取长度 |
||
| 563 | * @param bool $preserveKeys preserveKeys |
||
| 564 | * @return static |
||
| 565 | */ |
||
| 566 | public function slice(int $offset, int $length = null, bool $preserveKeys = false) |
||
| 567 | { |
||
| 568 | return new static(array_slice($this->items, $offset, $length, $preserveKeys)); |
||
| 569 | } |
||
| 570 | |||
| 571 | // ArrayAccess |
||
| 572 | public function offsetExists($offset) |
||
| 573 | { |
||
| 574 | return array_key_exists($offset, $this->items); |
||
| 575 | } |
||
| 576 | |||
| 577 | public function offsetGet($offset) |
||
| 578 | { |
||
| 579 | return $this->items[$offset]; |
||
| 580 | } |
||
| 581 | |||
| 582 | public function offsetSet($offset, $value) |
||
| 588 | } |
||
| 589 | } |
||
| 590 | |||
| 591 | public function offsetUnset($offset) |
||
| 592 | { |
||
| 593 | unset($this->items[$offset]); |
||
| 594 | } |
||
| 595 | |||
| 596 | //Countable |
||
| 597 | public function count() |
||
| 598 | { |
||
| 599 | return count($this->items); |
||
| 600 | } |
||
| 601 | |||
| 602 | //IteratorAggregate |
||
| 603 | public function getIterator() |
||
| 604 | { |
||
| 605 | return new ArrayIterator($this->items); |
||
| 606 | } |
||
| 607 | |||
| 608 | //JsonSerializable |
||
| 609 | public function jsonSerialize() |
||
| 610 | { |
||
| 611 | return $this->toArray(); |
||
| 612 | } |
||
| 613 | |||
| 614 | /** |
||
| 615 | * 转换当前数据集为JSON字符串 |
||
| 616 | * @access public |
||
| 617 | * @param integer $options json参数 |
||
| 618 | * @return string |
||
| 619 | */ |
||
| 620 | public function toJson(int $options = JSON_UNESCAPED_UNICODE) |
||
| 621 | { |
||
| 622 | return json_encode($this->toArray(), $options); |
||
| 623 | } |
||
| 624 | |||
| 625 | public function __toString() |
||
| 628 | } |
||
| 629 | |||
| 630 | /** |
||
| 631 | * 转换成数组 |
||
| 632 | * |
||
| 633 | * @access public |
||
| 634 | * @param mixed $items 数据 |
||
| 635 | * @return array |
||
| 636 | */ |
||
| 637 | protected function convertToArray($items): array |
||
| 644 | } |
||
| 645 | } |
||
| 646 |
Loading history...
