Stream::tell() - Code Metrics - Inspection of "Removed string reader getter and setter" - GravityMedia/Stream - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 722094...88acd9 )

by Daniel

created 2016-03-21 16:50 UTC

Stream::tell() A

↳ Parent: Stream

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	8
Bugs	0	Features	4

Metric	Value
c	8
b	0
f	4
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of the stream package
 *
 * @author Daniel Schröder <[email protected]>
 */

namespace GravityMedia\Stream;

use GravityMedia\Stream\Exception;

/**
 * Stream
 *
 * @package GravityMedia\Stream
 */
class Stream implements StreamInterface
{
    /**
     * @var string[]
     */
    private static $readModes = ['r', 'w+', 'r+', 'x+', 'c+', 'rb', 'w+b', 'r+b', 'x+b', 'c+b', 'rt', 'w+t',
        'r+t', 'x+t', 'c+t', 'a+'];

    /**
     * @var string[]
     */
    private static $writeModes = ['w', 'w+', 'rw', 'r+', 'x+', 'c+', 'wb', 'w+b', 'r+b', 'x+b', 'c+b', 'w+t',
        'r+t', 'x+t', 'c+t', 'a', 'a+'];

    /**
     * @var resource
     */
    protected $resource;

    /**
     * @var bool
     */
    protected $local;

    /**
     * @var bool
     */
    protected $readable;

    /**
     * @var bool
     */
    protected $writable;

    /**
     * @var bool
     */
    protected $seekable;

    /**
     * @var string
     */
    protected $uri;

    /**
     * Create stream object from resource
     *
     * @param resource $resource
     *
     * @return StreamInterface
     */
    public static function fromResource($resource)
    {
        $instance = new static();

        return $instance->bindResource($resource);
    }

    /**
     * Get meta data from the stream
     *
     * @throws Exception\IOException An exception will be thrown for invalid stream resources
     *
     * @return array
     */
    protected function getMetaData()
    {
        return stream_get_meta_data($this->getResource());
    }

