Skip to content

Commit 006a18e

Browse files
nyamsprodnyamsprod
committed
Improve Interfaces names
1 parent 2be17ff commit 006a18e

File tree

8 files changed

+33
-34
lines changed

8 files changed

+33
-34
lines changed

‎CHANGELOG.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,13 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
66

77
### Added
88

9-
- The `Container` interface.
10-
- The `ParameterAccess` interface.
9+
- The `Container`, `MemberList`, `MemberOrderedMap`, `ParameterAccess` interfaces.
10+
- `OrderedList` and `InnerList` implement the `MemberList` interface.
11+
- `Parameters` and `Dictionnary` implement the `MemberOrderedMap` interface.
1112
- The `InvalidArgument` exception.
12-
- `OrderedList`, `InnerList` now implements the `MemberList` interface.
13-
- `Parameters` and `Dictionnary` now implements the PHP `OrderedMap` interface.
1413
- `Token::value` is a readonly property.
1514
- `Item::value` method returns the decoded value of an Item (returns value can be `float|int|string|bool`).
16-
- `Item::fromToken`, `Item::fromDecodedByteSequence` , `Item::fromEncodedByteSequence` to ease specific string initiation
15+
- `Item::fromToken`, `Item::fromDecodedByteSequence` , `Item::fromEncodedByteSequence` to ease `Item` creation.
1716

1817
### Fixed
1918

‎src/Dictionary.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515

