Typo3 Command Line Interface (CLI) - Versionsgeschichte

94.216.227.52 am 24. Juni 2010 um 08:23 Uhr

2010-06-24T08:23:07Z

94.216.247.140: /* Weiterführendes */

2010-06-22T14:14:40Z

Weiterführendes

193.196.133.6 am 8. April 2010 um 10:29 Uhr

2010-04-08T10:29:58Z

94.216.227.156 am 4. April 2010 um 09:26 Uhr

2010-04-04T09:26:48Z

88.67.101.254: /* Von Tim Lochmüller im Adventskalender 2008 */

2009-08-17T14:48:09Z

Von Tim Lochmüller im Adventskalender 2008

88.67.101.254 am 17. August 2009 um 14:43 Uhr

2009-08-17T14:43:45Z

193.196.133.66 am 27. Februar 2009 um 10:48 Uhr

2009-02-27T10:48:25Z

Neue Seite

Von Tim Lochmüller im Adventskalender 2008

Heute im Türchen 15 möchte ich Euch die Verwendung des Command Line Interface (CLI) von TYPO3 näher bringen. Das CLI bietet sich immer an, wenn man Prozesse automatisieren möchte. Dies gilt z.B. für tägliche Erinnerungsmails, welche jeden morgen um 9 Uhr versendet werden sollen. Genau an diesem Beispiel möchte ich Euch nun zeigen, wie sowas geht:

Es sind nur 5 einfach Schritte nötig:

1. Backend User
Wir benötigen einen Backend-User, welcher für die Ausführung benötigt wird. Dieser sollte mit "_cli_" beginnen. Wir nennen ihn mal "_cli_myext", das Passwort ist eigentlich egal, da das CLI sich nicht ins Backend einloggt, jedoch könnte dieser User bei einem schwachen Passwort böswillig verwendet werden. Aus diesem Grund sollten ein sehr kryptisches Passwort gewählt werden.

2. Registrierung des CLI Scripts
Um das CLI nutzen zu können, müssen wir nun unser Script registrieren, dazu ist folgender Eintrag in der Datei ext_localconf.php notwendig:

if (TYPO3_MODE=='BE') {
$TYPO3_CONF_VARS['SC_OPTIONS']['GLOBAL']['cliKeys'][$_EXTKEY] = array(
'EXT:'.$_EXTKEY.'/class.tx_myext_cli.php',
'_cli_myext'
);
}

Hierbei ist zu beachten, dass der Backend-User mit angeben wird.

3. Das CLI Script selbst
Als nächstes benötigen wir das CLI Script selbst:

< ?php
if (!defined('TYPO3_cliMode')) die('You cannot run this script directly, only from the command line!');

require_once(PATH_t3lib.'class.t3lib_cli.php');

class tx_myext_cli extends t3lib_cli {
function tx_myext_cli() {
parent::t3lib_cli();
$this->cli_help['name'] = 'Reminder-Mailings';
$this->cli_help['synopsis'] = '###OPTIONS###';
$this->cli_help['description'] = 'send reminder mailings';
$this->cli_help['examples'] = '/.../cli_dispatch.phpsh myext sendMails';
$this->cli_help['author'] = 'Frank Nägler, (c) 2008';
}

function cli_main($args) {
// extract task
$task = (string) $this->cli_args['_DEFAULT'][1];
switch ($task) {
case 'sendMails':
$this->sendMails();
break;
default:
$this->cli_validateArgs();
$this->cli_help();
exit;
break;
}
}

function sendMails() {
// send some mails
}
}

// Call the functionality
$cliObj = t3lib_div::makeInstance('tx_myext_cli');
$cliObj->cli_main($_SERVER['argv']);

?>

4. Der Aufruf
Möchte man das CLI jetzt testen, dann brauchen wir nur die folgende Zeile in einer Shell aufrufen:

/path/to/typo3/cli_dispatch.phpsh myext sendMails

5. Der cronJob
Da wir die Mails ja jeden morgen um 9 Uhr versenden möchte, brauchen wir noch einen Eintrag in der cronTab:

0 9 * * * /path/to/typo3/cli_dispatch.phpsh myext sendMails

Das war es schon, die Möglichkeiten sind quasi unerschöpflich. Viel Spaß und viel Erfolg mit dem nächsten cronJob

← Nächstältere Version		Version vom 24. Juni 2010, 08:23 Uhr
Zeile 1:		Zeile 1:
	== Weiterführendes ==		== Weiterführendes ==
		+	[[TYPO3 - Scheduler]]
		+
	Kleine Anleitung für eigene Extension die Tasks mit dem Scheduler ausführt		Kleine Anleitung für eigene Extension die Tasks mit dem Scheduler ausführt

@@ Zeile 1: / Zeile 1: @@
 == Weiterführendes ==
 Podcast zum Scheduler:
 http://castor.t3o.punkt.de/files/scheduler.mp4
 Zu Historie des CLI und neuen Techniken: http://typo3blogger.de/vom-standalone-cli-zum-scheduler/
 Die lowlevel Extensions bringt bereits einige Tasks mit
 == Von Tim Lochmüller im Adventskalender 2009 ==

