waaseyaa/groups

Multi-bundle Group content entity type for Waaseyaa (group + group_type; app-defined bundles)

Maintainers

Package info

github.com/waaseyaa/groups

pkg:composer/waaseyaa/groups

Transparency log

Statistics

Installs: 2 043

Dependents: 3

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v0.1.0-alpha.266 2026-07-15 18:19 UTC

Requires

Requires (Dev)

GPL-2.0-or-later f57b80424a85de64e7b19c6ec79de86833df4501

Published on Packagist.org on 2026-07-15 18:29 UTC

This package is auto-updated.

Last update: 2026-07-15 18:29:35 UTC

README

Layer 2 — Content Types

Multi-bundle group content entity type for Waaseyaa applications. The package defines two entity types — group (the bundle-aware content entity, keyed by gid/uuid, labeled by name, partitioned by type) and group_type (the config entity that declares bundle identities) — and ships with zero pre-registered bundles and zero bundle-scoped fields. Consuming applications declare their own GroupType bundles and register bundle-scoped fields; those field values land in per-bundle subtables named group__{bundle}, while the core keys plus the FieldStorage::Data universals (status, created_at, updated_at) live on the base group table. The package is framework-agnostic: it targets no single product domain. See docs/specs/bundle-scoped-storage.md.

API exposure

group and group_type deliberately opt in to the generic JSON:API surface and appear in authenticated API discovery. GroupAccessPolicy gates create, view, update, and delete operations on both types with the administer groups permission. Accounts without that permission receive no grant from the groups package policy and are denied for those operations.

Install

Ships as part of waaseyaa/framework — consumers of the metapackage already have it. To depend on it directly:

composer require waaseyaa/groups

The GroupsServiceProvider is auto-discovered via extra.waaseyaa.providers; no manual wiring is required.

Key API

Group (extends ContentEntityBase)

The group content entity. Entity keys: id -> gid, uuid, bundle -> type, label -> name, langcode.

public function __construct(
    array $values = [],
    string $entityTypeId = '',
    array $entityKeys = [],
    array $fieldDefinitions = [],
);
public function getName(): string;          // alias for label()
public function setName(string $name): static;
public function getGroupTypeId(): string;   // the group_type bundle id (bundle())

GroupType (extends ConfigEntityBase)

Config entity declaring a single bundle (e.g. 'business', 'organization'). Holds bundle identity plus a description; bundle-scoped field definitions are registered separately. Entity keys: id, label.

public function __construct(array $values = [], string $entityTypeId = '', array $entityKeys = []);
public function getLabel(): string;
public function getDescription(): string;
public function setDescription(string $description): static;

GroupsServiceProvider (extends ServiceProvider)

Registers the group content entity type (via EntityType::fromClass) and the group_type config entity type.

public function register(): void;

Register bundle-scoped fields against the group entity type through the framework's EntityTypeManager:

public function addBundleFields(string $entityTypeId, string $bundle, array $fields): void;

Usage

Declare a bundle's fields, then create and persist a group in that bundle. Bundle-scoped values route to group__{bundle} automatically.

// 1. Register fields for the 'business' bundle (grounded in TwoBundleCoexistenceTest).
$entityTypeManager->addBundleFields('group', 'business', [
    new FieldDefinition(
        name: 'email',
        type: 'string',
        targetEntityTypeId: 'group',
        targetBundle: 'business',
    ),
]);

// 2. Materialize the schema (creates `group` + `group__business`).
//    The framework runs this on the next install / schema pass.

// 3. Create and save a group in that bundle.
$group = $storage->create([
    'uuid'     => 'a1b2...',
    'type'     => 'business',
    'name'     => 'Acme Co.',
    'langcode' => 'en',
    'email'    => 'hello@acme.example',
]);
$storage->save($group);

$loaded = $storage->load($group->id());
$loaded->get('email');   // 'hello@acme.example' — merged back from group__business

Querying a field that exists in more than one bundle without a type constraint raises BundleAmbiguousFieldException — narrow with ->condition('type', 'business'). Registered-but-unmaterialized bundle subtables are reported by waaseyaa health:check as MISSING_BUNDLE_SUBTABLE.

Key classes: Group, GroupType, GroupsServiceProvider.