Back to User Guides
Contents
User Guides
505 words
Jun 25, 2026

Heratio Help Center article. Category: Administration / Developer Reference.

Functions and Code Catalogue

The Functions and Code Catalogue is a read-only, in-app reference browser for Heratio's own codebase. It lets administrators and developers browse and search auto-generated catalogues of the platform's PHP classes and methods, HTTP routes, Blade templates, JavaScript modules, and Python helpers. It is a developer and operator reference, not an archival or data-entry tool.

Overview

Heratio maintains five catalogues of its callable code, regenerated automatically on a schedule. The Functions and Code Catalogue displays them inside the admin area so you can look up a class, method, route, or template without leaving the application.

The five catalogues are:

  • PHP classes and methods, with signatures and locations.
  • Routes, listing each HTTP method, path, middleware, and action.
  • Blade templates.
  • JavaScript modules.
  • Python helpers.

The pages read the latest generated catalogue on each request, so the content stays close to current as the codebase evolves. Nothing here is editable; it is a browsing surface only.

Key features

Feature Description
Five catalogues PHP, Routes, Blade, JavaScript, and Python in one place.
Index summary Each catalogue card shows its size, last-updated time, and number of sections.
Search and filter Filter a catalogue by a case-insensitive substring on section titles.
Pagination Large catalogues (PHP, Blade, Routes) are paginated; smaller ones show on a single page.
Table of contents Each page shows a table of contents for the sections it lists.
Always current Catalogues are read fresh on each request and refreshed automatically in the background.

How to use

Access is restricted to administrators. There is no menu link; navigate directly to the catalogue index.

  1. Go to /docs/functions. This lists all five catalogues with their size, last-updated time, and section count, and whether each is currently available.
  2. Click a catalogue to open it, for example:
    • /docs/functions/php for PHP classes and methods.
    • /docs/functions/routes for HTTP routes.
    • /docs/functions/blade for Blade templates.
    • /docs/functions/js for JavaScript modules.
    • /docs/functions/py for Python helpers.
  3. To search within a catalogue, add a query term, for example /docs/functions/php?q=Actor. The filter matches section titles (class names, route paths, template paths, and similar), ignoring case.
  4. To move through a large catalogue, use the page links or add a page number, for example /docs/functions/routes?page=2.
  5. Use the table of contents on each page to jump straight to a section.

If a catalogue's source has not been generated yet or cannot be read, the page shows a short notice instead of content; it will appear once the next background refresh completes.

Configuration

  • No setup is required. The catalogues are generated by scheduled background tasks on the server and are read automatically.
  • Access control: all catalogue pages are restricted to administrators.
  • Caching: parsed catalogue sections are cached briefly and the cache invalidates automatically when a catalogue is regenerated, so you always see current content without manual refreshing.
  • No database: this feature stores nothing of its own; it reads generated reference files.

References

  • Source: packages/ahg-functions-docs/
  • Issue: GH #575