Nodarx/server
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Projects Releases Activity

docs: document entityModify()'s authoritative-identifier contract

Browse Source 
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
Sebastian Krupinski
2026-08-25 22:46:29 -04:00
parent b3e0c00c87
commit 964128e051
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
shared/lib/Mail/Service/ServiceEntityMutableInterface.php
+8 -1
View File
@@ -56,12 +56,19 @@ interface ServiceEntityMutableInterface {
/** /**
* Modifies an existing entity * Modifies an existing entity
* *
* The returned entity's identifier is authoritative and may differ from
* the target identifier. Providers without in-place update support may
* implement this as an append-and-replace (or equivalent create-then-
* destroy) operation, in which case the target identifier is superseded
* and no longer resolvable; callers must persist the returned identifier
* rather than assume the target remains valid.
*
* @since 2025.05.01 * @since 2025.05.01
* *
* @param EntityIdentifier $target Target entity identifier * @param EntityIdentifier $target Target entity identifier
* @param MessagePropertiesMutableInterface $properties Entity properties to update * @param MessagePropertiesMutableInterface $properties Entity properties to update
* *
* @return EntityBaseInterface Modified entity * @return EntityBaseInterface Modified entity, with its own authoritative identifier
*/ */
public function entityModify(EntityIdentifier $target, MessagePropertiesMutableInterface $properties): EntityBaseInterface; public function entityModify(EntityIdentifier $target, MessagePropertiesMutableInterface $properties): EntityBaseInterface;