@@ Zeile 1: / Zeile 1: @@
 == Weiterführendes ==
 Zu Historie des CLI und neuen Techniken: http://typo3blogger.de/vom-standalone-cli-zum-scheduler/
 Die lowlevel Extensions bringt bereits einige Tasks mit

← Nächstältere Version		Version vom 4. April 2010, 09:26 Uhr
Zeile 1:		Zeile 1:
		+	== Weiterführendes ==
		+	Zu Historie des CLI und neuen Techniken: http://typo3blogger.de/vom-standalone-cli-zum-scheduler/
		+
		+	Die lowlevel Extensions bringt bereits einige Tasks mit
		+

	== Von Tim Lochmüller im Adventskalender 2008 ==		== Von Tim Lochmüller im Adventskalender 2008 ==
−

	Heute im Türchen 15 möchte ich Euch die Verwendung des Command Line Interface (CLI) von TYPO3 näher bringen. Das CLI bietet sich immer an, wenn man Prozesse automatisieren möchte. Dies gilt z.B. für tägliche Erinnerungsmails, welche jeden morgen um 9 Uhr versendet werden sollen. Genau an diesem Beispiel möchte ich Euch nun zeigen, wie sowas geht:		Heute im Türchen 15 möchte ich Euch die Verwendung des Command Line Interface (CLI) von TYPO3 näher bringen. Das CLI bietet sich immer an, wenn man Prozesse automatisieren möchte. Dies gilt z.B. für tägliche Erinnerungsmails, welche jeden morgen um 9 Uhr versendet werden sollen. Genau an diesem Beispiel möchte ich Euch nun zeigen, wie sowas geht:

@@ Zeile 10: / Zeile 10: @@
 Wir benötigen einen Backend-User, welcher für die Ausführung benötigt wird. Dieser sollte mit "_cli_" beginnen. Wir nennen ihn mal "_cli_myext", das Passwort ist eigentlich egal, da das CLI sich nicht ins Backend einloggt, jedoch könnte dieser User bei einem schwachen Passwort böswillig verwendet werden. Aus diesem Grund sollten ein sehr kryptisches Passwort gewählt werden.
 '''
-. Registrierung des CLI Scripts'''
+Anmerkung Steff: _cli_ user können sich nicht ins Backend einloggen, Passwort ist also egal. (getestet mit TYPO3 Version 4.2)
 Um das CLI nutzen zu können, müssen wir nun unser Script registrieren, dazu ist folgender Eintrag in der Datei ext_localconf.php notwendig:

@@ Zeile 1: / Zeile 1: @@
 Von Tim Lochmüller im Adventskalender 2008
 Heute im Türchen 15 möchte ich Euch die Verwendung des Command Line Interface (CLI) von TYPO3 näher bringen. Das CLI bietet sich immer an, wenn man Prozesse automatisieren möchte. Dies gilt z.B. für tägliche Erinnerungsmails, welche jeden morgen um 9 Uhr versendet werden sollen. Genau an diesem Beispiel möchte ich Euch nun zeigen, wie sowas geht:
@@ Zeile 5: / Zeile 7: @@
 Es sind nur 5 einfach Schritte nötig:
-. Backend User
+'''1. Backend User'''
 Wir benötigen einen Backend-User, welcher für die Ausführung benötigt wird. Dieser sollte mit "_cli_" beginnen. Wir nennen ihn mal "_cli_myext", das Passwort ist eigentlich egal, da das CLI sich nicht ins Backend einloggt, jedoch könnte dieser User bei einem schwachen Passwort böswillig verwendet werden. Aus diesem Grund sollten ein sehr kryptisches Passwort gewählt werden.
+'''
-. Registrierung des CLI Scripts
+. Registrierung des CLI Scripts'''
 Um das CLI nutzen zu können, müssen wir nun unser Script registrieren, dazu ist folgender Eintrag in der Datei ext_localconf.php notwendig:
@@ Zeile 20: / Zeile 23: @@
 Hierbei ist zu beachten, dass der Backend-User mit angeben wird.
-. Das CLI Script selbst
+'''3. Das CLI Script selbst'''
 Als nächstes benötigen wir das CLI Script selbst:
-< ?php
+<pre>
 if (!defined('TYPO3_cliMode'))  die('You cannot run this script directly, only from the command line!');
@@ Zeile 63: / Zeile 68: @@
 ?>
 Möchte man das CLI jetzt testen, dann brauchen wir nur die folgende Zeile in einer Shell aufrufen:
-/path/to/typo3/cli_dispatch.phpsh myext sendMails
+ /path/to/typo3/cli_dispatch.phpsh myext sendMails
 Da wir die Mails ja jeden morgen um 9 Uhr versenden möchte, brauchen wir noch einen Eintrag in der cronTab: