OutputStream::flush()   A
last analyzed

Complexity

Conditions 3
Paths 2

Size

Total Lines 8
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 6
CRAP Score 3

Importance

Changes 0
Metric Value
eloc 5
dl 0
loc 8
ccs 6
cts 6
cp 1
rs 10
c 0
b 0
f 0
cc 3
nc 2
nop 0
crap 3
1
<?php
2
3
/**
4
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15
 *
16
 * This software consists of voluntary contributions made by many individuals
17
 * and is licensed under the LGPL. For more information please see
18
 * <http://phing.info>.
19
 */
20
21
namespace Phing\Io;
22
23
/**
24
 * Wrapper class for PHP stream that supports write operations.
25
 */
26
class OutputStream
27
{
28
    /**
29
     * @var resource the configured PHP stream
30
     */
31
    protected $stream;
32
33
    /**
34
     * Construct a new OutputStream.
35
     *
36
     * @param resource $stream configured PHP stream for writing
37
     *
38
     * @throws IOException
39
     */
40 59
    public function __construct($stream)
41
    {
42 59
        if (!is_resource($stream)) {
43
            throw new IOException('Passed argument is not a valid stream.');
44
        }
45 59
        $this->stream = $stream;
46
    }
47
48
    /**
49
     * Returns a string representation of the attached PHP stream.
50
     *
51
     * @return string
52
     */
53
    public function __toString()
54
    {
55
        return (string) $this->stream;
56
    }
57
58
    /**
59
     * Closes attached stream, flushing output first.
60
     *
61
     * @throws IOException if cannot close stream (note that attempting to close an already closed stream will not raise an IOException)
62
     */
63 49
    public function close()
64
    {
65 49
        if (null === $this->stream) {
66 1
            return;
67
        }
68 49
        $this->flush();
69 49
        error_clear_last();
70 49
        if (false === @fclose($this->stream)) {
71
            $lastError = error_get_last();
72
            $errormsg = $lastError['message'];
73
            $metaData = stream_get_meta_data($this->stream);
74
            $resource = $metaData['uri'];
75
            $msg = 'Cannot close ' . $resource . ": {$errormsg}";
76
77
            throw new IOException($msg);
78
        }
79 49
        $this->stream = null;
80
    }
81
82
    /**
83
     * Flushes stream.
84
     *
85
     * @throws IOException if unable to flush data (e.g. stream is not open).
86
     */
87 50
    public function flush()
88
    {
89 50
        error_clear_last();
90 50
        if (null === $this->stream || false === @fflush($this->stream)) {
91 1
            $lastError = error_get_last();
92 1
            $errormsg = $lastError['message'] ?? 'no stream';
93
94 1
            throw new IOException('Could not flush stream: ' . $errormsg);
95
        }
96
    }
97
98
    /**
99
     * Writes data to stream.
100
     *
101
     * @param string $buf binary/character data to write
102
     * @param int    $off (Optional) offset
103
     * @param int    $len (Optional) number of bytes/chars to write
104
     *
105
     * @throws IOException - if there is an error writing to stream
106
     */
107 57
    public function write($buf, $off = null, $len = null)
108
    {
109 57
        if (null === $off && null === $len) {
110 57
            $to_write = $buf;
111 1
        } elseif (null !== $off && null === $len) {
112 1
            $to_write = substr($buf, $off);
113 1
        } elseif (null === $off && null !== $len) {
114
            $to_write = substr($buf, 0, $len);
115
        } else {
116 1
            $to_write = substr($buf, $off, $len);
0 ignored issues
show
Bug introduced by
It seems like $off can also be of type null; however, parameter $offset of substr() does only seem to accept integer, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

116
            $to_write = substr($buf, /** @scrutinizer ignore-type */ $off, $len);
Loading history...
117
        }
118
119 57
        $result = @fwrite($this->stream, $to_write);
120
121 57
        if (false === $result) {
122
            throw new IOException('Error writing to stream.');
123
        }
124
    }
125
}
126