    /**
     * {@inheritdoc}
     */
    public function bindResource($resource)
    {
        $this->resource = $resource;

        $this->local = stream_is_local($this->getResource());

        $metaData = $this->getMetaData();
        $this->readable = in_array($metaData['mode'], self::$readModes);
        $this->writable = in_array($metaData['mode'], self::$writeModes);
        $this->seekable = $metaData['seekable'];
        $this->uri = $metaData['uri'];

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getResource()
    {
        if (!is_resource($this->resource)) {
            throw new Exception\IOException('Invalid resource');
        }

        return $this->resource;
    }

    /**
     * {@inheritdoc}
     */
    public function isLocal()
    {
        return $this->local;
    }

    /**
     * {@inheritdoc}
     */
    public function isReadable()
    {
        return $this->readable;
    }

    /**
     * {@inheritdoc}
     */
    public function isWritable()
    {
        return $this->writable;
    }

    /**
     * {@inheritdoc}
     */
    public function isSeekable()
    {
        return $this->seekable;
    }

    /**
     * {@inheritdoc}
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     * Get information about the stream
     *
     * @param string $info The information to retrieve
     *
     * @throws Exception\IOException An exception will be thrown for invalid stream resources
     *
     * @return int
     */
    protected function getStat($info)
    {
        $resource = $this->getResource();

        $uri = $this->getUri();
        if (is_string($uri)) {
            clearstatcache(true, $uri);
        }

        $stat = fstat($resource);

        return $stat[$info];
    }

    /**
     * {@inheritdoc}
     */
    public function getSize()
    {
        if (!$this->isLocal()) {
            throw new Exception\BadMethodCallException('Stream not local');
        }

        return $this->getStat('size');
    }

    /**
     * {@inheritdoc}
     */
    public function eof()
    {
        return feof($this->getResource());
    }

    /**
     * {@inheritdoc}
     */
    public function tell()
    {
        return ftell($this->getResource());
    }

    /**
     * {@inheritdoc}
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        $resource = $this->getResource();

        if (!$this->isSeekable()) {
            throw new Exception\BadMethodCallException('Stream not seekable');
        }

        if (fseek($resource, $offset, $whence) < 0) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $this->tell();
    }

    /**
     * {@inheritdoc}
     */
    public function rewind()
    {
        return $this->seek(0);
    }

    /**
     * {@inheritdoc}
     */
    public function read($length)

    {
        $resource = $this->getResource();

        if (!$this->isReadable()) {
            throw new Exception\BadMethodCallException('Stream not readable');
        }

        $data = @fread($resource, $length);
        if (false === $data) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function write($data)

    {
        $resource = $this->getResource();

        if (!$this->isWritable()) {
            throw new Exception\BadMethodCallException('Stream not writable');
        }

        $length = @fwrite($resource, $data);
        if (false === $length) {
            throw new Exception\IOException('Unexpected result of operation');
        }

        return $length;
    }

    /**
     * {@inheritdoc}
     */
    public function truncate($size)
    {
        $resource = $this->getResource();

        if (!$this->isWritable()) {
            throw new Exception\BadMethodCallException('Stream not writable');
        }

        return @ftruncate($resource, $size);
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        return @fclose($this->resource);
    }
}


1			<?php
2			/**
3			* This file is part of the stream package
4			*
5			* @author Daniel Schröder <[email protected]>
6			*/
7
8			namespace GravityMedia\Stream;
9
10			use GravityMedia\Stream\Exception;
11
12			/**
13			* Stream
14			*
15			* @package GravityMedia\Stream
16			*/
17			class Stream implements StreamInterface
18			{
19			/**
20			* @var string[]
21			*/
22			private static $readModes = ['r', 'w+', 'r+', 'x+', 'c+', 'rb', 'w+b', 'r+b', 'x+b', 'c+b', 'rt', 'w+t',
23			'r+t', 'x+t', 'c+t', 'a+'];
24
25			/**
26			* @var string[]
27			*/
28			private static $writeModes = ['w', 'w+', 'rw', 'r+', 'x+', 'c+', 'wb', 'w+b', 'r+b', 'x+b', 'c+b', 'w+t',
29			'r+t', 'x+t', 'c+t', 'a', 'a+'];
30
31			/**
32			* @var resource
33			*/
34			protected $resource;
35
36			/**
37			* @var bool
38			*/
39			protected $local;
40
41			/**
42			* @var bool
43			*/
44			protected $readable;
45
46			/**
47			* @var bool
48			*/
49			protected $writable;
50
51			/**
52			* @var bool
53			*/
54			protected $seekable;
55
56			/**
57			* @var string
58			*/
59			protected $uri;
60
61			/**
62			* Create stream object from resource
63			*
64			* @param resource $resource
65			*
66			* @return StreamInterface
67			*/
68	69		public static function fromResource($resource)
69			{
70	69		$instance = new static();
71
72	69		return $instance->bindResource($resource);
73			}
74
75			/**
76			* Get meta data from the stream
77			*
78			* @throws Exception\IOException An exception will be thrown for invalid stream resources
79			*
80			* @return array
81			*/
82	66		protected function getMetaData()
83			{
84	66		return stream_get_meta_data($this->getResource());
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90	69		public function bindResource($resource)
91			{
92	69		$this->resource = $resource;
93
94	69		$this->local = stream_is_local($this->getResource());
95
96	66		$metaData = $this->getMetaData();
97	66		$this->readable = in_array($metaData['mode'], self::$readModes);
98	66		$this->writable = in_array($metaData['mode'], self::$writeModes);
99	66		$this->seekable = $metaData['seekable'];
100	66		$this->uri = $metaData['uri'];
101
102	66		return $this;
103			}
104
105			/**
106			* {@inheritdoc}
107			*/
108	69		public function getResource()
109			{
110	69		if (!is_resource($this->resource)) {
111	27		throw new Exception\IOException('Invalid resource');
112			}
113
114	66		return $this->resource;
115			}
116
117			/**
118			* {@inheritdoc}
119			*/
120	9		public function isLocal()
121			{
122	9		return $this->local;
123			}
124
125			/**
126			* {@inheritdoc}
127			*/
128	9		public function isReadable()
129			{
130	9		return $this->readable;
131			}
132
133			/**
134			* {@inheritdoc}
135			*/
136	12		public function isWritable()
137			{
138	12		return $this->writable;
139			}
140
141			/**
142			* {@inheritdoc}
143			*/
144	12		public function isSeekable()
145			{
146	12		return $this->seekable;
147			}
148
149			/**
150			* {@inheritdoc}
151			*/
152	6		public function getUri()
153			{
154	6		return $this->uri;
155			}
156
157			/**
158			* Get information about the stream
159			*
160			* @param string $info The information to retrieve
161			*
162			* @throws Exception\IOException An exception will be thrown for invalid stream resources
163			*
164			* @return int
165			*/
166	6		protected function getStat($info)
167			{
168	6		$resource = $this->getResource();
169
170	3		$uri = $this->getUri();
171	3		if (is_string($uri)) {
172	3		clearstatcache(true, $uri);
173	3		}
174
175	3		$stat = fstat($resource);
176
177	3		return $stat[$info];
178			}
179
180			/**
181			* {@inheritdoc}
182			*/
183	9		public function getSize()
184			{
185	9		if (!$this->isLocal()) {
186	3		throw new Exception\BadMethodCallException('Stream not local');
187			}
188
189	6		return $this->getStat('size');
190			}
191
192			/**
193			* {@inheritdoc}
194			*/
195	6		public function eof()
196			{
197	6		return feof($this->getResource());
198			}
199
200			/**
201			* {@inheritdoc}
202			*/
203	12		public function tell()
204			{
205	12		return ftell($this->getResource());
206			}
207
208			/**
209			* {@inheritdoc}
210			*/
211	15		public function seek($offset, $whence = SEEK_SET)
212			{
213	15		$resource = $this->getResource();
214
215	12		if (!$this->isSeekable()) {
216	3		throw new Exception\BadMethodCallException('Stream not seekable');
217			}
218
219	9		if (fseek($resource, $offset, $whence) < 0) {
220	3		throw new Exception\IOException('Unexpected result of operation');
221			}
222
223	6		return $this->tell();
224			}
225
226			/**
227			* {@inheritdoc}
228			*/
229	3		public function rewind()
230			{
231	3		return $this->seek(0);
232			}
233
234			/**
235			* {@inheritdoc}
236			*/
237	12	View Code Duplication	public function read($length)
			0 ignored issues – show Duplication introduced 2016-01-05 22:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
238			{
239	12		$resource = $this->getResource();
240
241	9		if (!$this->isReadable()) {
242	3		throw new Exception\BadMethodCallException('Stream not readable');
243			}
244
245	6		$data = @fread($resource, $length);
246	6		if (false === $data) {
247	3		throw new Exception\IOException('Unexpected result of operation');
248			}
249
250	3		return $data;
251			}
252
253			/**
254			* {@inheritdoc}
255			*/
256	12	View Code Duplication	public function write($data)
			0 ignored issues – show Duplication introduced 2016-01-05 22:25 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
257			{
258	12		$resource = $this->getResource();
259
260	9		if (!$this->isWritable()) {
261	3		throw new Exception\BadMethodCallException('Stream not writable');
262			}
263
264	6		$length = @fwrite($resource, $data);
265	6		if (false === $length) {
266	3		throw new Exception\IOException('Unexpected result of operation');
267			}
268
269	3		return $length;
270			}
271
272			/**
273			* {@inheritdoc}
274			*/
275	9		public function truncate($size)
276			{
277	9		$resource = $this->getResource();
278
279	6		if (!$this->isWritable()) {
280	3		throw new Exception\BadMethodCallException('Stream not writable');
281			}
282
283	3		return @ftruncate($resource, $size);
284			}
285
286			/**
287			* {@inheritdoc}
288			*/
289	3		public function close()
290			{
291	3		return @fclose($this->resource);
292			}
293			}
294

GravityMedia / Stream

Push — master ( 722094...88acd9 )

Stream::tell() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like