Functions.php 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * This file is part of Hyperf.
  5. *
  6. * @link https://www.hyperf.io
  7. * @document https://hyperf.wiki
  8. * @contact group@hyperf.io
  9. * @license https://github.com/hyperf/hyperf/blob/master/LICENSE
  10. */
  11. namespace Hyperf\Collection;
  12. use Closure;
  13. use Hyperf\Contract\Arrayable;
  14. /**
  15. * Create a collection from the given value.
  16. *
  17. * @template TKey of array-key
  18. * @template TValue
  19. *
  20. * @param null|Arrayable<TKey, TValue>|iterable<TKey, TValue> $value
  21. * @return Collection<TKey, TValue>
  22. */
  23. function collect($value = []): Collection
  24. {
  25. return new Collection($value);
  26. }
  27. /**
  28. * Fill in data where it's missing.
  29. *
  30. * @param mixed $target
  31. * @param array|string $key
  32. * @param mixed $value
  33. * @return mixed
  34. */
  35. function data_fill(&$target, $key, $value)
  36. {
  37. return data_set($target, $key, $value, false);
  38. }
  39. /**
  40. * Get an item from an array or object using "dot" notation.
  41. *
  42. * @param null|array|int|string $key
  43. */
  44. function data_get(mixed $target, mixed $key, mixed $default = null): mixed
  45. {
  46. if (is_null($key)) {
  47. return $target;
  48. }
  49. $key = is_array($key) ? $key : explode('.', (string) $key);
  50. foreach ($key as $i => $segment) {
  51. unset($key[$i]);
  52. if (is_null($segment)) {
  53. return $target;
  54. }
  55. if ($segment === '*') {
  56. if ($target instanceof Collection) {
  57. $target = $target->all();
  58. } elseif (! is_iterable($target)) {
  59. return value($default);
  60. }
  61. $result = [];
  62. foreach ($target as $item) {
  63. $result[] = data_get($item, $key);
  64. }
  65. return in_array('*', $key) ? Arr::collapse($result) : $result;
  66. }
  67. if (Arr::accessible($target) && Arr::exists($target, $segment)) {
  68. $target = $target[$segment];
  69. } elseif (is_object($target) && isset($target->{$segment})) {
  70. $target = $target->{$segment};
  71. } else {
  72. return value($default);
  73. }
  74. }
  75. return $target;
  76. }
  77. /**
  78. * Set an item on an array or object using dot notation.
  79. *
  80. * @param mixed $target
  81. * @param array|string $key
  82. * @param mixed $value
  83. * @param bool $overwrite
  84. * @return mixed
  85. */
  86. function data_set(&$target, $key, $value, $overwrite = true)
  87. {
  88. $segments = is_array($key) ? $key : explode('.', $key);
  89. if (($segment = array_shift($segments)) === '*') {
  90. if (! Arr::accessible($target)) {
  91. $target = [];
  92. }
  93. if ($segments) {
  94. foreach ($target as &$inner) {
  95. data_set($inner, $segments, $value, $overwrite);
  96. }
  97. } elseif ($overwrite) {
  98. foreach ($target as &$inner) {
  99. $inner = $value;
  100. }
  101. }
  102. } elseif (Arr::accessible($target)) {
  103. if ($segments) {
  104. if (! Arr::exists($target, $segment)) {
  105. $target[$segment] = [];
  106. }
  107. data_set($target[$segment], $segments, $value, $overwrite);
  108. } elseif ($overwrite || ! Arr::exists($target, $segment)) {
  109. $target[$segment] = $value;
  110. }
  111. } elseif (is_object($target)) {
  112. if ($segments) {
  113. if (! isset($target->{$segment})) {
  114. $target->{$segment} = [];
  115. }
  116. data_set($target->{$segment}, $segments, $value, $overwrite);
  117. } elseif ($overwrite || ! isset($target->{$segment})) {
  118. $target->{$segment} = $value;
  119. }
  120. } else {
  121. $target = [];
  122. if ($segments) {
  123. /* @phpstan-ignore-next-line */
  124. data_set($target[$segment], $segments, $value, $overwrite);
  125. } elseif ($overwrite) {
  126. $target[$segment] = $value;
  127. }
  128. }
  129. return $target;
  130. }
  131. if (! function_exists('data_forget')) {
  132. /**
  133. * Remove / unset an item from an array or object using "dot" notation.
  134. *
  135. * @param mixed $target
  136. * @param null|array|int|string $key
  137. * @return mixed
  138. */
  139. function data_forget(&$target, $key)
  140. {
  141. $segments = is_array($key) ? $key : explode('.', $key);
  142. if (($segment = array_shift($segments)) === '*' && Arr::accessible($target)) {
  143. if ($segments) {
  144. foreach ($target as &$inner) {
  145. data_forget($inner, $segments);
  146. }
  147. }
  148. } elseif (Arr::accessible($target)) {
  149. if ($segments && Arr::exists($target, $segment)) {
  150. data_forget($target[$segment], $segments);
  151. } else {
  152. Arr::forget($target, $segment);
  153. }
  154. } elseif (is_object($target)) {
  155. if ($segments && isset($target->{$segment})) {
  156. data_forget($target->{$segment}, $segments);
  157. } elseif (isset($target->{$segment})) {
  158. unset($target->{$segment});
  159. }
  160. }
  161. return $target;
  162. }
  163. }
  164. /**
  165. * Get the first element of an array. Useful for method chaining.
  166. *
  167. * @param array $array
  168. * @return mixed
  169. */
  170. function head($array)
  171. {
  172. return reset($array);
  173. }
  174. /**
  175. * Get the last element from an array.
  176. *
  177. * @param array $array
  178. * @return mixed
  179. */
  180. function last($array)
  181. {
  182. return end($array);
  183. }
  184. /**
  185. * Return the default value of the given value.
  186. * @template TValue
  187. * @template TReturn
  188. *
  189. * @param (Closure():TReturn)|TValue $value
  190. * @param mixed ...$args
  191. * @return ($value is Closure ? TReturn : TValue)
  192. */
  193. function value(mixed $value, ...$args)
  194. {
  195. return $value instanceof Closure ? $value(...$args) : $value;
  196. }