Skip to content

Commit 64218cf

Browse files
dabrtmnocon
andauthored
Add information about ValueObject replacement (#2847)
* Add information about ValueObject replacement --------- Co-authored-by: Marek Nocoń <[email protected]>
1 parent 68d34a7 commit 64218cf

5 files changed

+104
-0
lines changed

docs/release_notes/ibexa_dxp_v5.0_deprecations.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ Several field type identifiers have changed.
142142
| `ezurl` | `ibexa_url` |
143143
| `ezuser` | `ibexa_user` |
144144

145+
145146
## PHP API classes and methods
146147

147148
!!! note "[[= product_name_base =]] Rector"
@@ -515,6 +516,109 @@ Support for facet search has been dropped, use the `Aggregation` API instead.
515516
| `\Ibexa\Contracts\Workflow\Service\WorkflowServiceInterface::loadWorkflowMetadataOriginatedByUser` | Removed |
516517
| `\Ibexa\Contracts\Workflow\Service\WorkflowServiceInterface::loadAllWorkflowMetadata` | Removed |
517518

519+
## PHP method parameters
520+
521+
The `ValueObject` argument was replaced by `object` in a number of interfaces in `core` and `migrations` package.
522+
In `core`, this change improves extensibility by enabling the use of custom object types to be interpreted by `PermissionResolver`.
523+
In `migrations`, it makes it easier to integrate custom data types, especially when using `AbstractStepFactory`.
524+
525+
!!! note "Change examples"
526+
527+
Below the lists you may find examples of changes in those interfaces or classes that you are most likely to use in your work.
528+
529+
### ibexa/core
530+
531+
| PHP Interface or class | Methods |
532+
|:------------------------------------------------------|:------------------------------------------------------------------------|
533+
| `Ibexa\Contracts\Core\Repository\PermissionResolver` | `canUser`, `lookupLimitations` |
534+
| `Ibexa\Contracts\Core\Limitation/TargetAwareType` | `evaluate` |
535+
| `Ibexa\Contracts\Core\Limitation/Type` | `evaluate` |
536+
| `Ibexa\Core\Limitation\BlockingLimitationType` | `evaluate` |
537+
| `Ibexa\Core\Limitation\ChangeOwnerLimitationType` | `evaluate` |
538+
| `Ibexa\Core\Limitation\ContentTypeLimitationType` | `evaluate` |
539+
| `Ibexa\Core\Limitation\LanguageLimitationType` | `evaluate` |
540+
| `Ibexa\Core\Limitation\LocationLimitationType` | `evaluate` |
541+
| `Ibexa\Core\Limitation\MemberOfLimitationType` | `evaluate` |
542+
| `Ibexa\Core\Limitation\NewObjectStateLimitationType` | `evaluate` |
543+
| `Ibexa\Core\Limitation\NewSectionLimitationType` | `evaluate` |
544+
| `Ibexa\Core\Limitation\ObjectStateLimitationType` | `evaluate` |
545+
| `Ibexa\Core\Limitation\OwnerLimitationType` | `evaluate` |
546+
| `Ibexa\Core\Limitation\ParentContentTypeLimitationType` | `evaluate` |
547+
| `Ibexa\Core\Limitation\ParentDepthLimitationType` | `evaluate` |
548+
| `Ibexa\Core\Limitation\ParentOwnerLimitationType` | `evaluate` |
549+
| `Ibexa\Core\Limitation\ParentUserGroupLimitationType` | `evaluate` |
550+
| `Ibexa\Core\Limitation\RoleLimitationType` | `evaluate` |
551+
| `Ibexa\Core\Limitation\SectionLimitationType` | `evaluate` |
552+
| `Ibexa\Core\Limitation\SiteAccessLimitationType` | `evaluate` |
553+
| `Ibexa\Core\Limitation\StatusLimitationType` | `evaluate` |
554+
| `Ibexa\Core\Limitation\SubtreeLimitationType` | `evaluate` |
555+
| `Ibexa\Core\Limitation\UserGroupLimitationType` | `evaluate` |
556+
| `Ibexa\Core\Repository\Permission\CachedPermissionService` | `canUser`, `lookupLimitations` |
557+
| `Ibexa\Core\Repository\Permission\PermissionResolver` | `canUser`, `lookupLimitations` |
558+
559+
??? note "Changes in `src/contracts/Repository/PermissionResolver.php`"
560+
561+
![`PermissionResolver.php`](5.0_Repository.PermissionResolver.png)
562+
563+
### ibexa/migrations
564+
565+
| PHP Interface or class | Methods |
566+
|:------------------------------------------------------|:------------------------------------------------------------------------|
567+
| `Ibexa\Contracts\Migration\StepExecutor\AbstractStepExecutor` | `doCollectReferences`, `handleActions` |
568+
| `Ibexa\Migration\Generator\Content\StepBuilder\Create` | `build` |
569+
| `Ibexa\Migration\Generator\Content\StepBuilder\Delete` | `build` |
570+
| `Ibexa\Migration\Generator\Content\StepBuilder\Factory` | `prepareLogMessage` |
571+
| `Ibexa\Migration\Generator\Content\StepBuilder\Update` | `build` |
572+
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Create` | `build` |
573+
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Delete` | `build` |
574+
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Factory` | `prepareLogMessage` |
575+
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Update` | `build` |
576+
| `Ibexa\Migration\Generator\Language\StepBuilder\Create` | `build` |
577+
| `Ibexa\Migration\Generator\Language\StepBuilder\Factory` | `prepareLogMessage` |
578+
| `Ibexa\Migration\Generator\Location\StepBuilder\Factory` | `prepareLogMessage` |
579+
| `Ibexa\Migration\Generator\Location\StepBuilder\Update` | `build` |
580+
| `Ibexa\Migration\Generator\ObjectState\StepBuilder\Create` | `build` |
581+
| `Ibexa\Migration\Generator\ObjectState\StepBuilder\Factory` | `prepareLogMessage` |
582+
| `Ibexa\Migration\Generator\ObjectStateGroup\StepBuilder\Create` | `build` |
583+
| `Ibexa\Migration\Generator\ObjectStateGroup\StepBuilder\Factory` | `prepareLogMessage` |
584+
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleCreateStepBuilder` | `build` |
585+
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleDeleteStepBuilder` | `build` |
586+
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleStepFactory` | `prepareLogMessage` |
587+
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleUpdateStepBuilder` | `build` |
588+
| `Ibexa\Migration\Generator\Section\StepBuilder\Create` | `build` |
589+
| `Ibexa\Migration\Generator\Section\StepBuilder\Factory` | `prepareLogMessage` |
590+
| `Ibexa\Migration\Generator\Section\StepBuilder\Update` | `build` |
591+
| `Ibexa\Migration\Generator\StepBuilder\AbstractStepFactory` | `create`, `log`, `prepareLogMessage` |
592+
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeCreateStepBuilder` | `build` |
593+
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeDeleteStepBuilder` | `build` |
594+
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeStepFactory` | `prepareLogMessage` |
595+
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeUpdateStepBuilder` | `build` |
596+
| `Ibexa\Migration\Generator\StepBuilder\LoggerContentTypeCreateStepBuilder` | `build` |
597+
| `Ibexa\Migration\Generator\StepBuilder\StepBuilderInterface` | `build` |
598+
| `Ibexa\Migration\Generator\StepBuilder\StepFactoryInterface` | `build` |
599+
| `Ibexa\Migration\Generator\User\StepBuilder\Create` | `build` |
600+
| `Ibexa\Migration\Generator\User\StepBuilder\Factory` | `prepareLogMessage` |
601+
| `Ibexa\Migration\Generator\User\StepBuilder\Update` | `build` |
602+
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Create` | `build` |
603+
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Delete` | `build` |
604+
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Factory` | `prepareLogMessage` |
605+
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Update` | `build` |
606+
| `Ibexa\Migration\StepExecutor\ReferenceDefinition\Resolver` | `resolve` |
607+
| `Ibexa\Migration\StepExecutor\ReferenceDefinition\ResolverInterface` | `resolve` |
608+
609+
610+
??? note "Changes in `Ibexa\Migration\Generator\StepBuilder\StepFactoryInterface`"
611+
612+
![`StepFactoryInterface.php`](5.0_StepBuilder.StepFactoryInterface.png)
613+
614+
??? note "Changes in `Ibexa\Migration\StepExecutor\ReferenceDefinition\ResolverInterface`"
615+
616+
![`ResolverInterface.php`](5.0_StepExecutor.ReferenceDefinition.ResolverInterface.png)
617+
618+
??? note "Changes in `Ibexa\Migration\Generator\StepBuilder\AbstractStepFactory`"
619+
620+
![`AbstractStepFactory.php`](5.0_StepBuilder.AbstractStepFactory.png)
621+
518622
## Services
519623

520624
The following service definitions have been removed:
171 KB
Loading
130 KB
Loading
54.2 KB
Loading
60.5 KB
Loading

0 commit comments

Comments
 (0)