Skip to content

Commit 6f4dd7d

Browse files
mabarmabar
committed
Rename callbacks
1 parent 0c615c0 commit 6f4dd7d

File tree

50 files changed

+238
-230
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+238
-230
lines changed

‎CHANGELOG.md‎

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,29 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
2121
- Reduce calls needed to find field names for "did you mean" error helper (performance optimization)
2222
- Call `unset()` only for initialized properties (performance optimization)
2323
- Create functions for setting and unsetting non public-set properties only once (performance optimization)
24-
- `ArrayShapeRule`
25-
- Simplify finding missing fields (performance optimization)
26-
- Reduce calls needed to find field names for "did you mean" error helper (performance optimization)
27-
- `BoolRule`
28-
- `castBoolLike` option trims empty characters from start and end of the string
29-
- `FloatRule`
30-
- `castNumericString` option trims empty characters from start and end of the string
31-
- `IntRule`
32-
- `castNumericString` option trims empty characters from start and end of the string
33-
- `NullRule`
34-
- `castEmptyString` option trims empty characters from start and end of the string
35-
- `StringRule`
36-
- `notEmpty` detects more empty values
37-
- `FieldContext`
38-
- Replace redundant `Type` lazy getter with one from the `CallContext`
24+
- Callbacks
25+
- renamed
26+
- `Before` -> `BeforeValidation`
27+
- `BeforeCallback` -> `BeforeValidationCallback`
28+
- `After` -> `AfterValidation`
29+
- `AfterCallback` -> `AfterValidationCallback`
30+
- Rules
31+
- `ArrayShapeRule`
32+
- Simplify finding missing fields (performance optimization)
33+
- Reduce calls needed to find field names for "did you mean" error helper (performance optimization)
34+
- `BoolRule`
35+
- `castBoolLike` option trims empty characters from start and end of the string
36+
- `FloatRule`
37+
- `castNumericString` option trims empty characters from start and end of the string
38+
- `IntRule`
39+
- `castNumericString` option trims empty characters from start and end of the string
40+
- `NullRule`
41+
- `castEmptyString` option trims empty characters from start and end of the string
42+
- `StringRule`
43+
- `notEmpty` detects more empty values
44+
- Contexts
45+
- `FieldContext`
46+
- Replace redundant `Type` lazy getter with one from the `CallContext`
3947

4048
### Fixed
4149

‎docs/README.md‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2172,15 +2172,15 @@ Define callbacks before and after mapped objects and their fields:
21722172
<summary><code>#[Attributes()]</code></summary>
21732173

21742174
```php
2175-
use Orisai\ObjectMapper\Callbacks\After;
2175+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
21762176
use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
21772177
use Orisai\ObjectMapper\MappedObject;
21782178
use Orisai\ObjectMapper\Rules\StringValue;
21792179

21802180
final class WithCallbackInput implements MappedObject
21812181
{
21822182

2183-
#[After('afterField')]
2183+
#[AfterValidation('afterField')]
21842184
#[StringValue()]
21852185
public string $field;
21862186

@@ -2197,7 +2197,7 @@ final class WithCallbackInput implements MappedObject
21972197
<summary><code>@Annotations()</code></summary>
21982198

21992199
```php
2200-
use Orisai\ObjectMapper\Callbacks\After;
2200+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
22012201
use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
22022202
use Orisai\ObjectMapper\MappedObject;
22032203
use Orisai\ObjectMapper\Rules\StringValue;
@@ -2207,7 +2207,7 @@ final class WithCallbackInput implements MappedObject
22072207

22082208
/**
22092209
* @StringValue()
2210-
* @After("afterField")
2210+
* @AfterValidation("afterField")
22112211
*/
22122212
public string $field;
22132213

@@ -2253,13 +2253,13 @@ After mapped object
22532253
<summary><code>#[Attributes()]</code></summary>
22542254

22552255
```php
2256-
use Orisai\ObjectMapper\Callbacks\After;
2257-
use Orisai\ObjectMapper\Callbacks\Before;
2256+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
2257+
use Orisai\ObjectMapper\Callbacks\BeforeValidation;
22582258
use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
22592259
use Orisai\ObjectMapper\MappedObject;
22602260

2261-
#[Before('beforeObject')]
2262-
#[After('afterObject')]
2261+
#[BeforeValidation('beforeObject')]
2262+
#[AfterValidation('afterObject')]
22632263
final class WithMappedObjectCallbacksInput implements MappedObject
22642264
{
22652265

@@ -2285,14 +2285,14 @@ final class WithMappedObjectCallbacksInput implements MappedObject
22852285
<summary><code>@Annotations()</code></summary>
22862286

22872287
```php
2288-
use Orisai\ObjectMapper\Callbacks\After;
2289-
use Orisai\ObjectMapper\Callbacks\Before;
2288+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
2289+
use Orisai\ObjectMapper\Callbacks\BeforeValidation;
22902290
use Orisai\ObjectMapper\Callbacks\Context\ObjectContext;
22912291
use Orisai\ObjectMapper\MappedObject;
22922292

