Composer für PHP-Entwickler #

Diese Seite richtet sich an PHP-Entwickler, die eine Abhängigkeit hinzufügen, eine Erweiterung paketieren oder die Wurzel-composer.json lesen. Exponential wird mit Composer aus Packagist installiert, ist aber kein PSR-4-Projekt von Composer: Composer installiert die Erweiterungen und die Bibliotheken, und die eigenen Klassen-Maps des Kernels laden die Klassen.

Inhalt #

1. Die Wurzel-composer.json
2. Wie Erweiterungen installiert werden
3. Die Entwicklungswerkzeuge
4. Die composer.json einer Erweiterung
5. Versionseinschränkungen
6. Regeln

Die Wurzel-composer.json #

Wie Erweiterungen installiert werden #

Pakete vom Typ ezpublish-legacy-extension werden vom Installer-Plugin se7enxweb/exponential-legacy-installer, das config.allow-plugins erlaubt, nach extension/<name>/ gelegt (nicht nach vendor/). Nach der Installation generiert der Hook legacy-scripts die Klassen-Maps neu, sodass die Klassen der Erweiterung gefunden werden. Bibliotheken (se7enxweb/expcomponents-*, mongodb/mongodb) kommen nach vendor/ und werden vom eigenen Autoloader von Composer geladen.

Die Entwicklungswerkzeuge #

PHP_CodeSniffer, PHPCompatibility und PHPStan stehen nicht im require-dev der Wurzel. Sie liegen in composer.dev.json, aufgelöst für PHP 8.0.30 und von make devtools nach .devtools/vendor installiert (COMPOSER=composer.dev.json composer install), sodass sie das vendor/ der Site nie berühren (Git-Hooks und make-Ziele).

Die composer.json einer Erweiterung #

{
    "name": "acme/acmereport",
    "description": "Monthly reports for Exponential",
    "type": "ezpublish-legacy-extension",
    "license": "GPL-2.0-or-later",
    "require": {
        "php": "^8.0",
        "se7enxweb/exponential-legacy-installer": "*"
    }
}

• type sorgt dafür, dass der Installer sie nach extension/ legt; der Verzeichnisname ist der Teil des Paketnamens nach dem /, sofern extra.ezpublish-legacy-extension-name keinen anderen nennt (LegacyExtensionInstaller::getInstallPath()).
• Geben Sie php ^8.0 an, sofern Sie nicht mehr brauchen (Unterstützte PHP-Versionen: 8.0 bis 8.5).
• Geben Sie die Bibliotheken an, die Ihr Code verwendet; liefern Sie kein vendor/ innerhalb der Erweiterung aus.
• Halten Sie die Versionen in ezinfo.php und extension.xml gleich dem Release (composer.json für Erweiterungen, Composer-Pakete und Packagist).

Versionseinschränkungen #

Exponential-Pakete verwenden drei- und vierteilige Versionen (6.0.15, 0.0.4.54). Die Tilde lässt die letzte Stelle offen:

Nach .9 kommt an der letzten Stelle .10 (0.0.4.9, 0.0.4.10). Packagist vergleicht jede Stelle als Zahl; eine einfache lexikalische Sortierung von Tags tut das nicht, verwenden Sie also sort -V oder git tag --sort=version:refname, wenn ein Skript das neueste Tag auswählt (Regeln für Versionen).

Regeln #

• Eine veröffentlichte Version ändert sich nie. Ein Tag auf Packagist wird einmal gelesen und zwischengespeichert; beheben Sie einen Fehler mit der nächsten Version (Tags sind dauerhaft).
• Prüfen Sie Packagist, bevor Sie neu pinnen. Der PHPUnit-Job der CI löst Abhängigkeiten frisch auf; eine Einschränkung, die auf ein Release zeigt, das noch nicht auf Packagist ist, lässt jeden Zweig fehlschlagen.
• Bearbeiten Sie vendor/ nicht, und seien Sie vorsichtig mit composer update auf einer installierten Site: Manche Installationen halten Erweiterungen als lebendige Git-Checkouts, die Composer ersetzen würde.

Verwandte Seiten #

• PHP-, PHP-FIG- und Composer-Standards
• composer.json modernisieren
• Der Packagist-Webhook
• Freie Dokumentation: diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.