Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

composer.json für eine Erweiterung

Die composer.json, die eine Erweiterung nach extension/<name> installiert - Pakettyp, Installer, Name der Erweiterung, Anforderungen an PHP und Kernel, Lizenz, Autoren, mit zwei echten Beispielen.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/extension-development/part-3-extension-developer/composer-json-for-extensions.md

On this page

This page is a translation. Read the English original

composer.json für eine Erweiterung

Teil 3, Kapitel 6. Mit einer composer.json lässt sich Ihre Erweiterung mit composer require installieren und auf Packagist veröffentlichen. Dieses Kapitel erklärt anhand von zwei echten Dateien die Felder, auf die es bei einer Erweiterung ankommt.

Ein modernes Beispiel

Die composer.json von se7enxweb/expqueue (gekürzt):

{
    "name": "se7enxweb/expqueue",
    "description": "The Exponential job queue: a generic, database-backed job queue ...",
    "type": "ezpublish-legacy-extension",
    "homepage": "https://github.com/se7enxweb/expqueue",
    "license": "GPL-2.0-or-later",
    "authors": [
        { "name": "7x", "homepage": "https://se7enx.com", "role": "Author" }
    ],
    "support": {
        "issues": "https://github.com/se7enxweb/expqueue/issues",
        "source": "https://github.com/se7enxweb/expqueue"
    },
    "require": {
        "php": ">=8.0",
        "ext-json": "*",
        "ext-mbstring": "*",
        "se7enxweb/exponential": "^6.0.14",
        "se7enxweb/ezpublish-legacy-installer": "*"
    },
    "extra": {
        "ezpublish-legacy-extension-name": "expqueue"
    }
}

Die Felder

FeldWas Sie eintragenWarum
name<vendor>/<package>, in Kleinbuchstabender Name auf Packagist; meist der Name des Repositorys
typeezpublish-legacy-extensionsagt dem Installer, dass das Paket nach extension/ gehört
extra.ezpublish-legacy-extension-nameder Ordnernameder Installer benennt den Ordner danach; ohne diesen Eintrag wird der Paketname verwendet
require.phpdie PHP-Versionen, die Sie getestet haben>=8.0 oder eine Liste wie ^8.0 || ^8.1 || ^8.2 || ^8.3 || ^8.4
require eines Legacy-Installersse7enxweb/ezpublish-legacy-installer oder se7enxweb/exponential-legacy-installerdas Composer-Plugin, das den Erweiterungstyp kennt (die composer.json des Kernels verlangt beide)
require.se7enxweb/exponentialdie Kernel-Versionen, die Ihr Code braucht, wenn er neue APIs des Kernels verwendetComposer verweigert eine Installation mit einem älteren Kernel
require.ext-*PHP-Erweiterungen, die Sie aufrufeneine klare Fehlermeldung statt eines fatalen Fehlers zur Laufzeit
licenseein SPDX-Bezeichner: GPL-2.0-or-laterPackagist und Werkzeuge lesen ihn
authorsalle, die daran geschrieben haben, auch die ursprünglichen AutorenAnerkennung; siehe unten
supportLinks zu Issues und Quellcodewo Benutzer Probleme melden
suggestoptionale Pakete mit Begründungvon Composer bei der Installation angezeigt

Tragen Sie version nicht in die composer.json ein, es sei denn, Sie halten es mit jedem Tag im Gleichschritt: Packagist nimmt die Versionen aus den Tags. Wenn Sie es doch führen, erhöhen Sie es zusammen mit ezinfo.php und extension.xml (ezinfo.php und extension.xml hochzählen).

Den ursprünglichen Autor nennen

se7enxweb/expchangeclass ist ein Fork; seine composer.json nennt weiterhin den ursprünglichen Autor:

"authors": [
    { "name": "7x", "homepage": "https://se7enx.com" },
    { "name": "<original author>", "role": "Original author of eZChangeclass" }
]

(Die echte Datei nennt die Person; diese Seite lässt Namen von Einzelpersonen weg.) Machen Sie es genauso, wenn Sie forken: Namensnennung und Urheberrechtsvermerke.

Prüfen

composer validate extension/mysite_hello/composer.json

composer validate meldet fehlende oder ungültige Felder; beheben Sie jeden Fehler und lesen Sie die Warnungen.

Aus einem Repository installieren, bevor das Paket auf Packagist ist

Solange das Paket nicht auf Packagist ist, kann ein Projekt es aus Git installieren, indem es seiner eigenen composer.json ein Repository hinzufügt:

"repositories": [
    { "type": "vcs", "url": "https://github.com/your-organization/mysite_hello" }
]

und dann composer require your-organization/mysite_hello:dev-main ausführt. Das Veröffentlichen auf Packagist beschreibt Composer und Packagist.

Warnung Führen Sie auf einer Live-Website nie composer update aus, um eine neue Erweiterung auszuprobieren. Probieren Sie sie auf Ihrer Entwicklungsinstallation aus, committen Sie composer.lock und stellen Sie diesen Stand bereit.

Verwandte Seiten

Werden Sie Exponential-Partner

Partner teilen ihre Informationen, stellen Mittel bereit, geben Beiträge zurück und entwickeln die Produkte mit uns, und so wächst Exponential. Eine Partner-Website und ein Dashboard sind für Mitte 2027 geplant: Werden Sie noch heute Partner, damit wir schneller wachsen und neue Funktionen früher liefern.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x