-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEntityClientInterface.php
More file actions
95 lines (80 loc) · 3.11 KB
/
EntityClientInterface.php
File metadata and controls
95 lines (80 loc) · 3.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?php
/*
* Copyright ©2024 Robert Landers
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the “Software”), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
* OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
namespace Bottledcode\DurablePhp;
use Bottledcode\DurablePhp\Events\Shares\Operation;
use Bottledcode\DurablePhp\Glue\Provenance;
use Bottledcode\DurablePhp\Search\EntityFilter;
use Bottledcode\DurablePhp\State\EntityId;
use Bottledcode\DurablePhp\State\EntityState;
use Closure;
use DateTimeImmutable;
use Generator;
interface EntityClientInterface
{
public function withAuth(Provenance|string|null $token): void;
/**
* Removes empty entities and releases orphaned locks
*/
public function cleanEntityStorage(): void;
/**
* Get a list of entities
*
* @return Generator<EntityId>
*/
public function listEntities(EntityFilter $filter, int $page): Generator;
/**
* Signal an entity either now, or at some point in the future
*/
public function signalEntity(
EntityId $entityId,
string $operationName,
array $input = [],
?DateTimeImmutable $scheduledTime = null,
): void;
/**
* Signals an entity using a closure
*
* @template T
*
* @param EntityId<T>|class-string<T> $entityId The id of the entity to signal
* @param Closure<T> $signal
*/
public function signal(EntityId|string $entityId, Closure $signal): void;
/**
* @template T of EntityState
*
* @param EntityId<T> $entityId
* @param class-string<T> $type
* @return T|null
*/
public function getEntitySnapshot(EntityId $entityId): ?EntityState;
/**
* Deletes an entity
*/
public function deleteEntity(EntityId $entityId): void;
public function shareEntityOwnership(EntityId $id, string $with): void;
public function grantEntityAccessToUser(EntityId $id, string $user, Operation $operation): void;
public function grantEntityAccessToRole(EntityId $id, string $role, Operation $operation): void;
public function revokeEntityAccessToUser(EntityId $id, string $user): void;
public function revokeEntityAccessToRole(EntityId $id, string $role): void;
}