Skip to content

Docs_Service_Settings

@api · extends Tiger_Service_Service

Docs_Service_Settings — /api service for the Docs settings screen.

Validates Docs_Form_Settings, then writes the public route override to the DB config table (scope=global) via Tiger_Model_Config as tiger.routing.override.docs.* — the live-override tier, effective next request, no deploy. Tiger_Routing_Overrides reads exactly these keys. ACL: admin+ (configs/acl.ini).

Methods

save()

save(array $params): void

Validate the settings form and persist the public route override to config.

  • $params array — the submitted Docs_Form_Settings values

rebuild()

rebuild(array $params): void

Force a rebuild of THIS server's docs index cache. Handy on a single box or to warm after editing content; in a multi-server fleet it rebuilds only the node that handled the request (the others self-heal on their own next content change), so warm each server at deploy.

  • $params array — the request payload (unused)

buildReference()

buildReference(array $params): void

Rebuild this server's generated API reference (docblocks → tiger:doc pages) into var/docs-generated — the platform reference collection + a Reference section per module — then refresh the index so it shows. Same work as the bin/build-reference.php deploy hook, as an admin button. Per-server, like the index rebuild; generated docs are never committed.

  • $params array — the request payload (unused)