CLI-Skripte und ezexec für Integrationen #

Diese Seite ist für Integrationsentwickler, deren Code auf dem Exponential-Server läuft: Importe, Exporte, Reparaturen, einmalige Migrationen. Auf der Kommandozeile steht die ganze PHP-API zur Verfügung, es gibt kein Anfrage-Timeout, und der Lauf lässt sich planen, protokollieren und überwachen. Es gibt zwei Wege: bin/php/ezexec.php für ein schnelles Skript und einen Befehl Ihrer Erweiterung für alles, was Sie behalten.

Inhalt #

1. ezexec: ein schnelles Skript mit geladenem Kernel
2. Ein Befehl in Ihrer Erweiterung
3. Siteaccess, Benutzer und Umgebung
4. Exit-Codes, Probeläufe und Ausgabe
5. Mitgelieferte Befehle, die Integrationen helfen

ezexec: ein schnelles Skript mit geladenem Kernel #

php bin/php/ezexec.php <script.php> erledigt den Bootstrap (Einstellungen, Datenbank, Erweiterungen, Module) und bindet dann Ihre Datei ein. Das Skript findet $cli (ein eZCLI) und $script (ein eZScript) einsatzbereit vor:

<?php
// var/tmp/count_imported.php: how many objects carry our remote id prefix?
$db = eZDB::instance();
$rows = $db->arrayQuery( "SELECT COUNT(*) AS n FROM ezcontentobject WHERE remote_id LIKE 'erp-product-%'" );
$cli->output( 'Imported products: ' . (int)$rows[0]['n'] );

php bin/php/ezexec.php var/tmp/count_imported.php -s <siteaccess>

Gibt die eingebundene Datei etwas anderes als 1 zurück (eine einfache Datei gibt 1 zurück), ist der Exit-Code 1. Verwenden Sie ezexec zum Nachsehen und für einmalige Korrekturen; alles, was zweimal läuft, gehört als Befehl in Ihre Erweiterung.

Ein Befehl in Ihrer Erweiterung #

Die Konsole (bin/php/console) findet Skripte zur Laufzeit: Aus extension/<ext>/bin/php/<name>.php wird der Befehl ext:<ext>:<name>, mit der einzeiligen Beschreibung aus dem Tag @description des ersten Docblocks.

#!/usr/bin/env php
<?php
/**
 * @description Import products from the ERP export file (--file, --dry-run)
 */
require_once 'autoload.php';

$cli = eZCLI::instance();
$script = eZScript::instance( array( 'description' => "Import products from the ERP export file.\n",
                                     'use-session' => false,
                                     'use-modules' => true,
                                     'use-extensions' => true ) );
$script->startup();
$options = $script->getOptions( '[file:][dry-run]', '',
                                array( 'file' => 'The export file to read',
                                       'dry-run' => 'Report what would change, change nothing' ) );
$script->initialize();

if ( !$options['file'] || !is_readable( $options['file'] ) )
{
    $cli->error( 'Give a readable --file' );
    $script->shutdown( 1 );
}

$importer = new myIntegrationProductImport( $cli, (bool)$options['dry-run'] );
$ok = $importer->run( $options['file'] );

$script->shutdown( $ok ? 0 : 1 );

Speichern Sie es als extension/myintegration/bin/php/importproducts.php, machen Sie es ausführbar und führen Sie es aus:

php bin/php/console ext:myintegration:importproducts --file=var/import/products.csv --dry-run -s <siteaccess>
php extension/myintegration/bin/php/importproducts.php --help

Halten Sie die Arbeit in einer Klasse (oben myIntegrationProductImport), damit derselbe Code aus dem Befehl, einem Cronjob-Teil und einem Test läuft. Der Rumpf eines solchen Importers steht unter Ein Importskript schreiben.

Siteaccess, Benutzer und Umgebung #

Exit-Codes, Probeläufe und Ausgabe #

• Beenden Sie mit 0 bei Erfolg und mit einem anderen Wert bei Fehlern, damit Cron, Deployments und Überwachung reagieren können.
• Bieten Sie für jedes Skript, das Daten ändert, --dry-run an, und sagen Sie, was sich ändern würde.
• Beachten Sie -q: $cli->output() gibt damit nichts aus; verwenden Sie für Fehler $cli->error(), das immer ausgibt.
• Zeigen Sie bei langen Schleifen den Fortschritt mit $script->resetIteration( $total ) und $script->iterate( $cli, $status, $text ).
• Geben Sie nie Passwörter, Schlüssel oder personenbezogene Daten aus; maskieren Sie sie.

Mitgelieferte Befehle, die Integrationen helfen #

php bin/php/console list zeigt jeden Befehl der Installation.

Verwandte Seiten #

• CLI-Skripte und Konsolenbefehle
• eZScript und eZCLI
• Exponential Console
• Cronjobs für Integrationen
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.