22932293
/**
2294-
* @Before("beforeObject")
2295-
* @After("afterObject")
2294+
* @BeforeValidation("beforeObject")
2295+
* @AfterValidation("afterObject")
22962296
*/
22972297
final class WithMappedObjectCallbacksInput implements MappedObject
22982298
{
@@ -2341,17 +2341,17 @@ After field
23412341
<summary><code>#[Attributes()]</code></summary>
23422342

23432343
```php
2344-
use Orisai\ObjectMapper\Callbacks\After;
2345-
use Orisai\ObjectMapper\Callbacks\Before;
2344+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
2345+
use Orisai\ObjectMapper\Callbacks\BeforeValidation;
23462346
use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
23472347
use Orisai\ObjectMapper\MappedObject;
23482348
use Orisai\ObjectMapper\Rules\StringValue;
23492349

23502350
final class WithFieldCallbacksInput implements MappedObject
23512351
{
23522352

2353-
#[Before('beforeField')]
2354-
#[After('afterField')]
2353+
#[BeforeValidation('beforeField')]
2354+
#[AfterValidation('afterField')]
23552355
#[StringValue()]
23562356
public string $field;
23572357

@@ -2373,8 +2373,8 @@ final class WithFieldCallbacksInput implements MappedObject
23732373
<summary><code>@Annotations()</code></summary>
23742374

23752375
```php
2376-
use Orisai\ObjectMapper\Callbacks\After;
2377-
use Orisai\ObjectMapper\Callbacks\Before;
2376+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
2377+
use Orisai\ObjectMapper\Callbacks\BeforeValidation;
23782378
use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
23792379
use Orisai\ObjectMapper\MappedObject;
23802380
use Orisai\ObjectMapper\Rules\StringValue;
@@ -2383,8 +2383,8 @@ final class WithFieldCallbacksInput implements MappedObject
23832383
{
23842384

23852385
/**
2386-
* @Before("beforeField")
2387-
* @After("afterField")
2386+
* @BeforeValidation("beforeField")
2387+
* @AfterValidation("afterField")
23882388
* @StringValue()
23892389
*/
23902390
public string $field;
@@ -2410,7 +2410,7 @@ final class WithFieldCallbacksInput implements MappedObject
24102410
Field callbacks are called only when field is sent. Callback is not invoked for default value.
24112411

24122412
```php
2413-
use Orisai\ObjectMapper\Callbacks\After;
2413+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
24142414
use Orisai\ObjectMapper\Callbacks\Context\FieldContext;
24152415
use Orisai\ObjectMapper\MappedObject;
24162416
use Orisai\ObjectMapper\Rules\StringValue;
@@ -2420,7 +2420,7 @@ final class WithNotInvokedCallbackInput implements MappedObject
24202420

24212421
/**
24222422
* @StringValue()
2423-
* @After("afterField")
2423+
* @AfterValidation("afterField")
24242424
*/
24252425
public string $field = 'default';
24262426

@@ -2447,14 +2447,14 @@ Callbacks are by default expected to return a value:
24472447
<summary><code>#[Attributes()]</code></summary>
24482448

24492449
```php
2450-
use Orisai\ObjectMapper\Callbacks\After;
2450+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
24512451
use Orisai\ObjectMapper\MappedObject;
24522452
use Orisai\ObjectMapper\Rules\MixedValue;
24532453

24542454
final class WithReturningCallbackInput implements MappedObject
24552455
{
24562456

2457-
#[After('afterField')]
2457+
#[AfterValidation('afterField')]
24582458
#[MixedValue()]
24592459
public mixed $field;
24602460

@@ -2471,7 +2471,7 @@ final class WithReturningCallbackInput implements MappedObject
24712471
<summary><code>@Annotations()</code></summary>
24722472

24732473
```php
2474-
use Orisai\ObjectMapper\Callbacks\After;
2474+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
24752475
use Orisai\ObjectMapper\MappedObject;
24762476
use Orisai\ObjectMapper\Rules\MixedValue;
24772477

@@ -2481,7 +2481,7 @@ final class WithReturningCallbackInput implements MappedObject
24812481
/**
24822482
* @var mixed
24832483
* @MixedValue()
2484-
* @After("afterField")
2484+
* @AfterValidation("afterField")
24852485
*/
24862486
public $field;
24872487

@@ -2504,7 +2504,7 @@ We may change that by defining `void` or `never` return type:
25042504
<summary><code>#[Attributes()]</code></summary>
25052505

25062506
```php
2507-
use Orisai\ObjectMapper\Callbacks\After;
2507+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
25082508
use Orisai\ObjectMapper\Exception\ValueDoesNotMatch;
25092509
use Orisai\ObjectMapper\MappedObject;
25102510
use Orisai\ObjectMapper\Processing\Value;
@@ -2513,7 +2513,7 @@ use Orisai\ObjectMapper\Rules\StringValue;
25132513
final class WithNotReturningCallbackInput implements MappedObject
25142514
{
25152515

2516-
#[After('afterRemoved')]
2516+
#[AfterValidation('afterRemoved')]
25172517
#[StringValue()]
25182518
public string $removed;
25192519

@@ -2530,7 +2530,7 @@ final class WithNotReturningCallbackInput implements MappedObject
25302530
<summary><code>@Annotations()</code></summary>
25312531

25322532
```php
2533-
use Orisai\ObjectMapper\Callbacks\After;
2533+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
25342534
use Orisai\ObjectMapper\Exception\ValueDoesNotMatch;
25352535
use Orisai\ObjectMapper\MappedObject;
25362536
use Orisai\ObjectMapper\Processing\Value;
@@ -2541,7 +2541,7 @@ final class WithNotReturningCallbackInput implements MappedObject
25412541

25422542
/**
25432543
* @StringValue()
2544-
* @After("afterRemoved")
2544+
* @AfterValidation("afterRemoved")
25452545
*/
25462546
public string $removed;
25472547

@@ -2635,7 +2635,7 @@ Create mapped object that requires dependencies via `RequiresDependencies`, spec
26352635
<summary><code>#[Attributes()]</code></summary>
26362636

26372637
```php
2638-
use Orisai\ObjectMapper\Callbacks\After;
2638+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
26392639
use Orisai\ObjectMapper\Exception\ValueDoesNotMatch;
26402640
use Orisai\ObjectMapper\MappedObject;
26412641
use Orisai\ObjectMapper\Modifiers\RequiresDependencies;
@@ -2648,7 +2648,7 @@ final class WithDependenciesInput implements MappedObject
26482648

26492649
public ExampleService $service;
26502650

2651-
#[After('afterField')]
2651+
#[AfterValidation('afterField')]
26522652
#[MixedValue()]
26532653
public mixed $field;
26542654

@@ -2669,7 +2669,7 @@ final class WithDependenciesInput implements MappedObject
26692669
<summary><code>@Annotations()</code></summary>
26702670

26712671
```php
2672-
use Orisai\ObjectMapper\Callbacks\After;
2672+
use Orisai\ObjectMapper\Callbacks\AfterValidation;
26732673
use Orisai\ObjectMapper\Exception\ValueDoesNotMatch;
26742674
use Orisai\ObjectMapper\MappedObject;
26752675
use Orisai\ObjectMapper\Modifiers\RequiresDependencies;
@@ -2686,7 +2686,7 @@ final class WithDependenciesInput implements MappedObject
26862686

26872687
/**
26882688
* @MixedValue()
2689-
* @After("afterField")
2689+
* @AfterValidation("afterField")
26902690
*/
26912691
public $field;
26922692

src/Callbacks/After.php renamed to src/Callbacks/AfterValidation.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* @Target({"CLASS", "PROPERTY"})
1313
*/
1414
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
15-
final class After implements CallbackDefinition
15+
final class AfterValidation implements CallbackDefinition
1616
{
1717

1818
private string $method;
@@ -31,14 +31,14 @@ public function __construct(string $method, string $runtime = CallbackRuntime::P
3131

3232
public function getType(): string
3333
{
34-
return AfterCallback::class;
34+
return AfterValidationCallback::class;
3535
}
3636

3737
public function getArgs(): array
3838
{
3939
return [
40-
BaseCallback::Method => $this->method,
41-
BaseCallback::Runtime => $this->runtime,
40+
ValidationCallback::Method => $this->method,
41+
ValidationCallback::Runtime => $this->runtime,
4242
];
4343
}
4444

src/Callbacks/AfterCallback.php renamed to src/Callbacks/AfterValidationCallback.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
use function in_array;
1010
use function sprintf;
1111

12-
final class AfterCallback extends BaseCallback
12+
final class AfterValidationCallback extends ValidationCallback
1313
{
1414

1515
protected static function validateClassMethodDataParam(

src/Callbacks/Before.php renamed to src/Callbacks/BeforeValidation.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* @Target({"CLASS", "PROPERTY"})
1313
*/
1414
#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_PROPERTY)]
15-
final class Before implements CallbackDefinition
15+
final class BeforeValidation implements CallbackDefinition
1616
{
1717

1818
private string $method;
@@ -31,14 +31,14 @@ public function __construct(string $method, string $runtime = CallbackRuntime::P
3131

3232
public function getType(): string
3333
{
34-
return BeforeCallback::class;
34+
return BeforeValidationCallback::class;
3535
}
3636

3737
public function getArgs(): array
3838
{
3939
return [
40-
BaseCallback::Method => $this->method,
41-
BaseCallback::Runtime => $this->runtime,
40+
ValidationCallback::Method => $this->method,
41+
ValidationCallback::Runtime => $this->runtime,
4242
];
4343
}
4444

src/Callbacks/BeforeCallback.php renamed to src/Callbacks/BeforeValidationCallback.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
use function in_array;
1010
use function sprintf;
1111

12-
final class BeforeCallback extends BaseCallback
12+
final class BeforeValidationCallback extends ValidationCallback
1313
{
1414

1515
protected static function validateClassMethodDataParam(

0 commit comments

Comments
 (0)