API / Minn\Admin / BundleController

BundleController final readonly class

Minn\Admin\BundleController · public/minn/src/Minn/Admin/BundleController.php · 45 lines

What the app bundle answers for: the user guide it carries, the translation offers (none: the engine polls no translation channel), and the two changelogs, Minn Admin's and the engine's, read from GitHub because a release carries neither.

Uses 10

App Http\Access Http\Method Http\Policy Http\Request Http\Response Http\Route Ops\Changelog Rest\Caller Rest\Reply

Used by 1

Rest\Api

Constants and properties

private	`readonly Minn\Admin\App $app`	Promoted from the constructor.
private	`readonly Minn\Rest\Caller $caller`	Promoted from the constructor.
private	`readonly Minn\Ops\Changelog $adminChangelog`	Promoted from the constructor.
private	`readonly Minn\Ops\Changelog $engineChangelog`	Promoted from the constructor.

Public

new	`__construct(Minn\Admin\App $app, Minn\Rest\Caller $caller, Minn\Ops\Changelog $adminChangelog, Minn\Ops\Changelog $engineChangelog)`#
method	`translations(Minn\Http\Request $request): Minn\Http\Response`GET /minn-admin/v1/translations (floor edit_posts)#	The translation offers; none on the engine.
method	`changelog(Minn\Http\Request $request): Minn\Http\Response`GET /minn-admin/v1/changelog (floor edit_posts)#	Minn Admin's changelog, released sections only, beside the bundle's version.
method	`engineChangelog(Minn\Http\Request $request): Minn\Http\Response`GET /minn-admin/v1/engine-changelog (floor edit_posts)#	The engine's own changelog, kept in its repository and not in a release, shown beside the app's on Minn.
method	`guide(Minn\Http\Request $request): Minn\Http\Response`GET /minn-admin/v1/guide (floor edit_posts)#	The app's bundled user guide.

Internals 1

Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.

private

bundled(string $relative): array#

@return array{version: string, markdown: string}