Kommandozeile: die Konsole und eZScript #

Diese Seite richtet sich an Entwickler, die in bin/console, php artisan, manage.py oder bin/rails zu Hause sind. Exponential hat einen einzigen Einstiegspunkt für alle Befehle, bin/php/console (Installationen legen meist eine Abkürzung ./console im Stammverzeichnis an). Er findet Befehle zur Laufzeit anhand ihres Speicherorts, sodass der Befehl einer Erweiterung nicht registriert werden muss (Exponential Console, Konsolenbefehle).

Inhalt #

1. Befehle finden
2. Befehlsnamen
3. Einen Befehl schreiben
4. Siteaccess, Benutzer und root
5. Befehle, die Sie täglich verwenden
6. Im Vergleich mit anderen Frameworks

Befehle finden #

php bin/php/console                   # every command
php bin/php/console list ext:expdemo  # one namespace
php bin/php/console --version

Befehlsnamen #

Ein Skript kann mit einem @alias-Tag in seinem Docblock zusätzliche Namen deklarieren (bin/php/exphelp.php deklariert @alias exp:help), und ein @description-Tag beschreibt es in list.

Einen Befehl schreiben #

Neue Befehle sind Klassen, die Exponential\Runnable\Command erweitern und von einem einzeiligen Skript aufgerufen werden (CLI-Skripte mit eZScript):

<?php
// extension/expdemo/classes/runnable/commands/report.php
namespace Exponential\Command\Extension\Expdemo;

class Report extends \Exponential\Runnable\Command
{
    public function run()
    {
        $this->script( array( 'description' => "Writes the monthly report",
                              'use-session' => false, 'use-modules' => true, 'use-extensions' => true ) );
        $options = $this->startup( '[month:][dry-run]', '', array(
            'month'   => 'The month, YYYY-MM',
            'dry-run' => 'Show what would be written, write nothing' ) );
        $this->output( \expDemoReportService::build( $options['month'], !empty( $options['dry-run'] ) ) );
        $this->shutdown( 0 );
    }
}

#!/usr/bin/env php
<?php
// extension/expdemo/bin/php/report.php
require_once 'autoload.php';
\Exponential\Command\Extension\Expdemo\Report::main( __FILE__ );

Aufruf: php bin/php/console ext:expdemo:report --month=2026-10 --dry-run. Die klassische Form, die viele Skripte verwenden, ruft eZScript::instance(), startup(), getOptions(), initialize() und shutdown() direkt auf; die Ausgabe läuft über eZCLI (output(), notice(), warning(), error()). Optionszeichenketten verwenden [name:] für einen Wert und [name] für einen Schalter; --help, -s/--siteaccess, --allow-root-user und die Debug-Optionen werden automatisch ergänzt.

Siteaccess, Benutzer und root #

• -s <siteaccess> wählt die Einstellungen aus; Erweiterungen, die nur in diesem Siteaccess aktiv sind, benötigen es.
• Der Benutzer ist anonym. Ein Befehl, der Inhalte schreibt, meldet einen eigenen Benutzer an (eZUser::setCurrentlyLoggedInUser( $user, $user->id() )), niemals den gemeinsam genutzten Administrator.
• Skripte verweigern die Ausführung als root, sofern nicht --allow-root-user angegeben ist; führen Sie sie als Benutzer des Webservers aus, denn Dateien, die ein root-Prozess in var/ schreibt, beschädigen die Website später.
• Der Exit-Code wird unverändert zurückgegeben: shutdown( 0 ) bei Erfolg, jeder andere Wert bei einem Fehler.
• Bieten Sie für jeden Befehl, der schreibt oder löscht, --dry-run an, und nehmen Sie niemals Passwörter als Optionen entgegen.

Befehle, die Sie täglich verwenden #

Im Vergleich mit anderen Frameworks #

Verwandte Seiten #

• Befehle, Cronjob-Teile und Modul-Views als Klassen
• Muster für Befehle
• Geplante Aufgaben: Cronjobs
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.