ignore_user_abort

(PHP 4, PHP 5, PHP 7, PHP 8)

ignore_user_abort Legt fest, ob der Verbindungsabbruch eines Clients die Skript-Ausführung abbrechen soll

Beschreibung

ignore_user_abort(?bool $enable = null): int

Setzt den Wert dafür, ob der Abbruch einer Client-Verbindung die weitere Abarbeitung eines Skripts beenden soll.

Wird PHP als Kommondozeilen-Skript ausgeführt, und das TTY des Skripts wird entfernt ohne dass das Skript terminiert wurde, dann stirbt das Skript beim nächsten Versuch etwas zu schreiben, außer wenn enable auf true gesetzt ist.

Parameter-Liste

enable

Sofern dieser Parameter angegeben wird und nicht null ist, überschreibt diese Funktion die aktuelle Einstellung von ignore_user_abort mit dem übergebenen enable. Andernfalls gibt die Funktion nur die aktuelle Einstellung zurück, ohne sie zu verändern.

Rückgabewerte

Gibt das vorhergehende Setting als Ganzzahl (Integer) zurück.

Changelog

Version Beschreibung
8.0.0 enable ist nun ein Nullable-Typ.

Beispiele

Beispiel #1 Ein ignore_user_abort()-Beispiel

<?php
// Ignoriere Abbruch durch den Benutzer und erlaube dem Skript weiterzulaufen
ignore_user_abort(true);
set_time_limit(0);

echo
'Teste Connectionhandling in PHP';

// Lasse eine sinnfreie Schleife laufen, die uns irgendwann
// hoffentlich von der Seite wegklicken oder den "Stop"-Button
// betätigen lässt
while(1)
{
// Schlug die Verbindung fehl?
if(connection_status() != CONNECTION_NORMAL)
{
break;
}

// 10 Sekunden warten
sleep(10);
}

// Wird dieser Punkt erreicht, wurde das 'break'
// von einem Punkt innerhalb der while-Schleife getriggert

// Somit können wir hier ein Log schreiben oder andere Aufgaben
// ausführen, die nicht davon abhängig sind, ob der Browser des
// Benutzers noch eine stehende Verbindung zum Server hat
?>

Anmerkungen

PHP wird nicht herausfinden, ob ein Benutzer die Verbindung abgebrochen hat, bevor es nicht versucht, Informationen an den Client zu senden. Die einfache Verwendung eines echo-Statements ist keine Garantie dafür, dass eine Information übertragen wurde, lesen Sie daher auch die Dokumentation zu flush().

Siehe auch

add a note add a note

User Contributed Notes 7 notes

up
52
spiritual-coder at spiritual-coder dot com
17 years ago
If you want to simulate a crontask you must call this script once and it will keep running forever (during server uptime) in the background while "doing something" every specified seconds (= $interval):

<?php
ignore_user_abort
(1); // run script in background
set_time_limit(0); // run script forever
$interval=60*15; // do every 15 minutes...
do{
  
// add the script that has to be ran every 15 minutes here
   // ...
  
sleep($interval); // wait 15 minutes
}while(true);
?>
up
28
lukas dot starecek at centrum dot cz
14 years ago
Comment from Anonymous is not 100% valid. Time from sleep function is not counted to execution time because sleep delays program execution (see http://www.php.net/manual/en/function.sleep.php and comments). We tested it and it's true. Try this:

<?php

set_time_limit
(2);
sleep(4);
echo
'hi!';
sleep(4);
echo
'bye bye!';

?>

It means, that if the loop most of the time will be at sleep (and in this case it probably be), then this script may be active for months or years even if you set time limit to one day.
up
14
Anonymous
14 years ago
use the spiritual-coder's code below with exreme caution and do not use it unless you are an advanced user.

first of all, such a code with no bypass point can cause infinite loops and ghost threads in server. there must be a trick to break out the loop.

i.e. you can use  if (file_exists(dirname(__FILE__)."stop.txt")) break; in the loop so if you create "stop.txt", she script will stop execution.

also if you use set_time_limit(86400); instead of set_time_limit(0); your script will stop after one day.
up
5
Micke
9 years ago
It seems that this function does not work for IIS servers.

A detailed description can be found on the PHP Bug Tracking System:
https://bugs.php.net/bug.php?id=60586#1378935714
up
-15
Charlie Brown
9 years ago
If running a long process and the browser often close the connection, then use this function.
up
-24
plamen at pulsator dot com
22 years ago
The script should output something to the browser in order to abort. If there is no output the script keeps on running.
up
-61
phpguy92135 at yahoo dot com
14 years ago
Theres no point in sending anything to the browser if the user does abort.  Since the user aborted, the browser wont listen even if PHP did send information to the browser.

If you want to see if the user did abort, then use error_log() or some other form of logging to find out what happened, but dont rely on the output to the browser as the only method of checking ones data.
To Top