phil / organizations-bundle
Organizations in a Symfony application: members, roles, teams and invitations, and acting on behalf of an organization with the real author recorded.
Package info
github.com/parler-haut-interagir-librement/organizations-bundle
Type:symfony-bundle
pkg:composer/phil/organizations-bundle
Requires
- php: >=8.5
- ext-filter: *
- ext-mbstring: *
- doctrine/dbal: ^4.5
- phil/access-links: ^0.1@dev || ^0.2@dev
- phil/slug: ^0.1@dev
- psr/clock: ^1.0
- psr/event-dispatcher: ^1.0
- symfony/config: ^8.2
- symfony/dependency-injection: ^8.2
- symfony/service-contracts: ^3.6
- symfony/uid: ^8.2
Requires (Dev)
- doctrine/orm: ^3.7
- phil/access-bundle: ^0.2@dev
- phil/privacy-bundle: ^0.1@dev
- phil/resource: ^0.1@dev
- phil/resource-permissions: ^0.2@dev
- phpunit/phpunit: ^13.4
- symfony/clock: ^8.2
- symfony/console: ^8.2
- symfony/event-dispatcher: ^8.2
- symfony/security-core: ^8.2
Suggests
- doctrine/orm: To add the tables to the schema the ORM generates, for doctrine:migrations:diff
- phil/access-bundle: To publish memberships and roles as relations and tuples, partitioned by tenant
- phil/privacy-bundle: For the exporter and eraser of a member's personal data
- symfony/console: For phil:organizations:list, show, check-owners and purge-invitations
- symfony/security-core: For the voter of the organization permissions and roles
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-19 00:45:51 UTC
README
Organizations for Symfony, for anyone building their own identity and access service: members, roles and their permissions, the last owner kept, teams, invitations, joining by a verified domain and acting on behalf of an organization.
phil/organizations-bundle keeps organizations and their members. A member is named by the opaque subject identifier of
the application's user provider — a ULID, a UUID, the sub of an OpenID Connect provider —, never an email address,
so the bundle works with any user provider. Each membership holds one or more roles: owner, admin and
member are built in, and the configuration declares others and the permissions of each — permissions are
configuration, the roles each member holds are data. A member who manages members grants, changes or removes only roles
whose permissions they hold themselves, and the last owner can never leave, be removed or lose the owner role, so
an organization always has someone who may grant and revoke; at least two owners are recommended, and a command lists
the organizations below that.
An organization has teams, each with roles of its own — maintainer and member built in, others declared. It is
active or archived, read only until it is restored. Members join by being added, by invitations limited in time
and in uses that carry roles — their tokens kept only as a keyed hash, each use counted by one conditional write whose
row count is checked —, or, when the configuration turns it on, by the email domain the organization verified. A
member may act on behalf of the organization: the organization is shown as the author, and an event records the
real one beside it, for an audit trail.
Every change runs in one transaction and its events are dispatched once it is committed, with identifiers only.
OrganizationVoter answers is_granted('organization:<permission>', $organization) and
is_granted('organization_role:<role>', $organization). With phil/privacy-bundle, an exporter and an eraser answer
a member's access and erasure requests; with phil/access-bundle, memberships and roles are published as relations
and tuples of phil/resource-permissions, in the partition of the active tenant.
It is a Symfony bundle on Doctrine DBAL, phil/slug, phil/access-links, PSR-14 and PSR-20; the console, Symfony
Security, Doctrine ORM, phil/privacy-bundle and phil/access-bundle are optional. The organizations live in six
tables on SQLite, MySQL, MariaDB or PostgreSQL, every identifier and key column compared byte for byte, tested on
MySQL 8.4 and PostgreSQL 17; a store in memory serves the tests. Its services keep no state between requests and serve a
long-running worker. It ships no pages: the application draws its screens with the recipes of the PHIL UX kit.
Status
| Part | State |
|---|---|
Organizations: name, slug made by phil/slug or given, active or archived, verified email domain |
Implemented and tested |
| Memberships by opaque subject identifier, built-in and declared roles, permissions from configuration, grants bounded by the actor's own permissions | Implemented and tested |
| The last owner kept, the organization locked during each change; the recommendation of two owners and its check | Implemented and tested |
| Teams with their own roles, managed by the organization's team managers or the team's maintainers | Implemented and tested |
| Invitations limited in time and uses, carrying roles, tokens kept hashed under rotating keys, each use atomic, revocable, refused when their creator may no longer grant their roles | Implemented and tested |
| Joining by a verified email domain, off by default | Implemented and tested |
| Acting on behalf of an organization, the real author recorded | Implemented and tested |
| Domain events dispatched after commit, identifiers only | Implemented and tested |
OrganizationVoter for permissions and roles |
Implemented and tested |
| Doctrine DBAL store on SQLite, MySQL and PostgreSQL, binary collation on key columns, schema listener; store in memory | Implemented and tested |
| Commands to list, show, check the owners and purge invitations | Implemented and tested |
Exporter and eraser for phil/privacy-bundle; relations and tuples for phil/access-bundle, partitioned by tenant |
Implemented and tested |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, installing, the key of the invitations, the tables. |
| Configuration | Every option, with an example. |
| Members and roles | Members, built-in and declared roles, permissions, the bound on grants, owners, archiving. |
| Teams | Teams, their roles, who manages them. |
| Invitations | Creating, accepting, revoking and purging invitations; joining by a verified domain. |
| Acting on behalf | Acting as the organization while the real author is recorded. |
| Events | Every event, when it is dispatched and what it carries. |
| Integrations | The voter, phil/privacy-bundle, phil/access-bundle, phil/audit-bundle. |
| Console | The four commands. |
| Security notes | What the bundle defends against, and what it leaves to the application. |
| Extension points | The services to replace, the contracts to implement, and when they are stable. |
| Testing | The bundle's tests, the servers its integration tests read, and how to test an application. |
| Reference | Every public type and service of the bundle. |
Quick start
// config/bundles.php Phil\OrganizationsBundle\PhilOrganizationsBundle::class => ['all' => true],
# config/packages/phil_organizations.yaml phil_organizations: invitations: hash_key: '%env(ORGANIZATIONS_INVITATION_KEY)%' roles: billing: { permissions: [billing.read, billing.pay] }
$acme = $organizations->create('Acme Guild', MemberId::fromString($user->id)); // its creator owns it $members->add($acme->id, $owner, MemberId::fromString($other->id), ['admin']); $issued = $invitations->create($acme->id, $owner, ['member'], maxUses: 5); // $issued->token, shown once $invitations->accept($token, MemberId::fromString($newcomer->id));
{% if is_granted('organization:members.invite', organization) %}…{% endif %}
Requirements
PHP 8.5 or later with ext-filter and ext-mbstring, Symfony 8.2 or later, Doctrine DBAL 4.5 or later.
Contributing
Contributions are welcome on the PHIL monorepo: read the contribution guide and the code of conduct. Report a vulnerability privately, as the security policy explains, never in a public issue.
License
MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. See LICENSE.