refactor: use unified service provider desing

Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
2026-06-25 23:47:17 -04:00
parent 87d6af93b7
commit 6ca83a7dd7
19 changed files with 198 additions and 135 deletions
@@ -40,6 +40,10 @@ abstract class CollectionMutableAbstract extends NodeMutableAbstract implements
// Copy all property values // Copy all property values
$this->properties->setLabel($value->getLabel()); $this->properties->setLabel($value->getLabel());
$this->properties->setDescription($value->getDescription());
$this->properties->setRank($value->getRank());
$this->properties->setVisibility($value->getVisibility());
$this->properties->setColor($value->getColor());
return $this; return $this;
} }
@@ -20,22 +20,18 @@ use KTXF\Resource\Provider\Node\NodePropertiesBaseAbstract;
*/ */
abstract class CollectionPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements CollectionPropertiesBaseInterface { abstract class CollectionPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements CollectionPropertiesBaseInterface {
public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function content(): CollectionContent { public function content(): array {
$content = $this->data[self::PROPERTY_CONTENTS] ?? null; $content = $this->data[self::PROPERTY_CONTENT] ?? null;
if ($content instanceof CollectionContent) { if (is_array($content)) {
return $content; return array_filter(array_map(function ($item) {
return $item instanceof CollectionContent ? $item : CollectionContent::tryFrom($item);
}, $content));
} else {
return [];
} }
if (is_string($content)) {
return CollectionContent::tryFrom($content) ?? CollectionContent::Event;
}
return CollectionContent::Event;
} }
/** /**
@@ -55,8 +51,8 @@ abstract class CollectionPropertiesBaseAbstract extends NodePropertiesBaseAbstra
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function getPriority(): ?int { public function getRank(): ?int {
return $this->data[self::PROPERTY_PRIORITY] ?? null; return $this->data[self::PROPERTY_RANK] ?? null;
} }
/** /**
@@ -14,15 +14,22 @@ use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;
interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface { interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface {
public const JSON_TYPE = 'chrono:collection'; public const JSON_TYPE = 'chrono:collection';
public const PROPERTY_CONTENTS = 'content'; public const PROPERTY_CONTENT = 'content';
public const PROPERTY_LABEL = 'label'; public const PROPERTY_LABEL = 'label';
public const PROPERTY_DESCRIPTION = 'description'; public const PROPERTY_DESCRIPTION = 'description';
public const PROPERTY_PRIORITY = 'priority'; public const PROPERTY_RANK = 'rank';
public const PROPERTY_VISIBILITY = 'visibility'; public const PROPERTY_VISIBILITY = 'visibility';
public const PROPERTY_COLOR = 'color'; public const PROPERTY_COLOR = 'color';
public function content(): CollectionContent; /**
* Gets the content type of this collection
*
* @since 2025.05.01
*
* @return CollectionContent[] Returns an array of content types, a single content type, or null if not set
*/
public function content(): array;
/** /**
* Gets the human friendly name of this collection (e.g. Personal Calendar) * Gets the human friendly name of this collection (e.g. Personal Calendar)
@@ -39,11 +46,11 @@ interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface
public function getDescription(): ?string; public function getDescription(): ?string;
/** /**
* Gets the priority of this collection * Gets the rank of this collection
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
public function getPriority(): ?int; public function getRank(): ?int;
/** /**
* Gets the visibility of this collection * Gets the visibility of this collection
@@ -48,8 +48,8 @@ abstract class CollectionPropertiesMutableAbstract extends CollectionPropertiesB
/** /**
* @inheritDoc * @inheritDoc
*/ */
public function setPriority(?int $value): static { public function setRank(?int $value): static {
$this->data[self::PROPERTY_PRIORITY] = $value; $this->data[self::PROPERTY_RANK] = $value;
return $this; return $this;
} }
@@ -30,11 +30,11 @@ interface CollectionPropertiesMutableInterface extends CollectionPropertiesBaseI
public function setDescription(?string $value): static; public function setDescription(?string $value): static;
/** /**
* Sets the priority of this collection * Sets the rank of this collection
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
public function setPriority(?int $value): static; public function setRank(?int $value): static;
/** /**
* Sets the visibility of this collection * Sets the visibility of this collection
@@ -9,18 +9,24 @@ declare(strict_types=1);
namespace KTXF\Chrono\Entity; namespace KTXF\Chrono\Entity;
use KTXF\Resource\Identifier\EntityIdentifier;
use KTXF\Resource\Provider\Node\NodeBaseAbstract; use KTXF\Resource\Provider\Node\NodeBaseAbstract;
/** /**
* Abstract Chrono Entity Base Class * Abstract Chrono Entity Base Class
* *
* Provides common implementation for chrono entities * Provides common implementation for chrono entities
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
abstract class EntityBaseAbstract extends NodeBaseAbstract implements EntityBaseInterface { abstract class EntityBaseAbstract extends NodeBaseAbstract implements EntityBaseInterface {
protected EntityPropertiesBaseAbstract $properties; protected string $type = 'chrono:entity';
protected EntityPropertiesBaseInterface $properties;
protected function nodeIdentifier(): EntityIdentifier {
return new EntityIdentifier($this->data[static::PROPERTY_PROVIDER], $this->data[static::PROPERTY_SERVICE], $this->data[static::PROPERTY_COLLECTION], $this->data[static::PROPERTY_IDENTIFIER]);
}
/** /**
* @inheritDoc * @inheritDoc
@@ -13,8 +13,6 @@ use KTXF\Resource\Provider\Node\NodeBaseInterface;
interface EntityBaseInterface extends NodeBaseInterface { interface EntityBaseInterface extends NodeBaseInterface {
public const JSON_TYPE = 'chrono.entity';
/** /**
* Gets the entity properties * Gets the entity properties
* *
@@ -9,21 +9,25 @@ declare(strict_types=1);
namespace KTXF\Chrono\Entity; namespace KTXF\Chrono\Entity;
use KTXF\Resource\Identifier\EntityIdentifier;
use KTXF\Resource\Provider\Node\NodeMutableAbstract; use KTXF\Resource\Provider\Node\NodeMutableAbstract;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface; use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
/** /**
* Abstract Chrono Entity Mutable Class * Abstract Chrono Entity Mutable Class
* *
* Provides common implementation for mutable chrono entities * Provides common implementation for mutable chrono entities
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
abstract class EntityMutableAbstract extends NodeMutableAbstract implements EntityMutableInterface { abstract class EntityMutableAbstract extends NodeMutableAbstract implements EntityMutableInterface {
public const JSON_TYPE = EntityMutableInterface::JSON_TYPE; protected string $type = 'chrono:entity';
protected EntityPropertiesMutableInterface $properties;
protected EntityPropertiesMutableAbstract $properties; protected function nodeIdentifier(): EntityIdentifier {
return new EntityIdentifier($this->data[static::PROPERTY_PROVIDER], $this->data[static::PROPERTY_SERVICE], (string) $this->data[static::PROPERTY_COLLECTION], (string) $this->data[static::PROPERTY_IDENTIFIER]);
}
/** /**
* @inheritDoc * @inheritDoc
@@ -40,7 +44,7 @@ abstract class EntityMutableAbstract extends NodeMutableAbstract implements Enti
throw new \InvalidArgumentException('Properties must implement EntityPropertiesMutableInterface'); throw new \InvalidArgumentException('Properties must implement EntityPropertiesMutableInterface');
} }
$this->properties->setDataRaw($value->getDataRaw()); $this->properties = $value;
return $this; return $this;
} }
@@ -16,8 +16,6 @@ use KTXF\Resource\Provider\Node\NodeMutableInterface;
*/ */
interface EntityMutableInterface extends EntityBaseInterface, NodeMutableInterface { interface EntityMutableInterface extends EntityBaseInterface, NodeMutableInterface {
public const JSON_TYPE = EntityBaseInterface::JSON_TYPE;
/** /**
* Gets the entity properties (mutable) * Gets the entity properties (mutable)
* *
@@ -13,8 +13,9 @@ use KTXF\Resource\Provider\Node\NodePropertiesBaseAbstract;
abstract class EntityPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements EntityPropertiesBaseInterface { abstract class EntityPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements EntityPropertiesBaseInterface {
public const JSON_TYPE = EntityPropertiesBaseInterface::JSON_TYPE; /**
* @inheritDoc
*/
public function getDataRaw(): array|string|null { public function getDataRaw(): array|string|null {
return $this->data[self::PROPERTY_DATA] ?? null; return $this->data[self::PROPERTY_DATA] ?? null;
} }
@@ -13,8 +13,6 @@ use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
interface EntityPropertiesMutableInterface extends EntityPropertiesBaseInterface, NodePropertiesMutableInterface { interface EntityPropertiesMutableInterface extends EntityPropertiesBaseInterface, NodePropertiesMutableInterface {
public const JSON_TYPE = EntityPropertiesBaseInterface::JSON_TYPE;
public function setDataRaw(array|string|null $value): static; public function setDataRaw(array|string|null $value): static;
} }
@@ -12,7 +12,7 @@ namespace KTXF\Chrono\Provider;
use KTXF\Resource\Provider\ResourceProviderBaseInterface; use KTXF\Resource\Provider\ResourceProviderBaseInterface;
/** /**
* Chrono Provider Base Interface * Provider Base Interface
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
@@ -12,11 +12,9 @@ namespace KTXF\Chrono\Provider;
use KTXF\Resource\Provider\ResourceProviderServiceMutateInterface; use KTXF\Resource\Provider\ResourceProviderServiceMutateInterface;
/** /**
* Chrono Provider Service Mutate Interface * Provider Service Mutate Interface
* *
* Optional interface for providers that support service CRUD operations. * Optional interface for providers that support service CRUD operations
*
* Implementations return ServiceMutableInterface instances (which extend ResourceServiceMutateInterface).
* *
* @since 2025.05.01 * @since 2025.05.01
* *
@@ -25,11 +23,8 @@ use KTXF\Resource\Provider\ResourceProviderServiceMutateInterface;
* @method string serviceModify(string $tenantId, ?string $userId, ServiceMutableInterface $service) Modify a chrono service configuration * @method string serviceModify(string $tenantId, ?string $userId, ServiceMutableInterface $service) Modify a chrono service configuration
* @method bool serviceDestroy(string $tenantId, ?string $userId, ServiceMutableInterface $service) Delete a chrono service configuration * @method bool serviceDestroy(string $tenantId, ?string $userId, ServiceMutableInterface $service) Delete a chrono service configuration
*/ */
interface ProviderServiceMutateInterface extends ProviderBaseInterface, ResourceProviderServiceMutateInterface { interface ProviderServiceMutateInterface extends ResourceProviderServiceMutateInterface {
public const JSON_TYPE = ProviderBaseInterface::JSON_TYPE;
// Methods inherited from ResourceProviderServiceMutateInterface
// Implementations should return/accept ServiceMutableInterface instances
// Methods inherited from ResourceProviderServiceMutateInterface
} }
@@ -10,36 +10,27 @@ declare(strict_types=1);
namespace KTXF\Chrono\Provider; namespace KTXF\Chrono\Provider;
use KTXF\Chrono\Service\ServiceBaseInterface; use KTXF\Chrono\Service\ServiceBaseInterface;
use KTXF\Chrono\Service\ServiceMutableInterface;
/** /**
* Chrono Provider Service Test Interface * Provider Service Test Interface
* *
* Optional interface for chrono providers that support testing service connections. * Optional interface for providers that support testing service connections
* Providers implementing this interface can validate connection parameters,
* test authentication, and verify service availability before creating a
* persistent service configuration.
*
* Supports two testing modes:
* 1. Testing an existing service (validate current configuration)
* 2. Testing a fresh configuration (validate before saving)
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
interface ProviderServiceTestInterface extends ProviderBaseInterface { interface ProviderServiceTestInterface {
public const CAPABILITY_SERVICE_TEST = 'ServiceTest';
/** /**
* Test a service connection * Test a service connection
* *
* Tests connectivity, authentication, and capabilities of a service. * Tests connectivity, authentication, and capabilities of a service
*
* For new services: use serviceFresh() to create a service, configure it with
* setters, then pass it to this method for testing before persisting.
*
* For existing services: fetch the service and pass it directly.
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param ServiceBaseInterface $service Service to test (can be fresh/unsaved or existing) * @param ServiceBaseInterface|ServiceMutableInterface $service Service to test (can be fresh/unsaved or existing)
* @param array $options Provider-specific test options: * @param array $options Provider-specific test options:
* - 'timeout' => int (seconds, default: 10) * - 'timeout' => int (seconds, default: 10)
* - 'verify_ssl' => bool (default: true) * - 'verify_ssl' => bool (default: true)
@@ -48,10 +39,10 @@ interface ProviderServiceTestInterface extends ProviderBaseInterface {
* *
* @return array Test results in the format: * @return array Test results in the format:
* [ * [
* 'success' => bool, * 'disposition' => 'Success' | 'Failure' | 'Warning',
* 'message' => 'Connection successful' | 'Error message' * 'message' => 'Connection successful' | 'Error message',
* ] * ]
*/ */
public function serviceTest(ServiceBaseInterface $service, array $options = []): array; public function serviceTest(ServiceBaseInterface|ServiceMutableInterface $service, array $options = []): array;
} }
@@ -9,16 +9,21 @@ declare(strict_types=1);
namespace KTXF\Chrono\Service; namespace KTXF\Chrono\Service;
use Generator;
use KTXF\Chrono\Collection\CollectionBaseInterface; use KTXF\Chrono\Collection\CollectionBaseInterface;
use KTXF\Chrono\Entity\EntityBaseInterface;
use KTXF\Resource\Delta\Delta; use KTXF\Resource\Delta\Delta;
use KTXF\Resource\Filter\IFilter; use KTXF\Resource\Filter\IFilter;
use KTXF\Resource\Identifier\EntityIdentifierInterface;
use KTXF\Resource\Provider\ResourceServiceBaseInterface; use KTXF\Resource\Provider\ResourceServiceBaseInterface;
use KTXF\Resource\Range\IRange; use KTXF\Resource\Range\IRange;
use KTXF\Resource\Range\RangeType; use KTXF\Resource\Range\RangeType;
use KTXF\Resource\Sort\ISort; use KTXF\Resource\Sort\ISort;
/** /**
* Chrono Service Base Interface * Service Base Interface
*
* Minimum interface for a service, providing read-only access to collections and entities.
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
@@ -70,7 +75,7 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
* @param IFilter|null $filter Optional filter criteria * @param IFilter|null $filter Optional filter criteria
* @param ISort|null $sort Optional sort order * @param ISort|null $sort Optional sort order
* *
* @return array<string|int,CollectionBaseInterface> Collections indexed by ID * @return array<string|int,CollectionBaseInterface> Collections indexed by identifier
*/ */
public function collectionList(string|int $location, ?IFilter $filter = null, ?ISort $sort = null): array; public function collectionList(string|int $location, ?IFilter $filter = null, ?ISort $sort = null): array;
@@ -97,9 +102,9 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int ...$identifiers Collection IDs to check * @param string|int ...$identifiers Collection identifiers to check
* *
* @return array<string|int,bool> Map of ID => exists * @return array<string|int,bool> Map of identifier => exists
*/ */
public function collectionExtant(string|int $location, string|int ...$identifiers): array; public function collectionExtant(string|int $location, string|int ...$identifiers): array;
@@ -108,29 +113,44 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $identifier Collection ID * @param string|int $identifier Collection identifier
* *
* @return CollectionBaseInterface|null Collection or null if not found * @return CollectionBaseInterface|null Collection or null if not found
*/ */
public function collectionFetch(string|int $identifier): ?CollectionBaseInterface; public function collectionFetch(string|int $identifier): ?CollectionBaseInterface;
/** /**
* Lists messages in a collection * Lists entities in a collection
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection ID * @param string|int $collection Collection identifier
* @param IFilter|null $filter Optional filter criteria * @param IFilter|null $filter Optional filter criteria
* @param ISort|null $sort Optional sort order * @param ISort|null $sort Optional sort order
* @param IRange|null $range Optional pagination * @param IRange|null $range Optional pagination
* @param array|null $properties Optional message properties to fetch * @param array|null $properties Optional entity properties to fetch
* *
* @return array<string|int,EntityBaseInterface> Messages indexed by ID * @return array<string,EntityBaseInterface> Entities indexed by Urn
*/ */
public function entityList(string|int $collection, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null, ?array $properties = null): array; public function entityListBulk(string|int $collection, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null, ?array $properties = null): array;
/** /**
* Creates a filter builder for messages * Lists entities in a collection
*
* @since 2025.05.01
*
* @param string|int $collection Collection identifier
* @param IFilter|null $filter Optional filter criteria
* @param ISort|null $sort Optional sort order
* @param IRange|null $range Optional pagination
* @param array|null $properties Optional entity properties to fetch
*
* @return Generator Yields entities one by one as EntityBaseInterface
*/
public function entityListStream(string|int $collection, ?IFilter $filter = null, ?ISort $sort = null, ?IRange $range = null, ?array $properties = null): Generator;
/**
* Creates a filter builder for entities
* *
* @since 2025.05.01 * @since 2025.05.01
* *
@@ -139,7 +159,7 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
public function entityListFilter(): IFilter; public function entityListFilter(): IFilter;
/** /**
* Creates a sort builder for messages * Creates a sort builder for entities
* *
* @since 2025.05.01 * @since 2025.05.01
* *
@@ -148,7 +168,7 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
public function entityListSort(): ISort; public function entityListSort(): ISort;
/** /**
* Creates a range builder for messages * Creates a range builder for entities
* *
* @since 2025.05.01 * @since 2025.05.01
* *
@@ -159,40 +179,49 @@ interface ServiceBaseInterface extends ResourceServiceBaseInterface {
public function entityListRange(RangeType $type): IRange; public function entityListRange(RangeType $type): IRange;
/** /**
* Gets incremental changes since last sync * Gets incremental changes since last signature
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection ID * @param string|int $collection Collection identifier
* @param string $signature Sync token from previous sync * @param string $signature Token from previous delta
* @param string $detail Detail level: 'ids', 'minimal', 'full'
* *
* @return array ['signature' => string, 'added' => array, 'modified' => array, 'removed' => array] * @return array ['signature' => string, 'added' => array, 'modified' => array, 'removed' => array]
*/ */
public function entityDelta(string|int $collection, string $signature, string $detail = 'ids'): Delta; public function entityDelta(string|int $collection, string $signature): Delta;
/** /**
* Checks if messages exist * Checks if entities exist
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection ID * @param string|int $collection Collection identifier
* @param string|int ...$identifiers Message IDs to check * @param string|int ...$identifiers Entity identifiers to check
* *
* @return array<string|int,bool> Map of ID => exists * @return array<string|int,bool> Map of identifier => exists
*/ */
public function entityExtant(string|int $collection, string|int ...$identifiers): array; public function entityExtant(string|int $collection, string|int ...$identifiers): array;
/** /**
* Fetches one or more entities * Fetches one or more entities as an array
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection ID * @param EntityIdentifierInterface ...$identifiers Entity identifiers to fetch
* @param string|int ...$identifiers Message IDs to fetch
* *
* @return array<string|int,EntityBaseInterface> Messages indexed by ID * @return array<string,EntityBaseInterface> Entities indexed by Urn
*/ */
public function entityFetch(string|int $collection, string|int ...$identifiers): array; public function entityFetchBulk(EntityIdentifierInterface ...$identifiers): array;
/**
* Fetches one or more entities as a stream
*
* @since 2025.05.01
*
* @param EntityIdentifierInterface ...$identifiers Entity identifiers to fetch
*
* @return Generator<string,EntityBaseInterface> Yields entities one by one
*/
public function entityFetchStream(EntityIdentifierInterface ...$identifiers): Generator;
} }
@@ -11,13 +11,17 @@ namespace KTXF\Chrono\Service;
use KTXF\Chrono\Collection\CollectionBaseInterface; use KTXF\Chrono\Collection\CollectionBaseInterface;
use KTXF\Chrono\Collection\CollectionMutableInterface; use KTXF\Chrono\Collection\CollectionMutableInterface;
use KTXF\Chrono\Collection\CollectionPropertiesBaseInterface;
use KTXF\Resource\Identifier\CollectionIdentifierInterface;
/** /**
* Chrono Service Collection Mutable Interface * Service Collection Mutable Interface
*
* Optional interface for services that support collection CRUD operations.
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
interface ServiceCollectionMutableInterface extends ServiceBaseInterface { interface ServiceCollectionMutableInterface {
public const CAPABILITY_COLLECTION_CREATE = 'CollectionCreate'; public const CAPABILITY_COLLECTION_CREATE = 'CollectionCreate';
public const CAPABILITY_COLLECTION_UPDATE = 'CollectionUpdate'; public const CAPABILITY_COLLECTION_UPDATE = 'CollectionUpdate';
@@ -37,37 +41,36 @@ interface ServiceCollectionMutableInterface extends ServiceBaseInterface {
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int|null $location Parent collection ID (null for root) * @param CollectionIdentifierInterface|null $target Target collection identifier (parent)
* @param CollectionMutableInterface $collection Collection to create * @param CollectionPropertiesBaseInterface $properties Collection properties
* @param array $options Protocol-specific options * @param array $options Protocol-specific options
* *
* @return CollectionBaseInterface Created collection with assigned ID * @return CollectionBaseInterface Created collection with assigned ID
*/ */
public function collectionCreate(string|int|null $location, CollectionMutableInterface $collection, array $options = []): CollectionBaseInterface; public function collectionCreate(CollectionIdentifierInterface|null $target, CollectionPropertiesBaseInterface $properties, array $options = []): CollectionBaseInterface;
/** /**
* Updates an existing collection * Updates an existing collection
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $identifier Collection ID * @param CollectionIdentifierInterface $target Target collection identifier
* @param CollectionMutableInterface $collection Updated collection data * @param CollectionPropertiesBaseInterface $properties Updated collection data
* *
* @return CollectionBaseInterface Updated collection * @return CollectionBaseInterface Updated collection
*/ */
public function collectionUpdate(string|int $identifier, CollectionMutableInterface $collection): CollectionBaseInterface; public function collectionUpdate(CollectionIdentifierInterface $target, CollectionPropertiesBaseInterface $properties): CollectionBaseInterface;
/** /**
* Deletes a collection * Deletes a collection
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $identifier Collection ID * @param CollectionIdentifierInterface $target Target collection identifier
* @param bool $force Force deletion even if not empty * @param bool $force Force deletion even if not empty
* @param bool $recursive Recursively delete contents
* *
* @return bool True if deleted * @return CollectionBaseInterface|true Collection object on soft delete, true on hard delete
*/ */
public function collectionDelete(string|int $identifier, bool $force = false, bool $recursive = false): bool; public function collectionDelete(CollectionIdentifierInterface $target, bool $force = false): CollectionBaseInterface | true;
} }
@@ -12,15 +12,12 @@ namespace KTXF\Chrono\Service;
use KTXF\Resource\Provider\ResourceServiceConfigureInterface; use KTXF\Resource\Provider\ResourceServiceConfigureInterface;
/** /**
* Chrono Service Configurable Interface * Service Configurable Interface
* *
* Extends base service interface with setter methods for mutable properties. * Extends base service interface with setter methods for mutable properties
* Used for service configuration and updates.
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
interface ServiceConfigurableInterface extends ServiceMutableInterface, ResourceServiceConfigureInterface { interface ServiceConfigurableInterface extends ServiceMutableInterface, ResourceServiceConfigureInterface {
public const JSON_TYPE = ServiceBaseInterface::JSON_TYPE;
} }
@@ -11,19 +11,21 @@ namespace KTXF\Chrono\Service;
use KTXF\Chrono\Entity\EntityBaseInterface; use KTXF\Chrono\Entity\EntityBaseInterface;
use KTXF\Chrono\Entity\EntityMutableInterface; use KTXF\Chrono\Entity\EntityMutableInterface;
use KTXF\Chrono\Entity\EntityPropertiesMutableInterface;
use KTXF\Resource\Identifier\CollectionIdentifierInterface;
use KTXF\Resource\Identifier\EntityIdentifierInterface;
/** /**
* Chrono Service Entity Mutable Interface * Service Entity Mutable Interface
* *
* Optional interface for services that support entity CRUD operations. * Optional interface for services that support entity CRUD operations
* Provides entity creation, modification, deletion, copying, moving, and flag management.
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
interface ServiceEntityMutableInterface extends ServiceBaseInterface { interface ServiceEntityMutableInterface {
public const CAPABILITY_ENTITY_CREATE = 'EntityCreate'; public const CAPABILITY_ENTITY_CREATE = 'EntityCreate';
public const CAPABILITY_ENTITY_UPDATE = 'EntityUpdate'; public const CAPABILITY_ENTITY_MODIFY = 'EntityModify';
public const CAPABILITY_ENTITY_DELETE = 'EntityDelete'; public const CAPABILITY_ENTITY_DELETE = 'EntityDelete';
public const CAPABILITY_ENTITY_COPY = 'EntityCopy'; public const CAPABILITY_ENTITY_COPY = 'EntityCopy';
public const CAPABILITY_ENTITY_MOVE = 'EntityMove'; public const CAPABILITY_ENTITY_MOVE = 'EntityMove';
@@ -42,36 +44,71 @@ interface ServiceEntityMutableInterface extends ServiceBaseInterface {
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection collection identifier * @param CollectionIdentifierInterface $target Target collection identifier
* @param EntityMutableInterface $entity Entity data * @param EntityPropertiesMutableInterface $properties Entity properties
* @param array $options additional options * @param array $options Additional options
* *
* @return EntityBaseInterface Created entity * @return EntityBaseInterface Created entity
*/ */
public function entityCreate(string|int $collection, EntityMutableInterface $entity, array $options = []): EntityBaseInterface; public function entityCreate(CollectionIdentifierInterface $target, EntityPropertiesMutableInterface $properties, array $options = []): EntityBaseInterface;
/** /**
* Modifies an existing entity * Modifies an existing entity
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection identifier * @param EntityIdentifierInterface $target Target entity identifier
* @param string|int $identifier Entity identifier * @param EntityPropertiesMutableInterface $properties Entity properties to update
* @param EntityMutableInterface $entity Entity data
* *
* @return EntityBaseInterface Modified entity * @return EntityBaseInterface Modified entity
*/ */
public function entityUpdate(string|int $collection, string|int $identifier, EntityMutableInterface $entity): EntityBaseInterface; public function entityModify(EntityIdentifierInterface $target, EntityPropertiesMutableInterface $properties): EntityBaseInterface;
/** /**
* Deletes an existing entity in the specified collection * Deletes entities
*
* @since 2026.04.01
*
* @param EntityIdentifierInterface ...$targets Source entities to delete
*
* @return array<string, array{
* disposition: 'moved'|'deleted'|'error',
* destination: ?CollectionIdentifierInterface,
* mutation: EntityIdentifierInterface
* }> Results keyed by source entity identifier
*/
public function entityDelete(EntityIdentifierInterface ...$targets): array;
/**
* Moves entities to another collection
*
* @since 2025.05.01
*
* @param CollectionIdentifierInterface $target Target collection identifier
* @param EntityIdentifierInterface ...$sources Source entities to move
*
* @return array<string, array{
* disposition: 'moved'|'error',
* destination: ?CollectionIdentifierInterface,
* mutation: EntityIdentifierInterface
* }> Results keyed by source entity identifier
*/
public function entityMove(CollectionIdentifierInterface $target, EntityIdentifierInterface ...$sources): array;
/**
* Copies entities to another collection
* *
* @since 2025.05.01 * @since 2025.05.01
* *
* @param string|int $collection Collection identifier * @param CollectionIdentifierInterface $target Target collection identifier
* @param string|int $identifier Entity identifier to delete * @param EntityIdentifierInterface ...$sources Source entities to copy
* *
* @return EntityBaseInterface Deleted entity * @return array<string, array{
* disposition: 'copied'|'error',
* destination: ?CollectionIdentifierInterface,
* mutation: EntityIdentifierInterface
* }> Results keyed by source entity identifier
*/ */
public function entityDelete(string|int $collection, string|int $identifier): EntityBaseInterface; public function entityCopy(CollectionIdentifierInterface $target, EntityIdentifierInterface ...$sources): array;
} }
@@ -12,11 +12,10 @@ namespace KTXF\Chrono\Service;
/** /**
* Chrono Service Mutable Interface * Chrono Service Mutable Interface
* *
* Extends base service interface with setter methods for mutable properties. * Extends base service interface with setter methods for mutable properties
* Used for service configuration and updates.
* *
* @since 2025.05.01 * @since 2025.05.01
*/ */
interface ServiceMutableInterface extends ServiceBaseInterface { interface ServiceMutableInterface {
} }