Skip to content

Commit

Permalink
Implemented with() method similar to Javascript
Browse files Browse the repository at this point in the history
  • Loading branch information
aimeos committed Jun 3, 2023
1 parent 41f9f11 commit f56623c
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 1 deletion.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ will return:
<a href="#values">values</a>
<a href="#walk">walk</a>
<a href="#where">where</a>
<a href="#with">with</a>
<a href="#zip">zip</a>

</nav>
Expand Down Expand Up @@ -328,6 +329,7 @@ will return:
* [set()](#set) : Overwrites or adds an element
* [union()](#union) : Adds the elements without overwriting existing ones
* [unshift()](#unshift) : Adds an element at the beginning
* [with()](#with) : Returns a copy and sets an element

### Aggregate

Expand Down Expand Up @@ -5814,6 +5816,37 @@ Map::from( [
```


### with()

Returns a copy of the map with the element at the given index replaced with the given value.

```php
public function with( $key, $value ) : self
```

* @param **int|string** `$key` Array key to set or replace
* @param **mixed** `$value` New value for the given key
* @return **self&#60;int&#124;string,mixed&#62;** New map of the values

The original map stays untouched! This method is a shortcut for calling the
[copy()](#copy) and [set()](#set) methods.

**Examples:**

```php
$m = Map::from( ['a' => 1] );

$m->with( 2, 'b' );
// ['a' => 1, 2 => 'b']

$m->with( 'a', 2 );
// ['a' => 2]

$m->all();
// ['a' => 1]
```


### zip()

Merges the values of all arrays at the corresponding index.
Expand Down
27 changes: 26 additions & 1 deletion src/Map.php
Original file line number Diff line number Diff line change
Expand Up @@ -5359,13 +5359,38 @@ public function where( string $key, string $op, $value ) : self
}


/**
* Returns a copy of the map with the element at the given index replaced with the given value.
*
* Examples:
* $m = Map::from( ['a' => 1] );
* $m->with( 2, 'b' );
* $m->with( 'a', 2 );
*
* Results:
* ['a' => 1, 2 => 'b']
* ['a' => 2]
*
* The original map ($m) stays untouched!
* This method is a shortcut for calling the copy() and set() methods.
*
* @param int|string $key Array key to set or replace
* @param mixed $value New value for the given key
* @return self<int|string,mixed> New map
*/
public function with( $key, $value ) : self
{
return $this->copy()->set( $key, $value );
}


/**
* Merges the values of all arrays at the corresponding index.
*
* Examples:
* $en = ['one', 'two', 'three'];
* $es = ['uno', 'dos', 'tres'];
* $m = new Map( [1, 2, 3] )->zip( $en, $es );
* $m = Map::from( [1, 2, 3] )->zip( $en, $es );
*
* Results:
* [
Expand Down
11 changes: 11 additions & 0 deletions tests/MapTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -3527,6 +3527,17 @@ public function testWherePath()
}


public function testWith()
{
$m = Map::from( ['a' => 1] );

$this->assertEquals( ['a' => 1, 2 => 'b'], $m->with( 2, 'b' )->toArray() );
$this->assertEquals( ['a' => 1], $m->toArray() );
$this->assertEquals( ['a' => 2], $m->with( 'a', 2 )->toArray() );
$this->assertEquals( ['a' => 1], $m->toArray() );
}


public function testZip()
{
$m = new Map( [1, 2, 3] );
Expand Down

0 comments on commit f56623c

Please sign in to comment.