HashMap.php
No OneTemporary
Actions

Size

5 KB

Referenced Files

None

Subscribers

None

HashMap.php
View Options

	<?php
	declare(strict_types=1);

	namespace Keruald\OmniTools\Collections;

	use Keruald\OmniTools\Reflection\CallableElement;

	use ArrayIterator;
	use InvalidArgumentException;
	use Traversable;

	/**
	* An associative array allowing the use of chained
	*
	*
	* This class can be used as a service container,
	* an application context, to store configuration.
	*/
	class HashMap extends BaseMap {

	///
	/// Properties
	///

	private array $map;

	///
	/// Constructor
	///

	public function __construct (iterable $iterable = []) {
	if (is_array($iterable)) {
	$this->map = (array)$iterable;
	return;
	}

	foreach ($iterable as $key => $value) {
	$this->map[$key] = $value;
	}
	}

	///
	/// Convert to HashMap
	///

	private static function convertToArray ($data) {
	if (is_iterable($data) \|\| is_object($data)) {
	$result = [];
	foreach ($data as $key => $value) {
	$result[$key] = self::convertToArray($value);
	}
	return $result;
	}

	return $data;
	}

	/**
	* Converts deeply an element to a map.
	*
	* If $from is an object or iterable, each element will be:
	* - converted to an array (deep array) if iterable or object
	* - kept as is if it's a scalar
	*/
	public static function from (iterable\|object\|null $from) : static {
	if ($from === null) {
	return new self;
	}

	$items = self::convertToArray($from);
	return new self($items);
	}

	///
	/// Interact with map content at key level
	///

	public function get (mixed $key) : mixed {
	if (!array_key_exists($key, $this->map)) {
	throw new InvalidArgumentException("Key not found.");
	}

	return $this->map[$key];
	}

	public function getOr (mixed $key, mixed $defaultValue) : mixed {
	return $this->map[$key] ?? $defaultValue;
	}

	public function set (mixed $key, mixed $value) : static {
	if ($key === null) {
	throw new InvalidArgumentException("Key can't be null");
	}

	$this->map[$key] = $value;

	return $this;
	}

	public function unset (mixed $key) : static {
	unset($this->map[$key]);

	return $this;
	}

	public function has (mixed $key) : bool {
	return array_key_exists($key, $this->map);
	}

	public function contains (mixed $value) : bool {
	return in_array($value, $this->map);
	}

	///
	/// Interact with collection content at collection level
	///

	public function count () : int {
	return count($this->map);
	}

	public function isEmpty () : bool {
	return $this->count() === 0;
	}

	public function clear () : self {
	$this->map = [];

	return $this;
	}

	/**
	* Merge the specified map with the current map.
	*
	* If a key already exists, the value already set is kept.
	*
	* @see update() when you need to update with the new value.
	*/
	public function merge (iterable $iterable) : self {
	foreach ($iterable as $key => $value) {
	$this->map[$key] ??= $value;
	}

	return $this;
	}

	/**
	* Merge the specified map with the current bag.
	*
	* If a key already exists, the value is updated with the new one.
	*
	* @see merge() when you need to keep old value.
	*/
	public function update (iterable $iterable) : self {
	foreach ($iterable as $key => $value) {
	$this->map[$key] = $value;
	}

	return $this;
	}

	/**
	* Gets a copy of the internal map.
	*
	* Scalar values (int, strings) are cloned.
	* Objects are references to a specific objet, not a clone.
	*
	* @return array<string, mixed>
	*/
	public function toArray () : array {
	return $this->map;
	}

	///
	/// HOF
	///

	public function map (callable $callable) : self {
	return new self(array_map($callable, $this->map));
	}

	public function filter (callable $callable) : self {
	$argc = (new CallableElement($callable))->countArguments();
	if ($argc === 0) {
	throw new InvalidArgumentException(self::CB_ZERO_ARG);
	}

	$mode = (int)($argc > 1);
	return new self(
	array_filter($this->map, $callable, $mode)
	);
	}

	public function mapKeys (callable $callable) : self {
	$mappedMap = [];
	foreach ($this->map as $key => $value) {
	$mappedMap[$callable($key)] = $value;
	}

	return new self($mappedMap);
	}

	public function mapValuesAndKeys (callable $callable) : self {
	$argc = (new CallableElement($callable))->countArguments();

	$newMap = [];
	foreach ($this->map as $key => $value) {
	[$newKey, $newValue] = match($argc) {
	0 => throw new InvalidArgumentException(self::CB_ZERO_ARG),
	1 => $callable($value),
	default => $callable($key, $value),
	};
	$newMap[$newKey] = $newValue;
	}

	return new self($newMap);
	}

	public function flatMap (callable $callable) : self {
	$argc = (new CallableElement($callable))->countArguments();

	$newMap = new self;
	foreach ($this->map as $key => $value) {
	$toAdd = match($argc) {
	0 => throw new InvalidArgumentException(self::CB_ZERO_ARG),
	1 => $callable($value),
	default => $callable($key, $value),
	};
	$newMap->update($toAdd);
	}

	return $newMap;
	}

	public function filterKeys (callable $callable) : self {
	return new self(
	array_filter($this->map, $callable, ARRAY_FILTER_USE_KEY)
	);
	}

	///
	/// IteratorAggregate
	///

	public function getIterator () : Traversable {
	return new ArrayIterator($this->map);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Tue, May 13, 16:56 (1 d, 3 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 2641763
Default Alt Text: HashMap.php (5 KB)

HashMap.phpNo OneTemporaryActions

HashMap.phpView Options

File Metadata

Event Timeline

HashMap.php
No OneTemporary
Actions

HashMap.php
View Options