*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace App\Libs\TikTok\Kernel\Support;
use ArrayAccess;
use ArrayIterator;
use Countable;
use App\Libs\TikTok\Kernel\Contracts\Arrayable;
use IteratorAggregate;
use JsonSerializable;
use Serializable;
/**
* Class Collection.
*/
class Collection implements ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Serializable, Arrayable {
/**
* The collection data.
*
* @var array
*/
protected $items = [];
/**
* set data.
*
* @param array $items
*/
public function __construct(array $items = []) {
foreach ($items as $key => $value) {
$this->set($key, $value);
}
}
/**
* Return all items.
*
* @return array
*/
public function all(): array {
return $this->items;
}
/**
* Return specific items.
*
* @param array $keys
*
* @return Collection
*/
public function only(array $keys): Collection {
$return = [];
foreach ($keys as $key) {
$value = $this->get($key);
if (!is_null($value)) {
$return[$key] = $value;
}
}
return new static($return);
}
/**
* Get all items except for those with the specified keys.
*
* @param mixed $keys
*
* @return static
*/
public function except($keys): Collection {
$keys = is_array($keys) ? $keys : func_get_args();
return new static(Arr::except($this->items, $keys));
}
/**
* Merge data.
*
* @param Collection|array $items
*
* @return Collection
*/
public function merge($items): Collection {
$clone = new static($this->all());
foreach ($items as $key => $value) {
$clone->set($key, $value);
}
return $clone;
}
/**
* To determine Whether the specified element exists.
*
* @param string $key
*
* @return bool
*/
public function has(string $key): bool {
return !is_null(Arr::get($this->items, $key));
}
/**
* Retrieve the first item.
*
* @return mixed
*/
public function first() {
return reset($this->items);
}
/**
* Retrieve the last item.
*
* @return bool
*/
public function last(): bool {
$end = end($this->items);
reset($this->items);
return $end;
}
/**
* add the item value.
*
* @param string $key
* @param mixed $value
*/
public function add(string $key, $value): void {
Arr::set($this->items, $key, $value);
}
/**
* Set the item value.
*
* @param string $key
* @param mixed $value
*/
public function set(string $key, $value): void {
Arr::set($this->items, $key, $value);
}
/**
* Retrieve item from Collection.
*
* @param string $key
* @param mixed $default
*
* @return mixed
*/
public function get(string $key, $default = null) {
return Arr::get($this->items, $key, $default);
}
/**
* Remove item form Collection.
*
* @param string $key
*/
public function forget(string $key): void {
Arr::forget($this->items, $key);
}
/**
* Build to array.
*
* @return array
*/
public function toArray(): array {
return $this->all();
}
/**
* Build to json.
* @return string
* @author zhaoxiang
* Specify data which should be serialized to JSON.
*
* @see http://php.net/manual/en/jsonserializable.jsonserialize.php
*
* @return mixed data which can be serialized by json_encode,
* which is a value of any type other than a resource
*/
public function jsonSerialize() {
return $this->items;
}
/**
* (PHP 5 >= 5.1.0)
* String representation of object.
*
* @see http://php.net/manual/en/serializable.serialize.php
*
* @return string the string representation of the object or null
*/
public function serialize(): string {
return serialize($this->items);
}
/**
* (PHP 5 >= 5.0.0)
* Retrieve an external iterator.
*
* @see http://php.net/manual/en/iteratoraggregate.getiterator.php
*
* @return \ArrayIterator An instance of an object implementing Iterator or
* Traversable
*/
public function getIterator(): ArrayIterator {
return new ArrayIterator($this->items);
}
/**
* (PHP 5 >= 5.1.0)
* Count elements of an object.
*
* @see http://php.net/manual/en/countable.count.php
*
* @return int the custom count as an integer.
*
* The return value is cast to an integer
*/
public function count(): int {
return count($this->items);
}
/**
* (PHP 5 >= 5.1.0)
* Constructs the object.
*
* @see http://php.net/manual/en/serializable.unserialize.php
*
* @param string $serialized
* The string representation of the object. *
* * @return mixed|void */ public function unserialize($serialized) { return $this->items = unserialize($serialized); } /** * Get a data by key. * * @param string $key * * @return mixed */ public function __get(string $key) { return $this->get($key); } /** * Assigns a value to the specified data. * * @param string $key * @param mixed $value */ public function __set(string $key, $value) { $this->set($key, $value); } /** * Whether or not an data exists by key. * * @param string $key * * @return bool */ public function __isset(string $key) { return $this->has($key); } /** * Unset an data by key. * * @param string $key */ public function __unset(string $key) { $this->forget($key); } /** * var_export. * * @param array $properties */ public static function __set_state(array $properties) { return (new static($properties))->all(); } /** * (PHP 5 >= 5.0.0)* An offset to check for. *
* * @return bool true on success or false on failure. * The return value will be casted to boolean if non-boolean was returned */ public function offsetExists($offset): bool { return $this->has($offset); } /** * (PHP 5 >= 5.0.0)* The offset to unset. *
*/ public function offsetUnset($offset): void { if ($this->offsetExists($offset)) { $this->forget($offset); } } /** * (PHP 5 >= 5.0.0)* The offset to retrieve. *
* * @return mixed Can return all value types */ public function offsetGet($offset) { return $this->offsetExists($offset) ? $this->get($offset) : null; } /** * (PHP 5 >= 5.0.0)* The offset to assign the value to. *
* @param mixed $value* The value to set. *
*/ public function offsetSet($offset, $value): void { $this->set($offset, $value); } }