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

refactor: people provider
All checks were successful
JS Unit Tests / test (pull_request) Successful in 16s
Details
Build Test / build (pull_request) Successful in 18s
Details
PHP Unit Tests / test (pull_request) Successful in 56s
Details

Browse Source 
Signed-off-by: Sebastian Krupinski <krupinski01@gmail.com>
This commit is contained in:
Sebastian Krupinski
2026-02-25 00:13:51 -05:00
parent 7799787ffb
commit e48ee82530
41 changed files with 1091 additions and 984 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
shared/lib/People/Collection/CollectionBaseAbstract.php Normal file
View File

@@ -0,0 +1,31 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodeBaseAbstract;
/**
* Abstract Collection Base Class
*
* Provides common implementation for collections
*
* @since 2025.05.01
*/
abstract class CollectionBase extends NodeBaseAbstract implements CollectionBaseInterface {
protected CollectionPropertiesBaseAbstract $properties;
/**
* @inheritDoc
*/
public function getProperties(): CollectionPropertiesBaseInterface {
return $this->properties;
}
}

30
shared/lib/People/Collection/CollectionBaseInterface.php Normal file
View File

@@ -0,0 +1,30 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodeBaseInterface;
/**
* Collection Base Interface
*
* Interface represents a collection in a service
*
* @since 2025.05.01
*/
interface CollectionBaseInterface extends NodeBaseInterface {
/**
* Gets the collection properties
*
* @since 2025.05.01
*/
public function getProperties(): CollectionPropertiesBaseInterface|CollectionPropertiesMutableInterface;
}

50
shared/lib/People/Collection/CollectionMutableAbstract.php Normal file
View File

@@ -0,0 +1,50 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodeMutableAbstract;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
/**
* Abstract Collection Mutable Class
*
* Provides common implementation for mutable collections
*
* @since 2025.05.01
*/
abstract class CollectionMutableAbstract extends NodeMutableAbstract implements CollectionMutableInterface {
protected CollectionPropertiesMutableAbstract $properties;
/**
* @inheritDoc
*/
public function getProperties(): CollectionPropertiesMutableInterface {
return $this->properties;
}
/**
* @inheritDoc
*/
public function setProperties(NodePropertiesMutableInterface $value): static {
if (!$value instanceof CollectionPropertiesMutableInterface) {
throw new \InvalidArgumentException('Properties must implement CollectionPropertiesMutableInterface');
}
// Copy all property values
$this->properties->setLabel($value->getLabel());
$this->properties->setDescription($value->getDescription());
$this->properties->setPriority($value->getPriority());
$this->properties->setVisibility($value->getVisibility());
$this->properties->setColor($value->getColor());
return $this;
}
}

32
shared/lib/People/Collection/CollectionMutableInterface.php Normal file
View File

@@ -0,0 +1,32 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodeMutableInterface;
/**
* Collection Mutable Interface
*
* Interface for altering collection properties in a service
*
* @since 2025.05.01
*
* @method static setProperties(CollectionPropertiesMutableInterface $value)
*/
interface CollectionMutableInterface extends CollectionBaseInterface, NodeMutableInterface {
/**
* Gets the collection properties (mutable)
*
* @since 2025.05.01
*/
public function getProperties(): CollectionPropertiesMutableInterface;
}

26
shared/lib/People/Collection/CollectionPermissions.php
View File

@@ -1,26 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use JsonSerializable;
enum CollectionPermissions: string implements JsonSerializable {
case View = 'view';
case Create = 'create';
case Modify = 'modify';
case Destroy = 'destroy';
case Share = 'share';
public function jsonSerialize(): string {
return $this->value;
}
}

74
shared/lib/People/Collection/CollectionPropertiesBaseAbstract.php Normal file
View File

@@ -0,0 +1,74 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodePropertiesBaseAbstract;
/**
* Abstract Collection Properties Base Class
*
* Provides common implementation for collection properties
*
* @since 2025.05.01
*/
abstract class CollectionPropertiesBaseAbstract extends NodePropertiesBaseAbstract implements CollectionPropertiesBaseInterface {
public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
/**
* @inheritDoc
*/
public function content(): array {
$content = $this->data[self::JSON_PROPERTY_CONTENT] ?? null;
if (is_array($content)) {
return array_map(function ($item) {
return new CollectionContent($item);
}, $content);
} else {
return [];
}
}
/**
* @inheritDoc
*/
public function getLabel(): string {
return $this->data[self::JSON_PROPERTY_LABEL] ?? '';
}
/**
* @inheritDoc
*/
public function getDescription(): ?string {
return $this->data[self::JSON_PROPERTY_DESCRIPTION] ?? null;
}
/**
* @inheritDoc
*/
public function getPriority(): ?int {
return $this->data[self::JSON_PROPERTY_PRIORITY] ?? null;
}
/**
* @inheritDoc
*/
public function getVisibility(): ?bool {
return $this->data[self::JSON_PROPERTY_VISIBILITY] ?? null;
}
/**
* @inheritDoc
*/
public function getColor(): ?string {
return $this->data[self::JSON_PROPERTY_COLOR] ?? null;
}
}

