verdigado-public/organization_folders
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

started describing function signatures of organization providers

Browse source
This commit is contained in:
Jonathan Treffler 2024-08-22 15:08:54 +02:00 committed by Jonathan Treffler
parent f9ad16c3fe
commit 351c24dbdd
1 changed files with 33 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
lib/OrganisationProvider/OrganisationProvider.php
View file

@ -11,5 +11,37 @@ abstract class OrganizationProvider {
return $this->id;
}
// TODO: functions to access organisation structure
/* Return one level of the Organization Tree */
/*
* ┌────────────────────────────┐
* │ Root Node │
* │ (of Organization Provider) │
* └──┬──────────────────────┬──┘
* │ │
* │ │
* ┌── ── ── │── ── ── ── ── ── ── ─│─ ── ── ─┐
* │ │
* │ ▼ ▼ │
* ┌──────────────┐ ┌──────────────┐
* │ │ │ │ │ │
* │Organization 1│ │Organization 2│ ◄── ── ── getOrganizations();
* │ │ │ │ │ │
* └┬────────────┬┘ └┬────────────┬┘
* │ │ │ │ │ │
* │ │ │ │
* └── ├─ ── ── ── ─┤ ── ── ─┼ ── ── ── ──│── ┘
* │ │ │ │
* ▼ ▼ │ │
* ... ... ▼ ▼
* ┌── ── ── ── ── ── ── ── ── ── ─┐
* ┌────────────┐ ┌────────────┐
* │ │ │ │ │ │
* │ Suborg. 21 │ │ Suborg. 22 │ ◄── ── ── getOrganizations(2);
* │ │ │ │ │ │
* └────────────┘ └────────────┘
* └── ── ── ── ── ── ── ── ── ── ─┘
*/
abstract public function getOrganizations(?int $parentOrganizationId);
abstract public function getRolesOfOrganization(int $organizationId);
}