Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Output Control Functions : ob_end_clean

ob_end_clean

Clean (erase) the output buffer and turn off output buffering (PHP 4, PHP 5)
bool ob_end_clean ( )

Example 1683. ob_end_clean() example

<?php
ob_start
();
echo
'Text that won\'t get displayed.';
ob_end_clean();
?>

Related Examples ( Source code ) » ob_end_clean



Code Examples / Notes » ob_end_clean

programmer

You might want to prevent your script from executing if the client already has the latest version.
You can do it like so:
ob_start();
$mtime=filemtime($_SERVER["SCRIPT_FILENAME"])-date("Z");
$gmt_mtime = date('D, d M Y H:i:s', $mtime) . ' GMT';
$headers = getallheaders();
if(isset($headers["If-Modified-Since"])) {
   if ($headers["If-Modified-Since"] == $gmt_mtime) {
       header("HTTP/1.1 304 Not Modified");
       ob_end_clean();
       exit;
   }
}
$size=ob_get_length();
header("Last-Modified: ".$gmt_mtime);
header("Content-Length: $size");
ob_end_flush();
Instead of checking the If-Modified-Since-Header against the date of the last modification of the script, you can of course query a database or take any other date that is somehow related to the modification of the result of your script.
You can for instance use this technique to generate images dynamically. If the user indicates he already has a version of the image by the If-Modified-Since-Header, there's no need to generate it and let the server finally discard it because the server only then interpretes the If-Modified-Since-Header.
This saves server load and shortens response-times.


adam of fusion bay

You may want to be careful about calling ob_end_clean() from within your call-back function. I believe this can produce an endless-loop within PHP.

mrfritz379

This may be posted elsewhere, but I haven't seen it.
To run a progress indicator while the program is running without outputting the output buffer, the following will work:
echo "

Search running. Please be patient. . .";
$output = "

FileList: \n";
if (is_dir($dir)) {
  $dh = opendir($dir);
  while (($fd = readdir($dh)) != false) {
     echo " .";
     ob_start();
     echo $fd;
     $output .= ob_get_contents();
     ob_end_clean();
   }
}
echo "</br>Search Complete!\n";
echo $output;
The program will continue to print the " ." without printing the file list. Then the "Search Complete" message will print followed by the buffered file list.


john smith

Note that if you started called ob_start with a callback, that callback will still be called even if you discard the OB with ob_end_clean.
Because there is no way of removing the callback from the OB once you've set it, the only way to stop the callback function from having any effect is to do something like:
<?php
$ignore_callback = false;
ob_start('my_callback');
...
if($need_to_abort) {
  $ignore_callback = true;
  ob_end_clean();
  ...
}
function my_callback(&$buffer) {
 if($GLOBALS['ignore_callback']) {
    return "";
 }
 ...
}
?>


everling

Keep in mind that mrfritz379's example (#49800) is just an example. You can achieve that example's result in a more efficient manner without using output buffering functions:
echo "

Search running. Please be patient. . .";
$output = "

FileList: \n";
if (is_dir($dir)) {
 $dh = opendir($dir);
 while (($fd = readdir($dh)) != false) {
   echo " .";
   $output .= $fd;
 }
}
echo "</br>Search Complete!\n";
echo $output;



In addition to John Smith's comment (#42939), ob_gzhandler() may still set the HTTP header "Content-Encoding" to "gzip" or "deflate" even if you call ob_end_clean(). This will cause a problem in the following situation:
1. Call ob_gzhandler().
2. Echo "Some content";
3. Call ob_end_clean().
4. Echo "New content";
In the above case, the browser may receive the "Content-Encoding: gzip" HTTP header and attempts to decompress the uncompressed "New content". The browser will fail.
In the following situation, this behaviour will go unnoticed:
1. Call ob_gzhandler().
2. Echo "Some content";
3. Call ob_end_clean().
4. Call ob_gzhandler().
5. Echo "New content";
This is because the second ob_gzhandler() will mask the absence of the first ob_gzhandler().
A solution would be to write a wrapper, like John Smith did, for the ob_gzhandler().


geoff

If you call ob_end_clean in a function registered with "register_shutdown_function", it is too late, any buffers will have already been sent out to the client.

daijoubunosp

About the previous comment:
You can also relay on ETag and simply use time()
<?php
$time = time();
$mins = 1;
if (isset($_SERVER['HTTP_IF_NONE_MATCH']) and str_replace('"', '', $_SERVER['HTTP_IF_NONE_MATCH'])+($mins*60) > $time)
{
header('HTTP/1.1 304 Not Modified');
exit();
}
else
{
header('ETag: "'.$time.'"');
}
echo 'Caching for ', $mins*60, 'secs<br/>', date('G:i:s');
?>


Change Language


Follow Navioo On Twitter
flush
ob_clean
ob_end_clean
ob_end_flush
ob_flush
ob_get_clean
ob_get_contents
ob_get_flush
ob_get_length
ob_get_level
ob_get_status
ob_gzhandler
ob_implicit_flush
ob_list_handlers
ob_start
output_add_rewrite_var
output_reset_rewrite_vars
eXTReMe Tracker