1616
/**
1717
* @phpstan-type DataType ByteSequence|Token|bool|int|float|string
18-
* @implements OrderedMap<string, Item|InnerList<int, Item>>
18+
* @implements MemberOrderedMap<string, Item|InnerList<int, Item>>
1919
*/
20-
final class Dictionary implements OrderedMap
20+
final class Dictionary implements MemberOrderedMap
2121
{
2222
/** @var array<string, Item|InnerList<int, Item>> */
2323
private array $members = [];
@@ -52,11 +52,11 @@ public static function fromAssociative(iterable $members = []): self
5252
* the first member represents the instance entry key
5353
* the second member represents the instance entry value
5454
*
55-
* @param OrderedMap<string, Item|InnerList<int, Item>>|iterable<array{0:string, 1:InnerList<int, Item>|Item|DataType}> $pairs
55+
* @param MemberOrderedMap<string, Item|InnerList<int, Item>>|iterable<array{0:string, 1:InnerList<int, Item>|Item|DataType}> $pairs
5656
*/
57-
public static function fromPairs(OrderedMap|iterable $pairs = []): self
57+
public static function fromPairs(MemberOrderedMap|iterable $pairs = []): self
5858
{
59-
if ($pairs instanceof OrderedMap) {
59+
if ($pairs instanceof MemberOrderedMap) {
6060
$pairs = $pairs->toPairs();
6161
}
6262

@@ -347,9 +347,9 @@ public function mergeAssociative(iterable ...$others): self
347347
/**
348348
* Merges multiple instances using iterable pairs.
349349
*
350-
* @param OrderedMap<string, Item|InnerList<int, Item>>|iterable<array{0:string, 1:InnerList<int, Item>|Item|DataType}> ...$others
350+
* @param MemberOrderedMap<string, Item|InnerList<int, Item>>|iterable<array{0:string, 1:InnerList<int, Item>|Item|DataType}> ...$others
351351
*/
352-
public function mergePairs(OrderedMap|iterable ...$others): self
352+
public function mergePairs(MemberOrderedMap|iterable ...$others): self
353353
{
354354
foreach ($others as $other) {
355355
$this->members = [...$this->members, ...self::fromPairs($other)->members];

‎src/Item.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ private function __construct(
3434
/**
3535
* @param array{
3636
* 0:DataType,
37-
* 1?:OrderedMap<string, Item>|iterable<array{0:string, 1:Item|DataType}>
37+
* 1?:MemberOrderedMap<string, Item>|iterable<array{0:string, 1:Item|DataType}>
3838
* } $pair
3939
*/
4040
public static function fromPair(array $pair): self

‎src/Container.php renamed to ‎src/MemberContainer.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* @template-extends IteratorAggregate<TKey, TValue>
1616
* @template-extends ArrayAccess<TKey, TValue>
1717
*/
18-
interface Container extends Countable, ArrayAccess, IteratorAggregate, StructuredField
18+
interface MemberContainer extends Countable, ArrayAccess, IteratorAggregate, StructuredField
1919
{
2020
/**
2121
* Tells whether the instance contains members.

‎src/MemberList.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
/**
88
* @template TKey
99
* @template TValue of StructuredField
10-
* @template-extends Container<TKey, TValue>
10+
* @template-extends MemberContainer<TKey, TValue>
1111
*/
12-
interface MemberList extends Container
12+
interface MemberList extends MemberContainer
1313
{
1414
/**
1515
* Insert members at the beginning of the list.

‎src/OrderedMap.php renamed to ‎src/MemberOrderedMap.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
/**
1010
* @template TKey
1111
* @template TValue of StructuredField
12-
* @template-extends Container<TKey, TValue>
12+
* @template-extends MemberContainer<TKey, TValue>
1313
*/
14-
interface OrderedMap extends Container
14+
interface MemberOrderedMap extends MemberContainer
1515
{
1616
/**
1717
* Returns an iterable construct of dictionary pairs.
@@ -49,14 +49,14 @@ public function keys(): array;
4949
*
5050
* @throws SyntaxError If the string key is not a valid
5151
*
52-
* @return OrderedMap<TKey, TValue>
52+
* @return MemberOrderedMap<TKey, TValue>
5353
*/
5454
public function set(string $key, StructuredField $member): self;
5555

5656
/**
5757
* Deletes members associated with the list of submitted keys.
5858
*
59-
* @return OrderedMap<TKey, TValue>
59+
* @return MemberOrderedMap<TKey, TValue>
6060
*/
6161
public function delete(string ...$keys): self;
6262

@@ -67,7 +67,7 @@ public function delete(string ...$keys): self;
6767
*
6868
* @throws SyntaxError If the string key is not a valid
6969
*
70-
* @return OrderedMap<TKey, TValue>
70+
* @return MemberOrderedMap<TKey, TValue>
7171
*/
7272
public function append(string $key, StructuredField $member): self;
7373

@@ -78,7 +78,7 @@ public function append(string $key, StructuredField $member): self;
7878
*
7979
* @throws SyntaxError If the string key is not a valid
8080
*
81-
* @return OrderedMap<TKey, TValue>
81+
* @return MemberOrderedMap<TKey, TValue>
8282
*/
8383
public function prepend(string $key, StructuredField $member): self;
8484

@@ -87,16 +87,16 @@ public function prepend(string $key, StructuredField $member): self;
8787
*
8888
* @param iterable<TKey, TValue> ...$others
8989
*
90-
* @return OrderedMap<TKey, TValue>
90+
* @return MemberOrderedMap<TKey, TValue>
9191
*/
9292
public function mergeAssociative(iterable ...$others): self;
9393

9494
/**
9595
* Merges multiple instances using iterable pairs.
9696
*
97-
* @param OrderedMap<TKey, TValue>|iterable<array{0:TKey, 1:TValue}> ...$others
97+
* @param MemberOrderedMap<TKey, TValue>|iterable<array{0:TKey, 1:TValue}> ...$others
9898
*
99-
* @return OrderedMap<TKey, TValue>
99+
* @return MemberOrderedMap<TKey, TValue>
100100
*/
101-
public function mergePairs(OrderedMap|iterable ...$others): self;
101+
public function mergePairs(MemberOrderedMap|iterable ...$others): self;
102102
}

‎src/ParameterAccess.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace Bakame\Http\StructuredFields;
66

77
/**
8-
* @property-read OrderedMap<string, Item> $parameters
8+
* @property-read MemberOrderedMap<string, Item> $parameters
99
*/
1010
interface ParameterAccess
1111
{

‎src/Parameters.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818

1919
/**
2020
* @phpstan-type DataType ByteSequence|Token|bool|int|float|string
21-
* @implements OrderedMap<string, Item>
21+
* @implements MemberOrderedMap<string, Item>
2222
*/
23-
final class Parameters implements OrderedMap
23+
final class Parameters implements MemberOrderedMap
2424
{
2525
/** @var array<string, Item> */
2626
private array $members = [];
@@ -85,13 +85,13 @@ public static function fromAssociative(iterable $members = []): self
8585
* the first member represents the instance entry key
8686
* the second member represents the instance entry value
8787
*
88-
* @param OrderedMap<string, Item>|iterable<array{0:string, 1:Item|ByteSequence|Token|bool|int|float|string}> $pairs
88+
* @param MemberOrderedMap<string, Item>|iterable<array{0:string, 1:Item|ByteSequence|Token|bool|int|float|string}> $pairs
8989
*
9090
* @throws ForbiddenStateError If the bare item contains parameters
9191
*/
92-
public static function fromPairs(OrderedMap|iterable $pairs = []): self
92+
public static function fromPairs(MemberOrderedMap|iterable $pairs = []): self
9393
{
94-
if ($pairs instanceof OrderedMap) {
94+
if ($pairs instanceof MemberOrderedMap) {
9595
$pairs = $pairs->toPairs();
9696
}
9797

@@ -377,9 +377,9 @@ public function mergeAssociative(iterable ...$others): self
377377
/**
378378
* Merge multiple instances using iterable pairs.
379379
*
380-
* @param OrderedMap<string, Item>|iterable<array{0:string, 1:Item|DataType}> ...$others
380+
* @param MemberOrderedMap<string, Item>|iterable<array{0:string, 1:Item|DataType}> ...$others
381381
*/
382-
public function mergePairs(OrderedMap|iterable ...$others): self
382+
public function mergePairs(MemberOrderedMap|iterable ...$others): self
383383
{
384384
foreach ($others as $other) {
385385
$this->members = [...$this->members, ...self::fromPairs($other)->members];

0 commit comments

Comments
 (0)