70
shared/lib/People/Collection/CollectionPropertiesBaseInterface.php Normal file
View File

@@ -0,0 +1,70 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use KTXF\Resource\Provider\Node\NodePropertiesBaseInterface;
use PhpParser\Node\Expr\Array_;
interface CollectionPropertiesBaseInterface extends NodePropertiesBaseInterface {
public const JSON_TYPE = 'people:collection';
public const JSON_PROPERTY_CONTENT = 'content';
public const JSON_PROPERTY_LABEL = 'label';
public const JSON_PROPERTY_DESCRIPTION = 'description';
public const JSON_PROPERTY_PRIORITY = 'priority';
public const JSON_PROPERTY_VISIBILITY = 'visibility';
public const JSON_PROPERTY_COLOR = 'color';
/**
* 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)
*
* @since 2025.05.01
*/
public function getLabel(): string;
/**
* Gets the human friendly description of this collection
*
* @since 2025.05.01
*/
public function getDescription(): ?string;
/**
* Gets the priority of this collection
*
* @since 2025.05.01
*/
public function getPriority(): ?int;
/**
* Gets the visibility of this collection
*
* @since 2025.05.01
*/
public function getVisibility(): ?bool;
/**
* Gets the color of this collection
*
* @since 2025.05.01
*/
public function getColor(): ?string;
}

72
shared/lib/People/Collection/CollectionPropertiesMutableAbstract.php Normal file
View File

@@ -0,0 +1,72 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
/**
* Abstract Collection Properties Mutable Class
*/
abstract class CollectionPropertiesMutableAbstract extends CollectionPropertiesBaseAbstract implements CollectionPropertiesMutableInterface {
public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
/**
* @inheritDoc
*/
public function jsonDeserialize(array|string $data): static {
if (is_string($data)) {
$data = json_decode($data, true);
}
$this->data = $data;
return $this;
}
/**
* @inheritDoc
*/
public function setLabel(string $value): static {
$this->data[self::JSON_PROPERTY_LABEL] = $value;
return $this;
}
/**
* @inheritDoc
*/
public function setDescription(?string $value): static {
$this->data[self::JSON_PROPERTY_DESCRIPTION] = $value;
return $this;
}
/**
* @inheritDoc
*/
public function setPriority(?int $value): static {
$this->data[self::JSON_PROPERTY_PRIORITY] = $value;
return $this;
}
/**
* @inheritDoc
*/
public function setVisibility(?bool $value): static {
$this->data[self::JSON_PROPERTY_VISIBILITY] = $value;
return $this;
}
/**
* @inheritDoc
*/
public function setColor(?string $value): static {
$this->data[self::JSON_PROPERTY_COLOR] = $value;
return $this;
}
}

25
shared/lib/People/Collection/ICollectionMutable.php → shared/lib/People/Collection/CollectionPropertiesMutableInterface.php
View File

