Skip to content

Commit de42d88

Browse files
committed
Update documentation
1 parent 2d94491 commit de42d88

File tree

4 files changed

+23
-12
lines changed

4 files changed

+23
-12
lines changed

CHANGELOG.md

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

77
### Added
88

9-
- Public API around accessing parameters using their index instead of their key.
9+
- `OrederedMap::push`
10+
- `OrederedMap::unshift`
11+
- `OrederedMap::insert`
12+
- `OrederedMap::replace`
13+
- `ParameterAccess::pushParanmeters`
14+
- `ParameterAccess::unshiftParamaters`
15+
- `ParameterAccess::insertParamaters`
16+
- `ParameterAccess::replaceParamater`
17+
- `ParameterAccess::withoutParametersByKeys`
18+
- `ParameterAccess::withoutParametersByIndices`
1019

1120
### Fixed
1221

13-
- `Parameters::remove` also removes parameters per indexes
22+
- `Parameters::remove` also removes parameters per indices
1423
- `Type::fromValue` throws an `InvalidArgument` exception.
1524
- `Type::fromValue` and `Type::tryFromValue` should only check the PHP variable type and not take into account the variable value.
1625

1726
### Deprecated
1827

19-
- None
28+
- `ParameterAccess::withoutParameters` replaced by `ParameterAccess::withoutParametersBykeys`
2029

2130
### Removed
2231

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -560,7 +560,7 @@ You can attach and update the associated `Parameters` instance using the followi
560560
$field->addParameter(string $key, mixed $value): static;
561561
$field->appendParameter(string $key, mixed $value): static;
562562
$field->prependParameter(string $key, mixed $value): static;
563-
$field->withoutParameters(string ...$keys): static;
563+
$field->withoutParameters(string ...$keys): static; // this method is deprecated as of version 1.1 use withoutParametersByKeys instead
564564
$field->withoutAnyParameter(): static;
565565
$field->withParameters(Parameters $parameters): static;
566566
```
@@ -572,6 +572,8 @@ $field->pushParameters(array ...$pairs): static
572572
$field->unshiftParameters(array ...$pairs): static
573573
$field->insertParameters(int $index, array ...$pairs): static
574574
$field->replaceParameter(int $index, array $pair): static
575+
$field->withoutParametersByKeys(string ...$keys): static
576+
$field->withoutParametersByIndices(int ...$indices): static
575577
```
576578

577579
The `$pair` parameter is a tuple (ie: an array as list with exactly two members) where:

composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@
3030
"require-dev": {
3131
"friendsofphp/php-cs-fixer": "^v3.15.1",
3232
"httpwg/structured-field-tests": "*@dev",
33-
"phpstan/phpstan": "^1.10.13",
33+
"phpstan/phpstan": "^1.10.14",
3434
"phpstan/phpstan-strict-rules": "^1.5.1",
3535
"phpstan/phpstan-phpunit": "^1.3.11",
3636
"phpstan/phpstan-deprecation-rules": "^1.1.3",
37-
"phpunit/phpunit": "^10.1.0",
37+
"phpunit/phpunit": "^10.1.2",
3838
"phpbench/phpbench": "^1.2.10",
39-
"symfony/var-dumper": "^6.2.8"
39+
"symfony/var-dumper": "^6.2.10"
4040
},
4141
"autoload": {
4242
"psr-4": {

src/Parser.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@
2222
*
2323
* @see https://www.rfc-editor.org/rfc/rfc8941.html#section-4.2
2424
*
25-
* @see Dictionary::fromHttpValue(),
26-
* @see Parameters::fromHttpValue(),
27-
* @see OuterList::fromHttpValue(),
28-
* @see InnerList::fromHttpValue()
29-
* @see Item::fromHttpValue() instead
25+
* @internal Use Dictionary::fromHttpValue(),
26+
* Parameters::fromHttpValue(),
27+
* OuterList::fromHttpValue(),
28+
* InnerList::fromHttpValue()
29+
* or Item::fromHttpValue() instead
3030
*
3131
* @phpstan-import-type SfType from StructuredField
3232
*/

0 commit comments

Comments
 (0)