winzik/docs/ide/php.md
David Nurdin 7de153fc14 IDE documentation: one page per feature (docs/ide/, French in docs/ide/fr/) and a Doc browser inside the IDE
- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases,
  Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list;
  15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them.
- The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool
  window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables,
  links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback.
- ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked);
  the packaged copy ui/docs first, else the repository's docs/ide.
- Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php
  puts them in code updates, bin/jumphp ide syncs them.
- Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest
  (path traversal refused), the i18n test covers the new texts in 14 languages.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 00:08:42 +01:00

31 lines
1.7 KiB
Markdown

# PHP code intelligence
The IDE analyses every PHP file of the project (and the libraries of `vendor/` when needed) with nikic/php-parser, a little at each
frame, and keeps a cache: the index is ready a few seconds after a project opens. **Tools > Rebuild the PHP Index** starts again.
## Completion
Completion follows types: `$this->engine->config->`, return types, `@var`, `@property`, `@method`, generics (`list<Foo>`,
`@template`, `class-string<T>`), `foreach` over collections, array shapes and their keys. It knows the libraries' classes and
functions (`use` lines added for you), PHP's own classes and the extensions' stubs.
In JumPHP projects it also completes `config/project.yaml`, `input.yaml`, `services.yaml`, `lang.yaml`, forms, the game's texts in
`t('…')` and its actions in `isPressed('…')`.
## Navigate and refactor
- Go to declaration (`Ctrl+B`), implementations (`Ctrl+Alt+B`), find usages (`Alt+F7`), quick documentation (`Ctrl+Q`),
parameter hints (`Ctrl+P`), the symbol under the cursor highlighted.
- **Rename** (`Shift+F6`): classes (the file too), methods, properties, constants, variables.
- **Structure** (`Alt+7`, `Ctrl+F12`): the outline of the file.
- **Hierarchy** (`Ctrl+H`): the ancestors of a class and the classes under it.
- **Calls** (`Ctrl+Alt+H`): who calls a method, grouped by caller and unfolded up the chain. A **↳ N calls** line above each method
opens it.
## Problems
Syntax errors, unknown classes, methods and functions are underlined as you type and listed in **Problems** (`Alt+6`).
## Play from the code
A `src/Scene/*.php` has a green ▶ (`Ctrl+Shift+F10`): the game starts in that scene. A test file runs its tests ([Tests](tests.md)).