Phar::isBuffering

(PHP >= 5.3.0, PECL phar >= 1.0.0)
Used to determine whether Phar write operations are being buffered, or are flushing directly to disk
public bool Phar::isBuffering ( void )

This method can be used to determine whether a Phar will save changes to disk immediately, or whether a call to Phar::stopBuffering() is needed to enable saving changes.

Phar write buffering is per-archive, buffering active for the foo.phar Phar archive does not affect changes to the bar.phar Phar archive.

Returns:

Returns TRUE if the write operations are being buffer, FALSE otherwise.

Examples:
A Phar::isBuffering() example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?php
$p new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
$p2 new Phar('existingphar.phar');
$p['file1.txt'] = 'hi';
var_dump($p->isBuffering());
var_dump($p2->isBuffering());
?>
=2=
<?php
$p->startBuffering();
var_dump($p->isBuffering());
var_dump($p2->isBuffering());
$p->stopBuffering();
?>
=3=
<?php
var_dump($p->isBuffering());
var_dump($p2->isBuffering());
?>

The above example will output:

bool(false)
bool(false)
=2=
bool(true)
bool(false)
=3=
bool(false)
bool(false)
See also:

Phar::startBuffering() -

Phar::stopBuffering() -

doc_php
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.