breadcrumb-the-shire/CLAUDE.md

CLAUDE.md — IMVS (ImmobilienMaklerVerkaufssoftware)

Multi-tenant admin application built on MintyPHP. Manages tenants, users, departments, roles, permissions, address books, mail, CSV imports, scheduled jobs, and Microsoft Entra ID SSO.

Tech Stack

• Runtime: PHP 8.5 (FPM) on MintyPHP framework (mintyphp/core)
• Web server: Nginx 1.25 (Alpine)
• Database: MariaDB 11.4
• Cache: Memcached 1.6
• Frontend: Vanilla JS (ES2022 modules), vanilla CSS with @layer system — no build step
• Key PHP libs: PHPMailer 7, Dompdf 3, endroid/qr-code 6, league/commonmark 2
• Containerized: Docker Compose (dev + prod variants)

Quick Commands

# Start dev environment
docker compose up --build -d
# App: http://localhost:8080 | phpMyAdmin: http://localhost:8081

# Run PHPUnit tests
docker compose exec php vendor/bin/phpunit --bootstrap vendor/autoload.php

# Run PHPStan (level 5)
docker compose exec php vendor/bin/phpstan analyse -c phpstan.neon --no-progress

# Run ESLint
npx eslint web/js

# Check unused Composer packages
docker compose exec php vendor/bin/composer-unused

Project Structure

lib/                    # All backend PHP (namespace MintyPHP\)
  Repository/           # SQL queries, prepared statements, filters/paging
  Service/              # Business logic, validation, orchestration
  Http/                 # Auth guards, API auth, request helpers
  Support/              # Crypto, flash, guard, search, helpers
pages/                  # Actions (controllers) — file-based routing
  pages/**/*.php        # Action files (read input, check permissions, call services)
  pages/**/*.phtml      # View files (rendering only, no DB calls)
templates/              # Layouts and partials
  partials/             # Reusable UI components
  emails/               # Email HTML templates
  pdfs/                 # PDF templates (Dompdf)
config/                 # App config (routes, assets, settings cache, themes)
web/                    # Document root (entry point, CSS, JS, static assets)
  js/core/              # DOM utilities, Grid.js factory
  js/components/        # Reusable UI components
  css/                  # Layered CSS (base → components → layout → pages)
db/init/init.sql        # Full schema + seed data (no migration framework)
tests/                  # PHPUnit tests (namespace MintyPHP\Tests\)
docs/                   # German-language documentation (Markdown)
i18n/                   # Translation files (de, en)
bin/                    # CLI scripts (scheduler)
docker/                 # Dockerfiles, Nginx configs, PHP configs

Architecture Rules

Strict Layering (enforce in all changes)

1. Repository (lib/Repository/): All SQL lives here. No HTTP, session, or rendering.
2. Service (lib/Service/): Business rules and validation. No HTML. Uses factory pattern (*ServicesFactory).
3. Action (pages/**/*.php): Reads input, checks permissions + tenant scope, calls services, sets view vars.
4. View (pages/**/*.phtml): Pure rendering. No DB calls. HTML escaping via e(...).
5. Template (templates/): Layouts and partials.

Routing

• File-based: pages/admin/users/edit($id).php → URL parameter id
• ...(none).phtml → no template layout
• data().php suffix → data/AJAX endpoints
• Named aliases in config/routes.php with public flag for auth guard

PHP Conventions

• PSR-4 autoload: MintyPHP\ → lib/, MintyPHP\Tests\ → tests/
• All user-facing text uses t('key') translation helper
• Permissions + tenant scope enforced in actions/services, never just in UI
• Security/integration settings stay in DB, not in config/settings.php file cache

Frontend Conventions

• Vanilla ES2022 modules, no bundler
• CSS classes prefixed with app-
• Defensive DOM checks (elements may not exist on every page)
• No business logic in frontend
• Assets served raw with assetVersion() cache-busting (filemtime-based)

UI Patterns

• Edit pages: tabs → Master data | Visibility | optional Danger zone
• Titlebar partial for primary actions (Save, Save & close)
• Secondary actions in Aside block via app-details-aside-actions.phtml
• Lists use Grid.js
• All visible text wrapped in t('...')

Database

• Schema defined in db/init/init.sql (applied once on container init)
• No migration framework — schema changes for existing installs are idempotent SQL scripts
• Settings stored in settings DB table (single source of truth); config/settings.php is a partial file cache for hot-path UI reads only

Quality Gates

• PHPStan level 5 — scans config/, lib/, pages/, tests/
• PHPUnit 11 — bootstrap: tests/bootstrap.php
• ESLint — ES2022, strict eqeqeq, curly, no-unused-vars, no-console (warn, allow warn/error)
• composer-unused — periodic check for unused dependencies

Environment

• Config via .env (gitignored) — copy from .env.example for dev, .env.prod.example for prod
• config/config.php (gitignored) — copy from config/config.php.example
• APP_CRYPTO_KEY (64-char hex) needed for AES-256-GCM encryption of SSO secrets