@@ -9,50 +9,45 @@ declare(strict_types=1);
namespace KTXF\People\Collection;
use KTXF\Json\JsonDeserializable;
use KTXF\Resource\Provider\Node\NodePropertiesMutableInterface;
interface ICollectionMutable extends ICollectionBase, JsonDeserializable {
interface CollectionPropertiesMutableInterface extends NodePropertiesMutableInterface {
public const JSON_TYPE = CollectionPropertiesBaseInterface::JSON_TYPE;
/**
* Sets the active status of this collection
* Sets the human friendly name of this collection (e.g. Personal Calendar)
*
* @since 2025.05.01
*/
public function setEnabled(bool $value): self;
/**
* Sets the human friendly name of this collection (e.g. Personal Contacts)
*
* @since 2025.05.01
*/
public function setLabel(string $value): self;
public function setLabel(string $value): static;
/**
* Sets the human friendly description of this collection
*
* @since 2025.05.01
*/
public function setDescription(?string $value): self;
public function setDescription(?string $value): static;
/**
* Sets the priority of this collection
*
* @since 2025.05.01
*/
public function setPriority(?int $value): self;
public function setPriority(?int $value): static;
/**
* Sets the visibility of this collection
*
* @since 2025.05.01
*/
public function setVisibility(?bool $value): self;
public function setVisibility(?bool $value): static;
/**
* Sets the color of this collection
*
* @since 2025.05.01
*/
public function setColor(?string $value): self;
public function setColor(?string $value): static;
}

24
shared/lib/People/Collection/CollectionRoles.php
View File

@@ -1,24 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use JsonSerializable;
enum CollectionRoles: string implements JsonSerializable {
case System = 'system';
case Individual = 'individual';
case Recent = 'recent';
public function jsonSerialize(): string {
return $this->value;
}
}

160
shared/lib/People/Collection/ICollectionBase.php
View File

@@ -1,160 +0,0 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: Sebastian Krupinski <krupinski01@gmail.com>
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace KTXF\People\Collection;
use DateTimeImmutable;
use JsonSerializable;
interface ICollectionBase extends JsonSerializable {
public const JSON_TYPE = 'people.collection';
public const JSON_PROPERTY_TYPE = '@type';
public const JSON_PROPERTY_PROVIDER = 'provider';
public const JSON_PROPERTY_SERVICE = 'service';
public const JSON_PROPERTY_IN = 'in';
public const JSON_PROPERTY_ID = 'id';
public const JSON_PROPERTY_LABEL = 'label';
public const JSON_PROPERTY_DESCRIPTION = 'description';
public const JSON_PROPERTY_PRIORITY = 'priority';
public const JSON_PROPERTY_VISIBILITY = 'visibility';
public const JSON_PROPERTY_COLOR = 'color';
public const JSON_PROPERTY_CREATED = 'created';
public const JSON_PROPERTY_MODIFIED = 'modified';
public const JSON_PROPERTY_ENABLED = 'enabled';
public const JSON_PROPERTY_SIGNATURE = 'signature';
public const JSON_PROPERTY_PERMISSIONS = 'permissions';
public const JSON_PROPERTY_ROLES = 'roles';
public const JSON_PROPERTY_CONTENTS = 'contents';
/**
* Unique identifier of the service this collection belongs to
*
* @since 2025.05.01
*/
public function in(): string|int|null;
/**
* Unique arbitrary text string identifying this service (e.g. 1 or collection1 or anything else)
*
* @since 2025.05.01
*/
public function id(): string|int;
/**
* Gets the creation date of this collection
*/
public function created(): ?DateTimeImmutable;
/**
* Gets the modification date of this collection
*/
public function modified(): ?DateTimeImmutable;
/**
* Lists all supported attributes
*
* @since 2025.05.01
*
* @return array<string,array<string,bool>>
*/
public function attributes(): array;
/**
* Gets the signature of this collection
*
* @since 2025.05.01
*/
public function signature(): ?string;
/**
* Gets the role(s) of this collection
*
* @since 2025.05.01
*/
public function roles(): array;
/**
* Checks if this collection supports the given role
*
* @since 2025.05.01
*/
public function role(CollectionRoles $value): bool;
/**
* Gets the content types of this collection
*
* @since 2025.05.01
*/
public function contents(): array;
/**
* Checks if this collection contains the given content type
*
* @since 2025.05.01
*/
public function contains(CollectionContent $value): bool;
/**
* Gets the active status of this collection
*
* @since 2025.05.01
*/
public function getEnabled(): bool;
/**
* Gets the active status of this collection
*
* @since 2025.05.01
*/
public function getPermissions(): array;
/**
* Checks if this collection has the given permission
*
* @since 2025.05.01
*/
public function hasPermission(CollectionPermissions $permission): bool;
/**
* Gets the human friendly name of this collection (e.g. Personal Contacts)
*
* @since 2025.05.01
*/
public function getLabel(): ?string;
/**
* Gets the human friendly description of this collection
*
* @since 2025.05.01
*/
public function getDescription(): ?string;
/**
* Gets the priority of this collection
*
* @since 2025.05.01
*/
public function getPriority(): ?int;
/**
* Gets the visibility of this collection
*
* @since 2025.05.01
*/
public function getVisibility(): ?bool;
/**
* Gets the color of this collection
*
* @since 2025.05.01
*/
public function getColor(): ?string;
}