FileStream::tell() - Code Metrics - Inspection of "Merge branch '2.1' into remove-yii-autoloader" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — remove-yii-autoloader ( 560d61...5f8600 )

by Alexander

created 2017-09-06 20:03 UTC

FileStream::tell() A

↳ Parent: FileStream

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\http;

use Psr\Http\Message\StreamInterface;
use Yii;
use yii\base\BaseObject;
use yii\base\ErrorHandler;
use yii\base\InvalidConfigException;

/**
 * FileStream represents file stream.
 *
 * Example:
 *
 * ```php
 * $stream = new FileSteam([
 *     'filename' => '@app/files/items.txt',
 *     'mode' => 'w+',
 * ]);
 *
 * $stream->write('some content...');
 * $stream->close();
 * ```
 *
 * @author Paul Klimov <[email protected]>
 * @since 2.1.0
 */
class FileStream extends BaseObject implements StreamInterface
{
    /**
     * @var string file or stream name.
     * Path alias can be used here, for example: '@app/runtime/items.csv'.
     * This field can also be PHP stream name, e.g. anything which can be passed to `fopen()`, for example: 'php://input'.
     */
    public $filename;
    /**
     * @var string file open mode.
     */
    public $mode = 'r';

    /**
     * @var resource|null stream resource
     */
    private $_resource;
    /**
     * @var array a resource metadata.
     */
    private $_metadata;


    /**
     * Destructor.
     * Closes the stream resource when destroyed.
     */
    public function __destruct()
    {
        $this->close();
    }

    /**
     * @return resource a file pointer resource.
     * @throws InvalidConfigException if unable to open a resource.
     */
    public function getResource()
    {
        if ($this->_resource === null) {
            $resource = fopen(Yii::getAlias($this->filename), $this->mode);
            if ($resource === false) {
                throw new InvalidConfigException("Unable to open file '{$this->filename}' with mode '{$this->mode}'");
            }
            $this->_resource = $resource;
        }
        return $this->_resource;
    }

    /**
     * {@inheritdoc}
     */
    public function __toString()
    {
        // __toString cannot throw exception
        // use trigger_error to bypass this limitation
        try {
            $this->seek(0);
            return $this->getContents();
        } catch (\Exception $e) {
            ErrorHandler::convertExceptionToError($e);
            return '';
        }
    }

    /**
     * {@inheritdoc}
     */
    public function close()
    {
        if ($this->_resource !== null) {
            fclose($this->_resource);
            $this->_resource = null;
            $this->_metadata = null;

        }
    }

    /**
     * {@inheritdoc}
     */
    public function detach()
    {
        if ($this->_resource === null) {
            return null;
        }
        $result = $this->_resource;
        $this->_resource = null;
        $this->_metadata = null;

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getSize()
    {
        $uri = $this->getMetadata('uri');
        if (!empty($uri)) {
            // clear the stat cache in case stream has a URI
            clearstatcache(true, $uri);
        }

        $stats = fstat($this->getResource());
        if (isset($stats['size'])) {
            return $stats['size'];
        }
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function tell()
    {
        $result = ftell($this->getResource());
        if ($result === false) {
            throw new \RuntimeException('Unable to determine stream position');
        }
        return $result;
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function seek($offset, $whence = SEEK_SET)
    {
        if (fseek($this->getResource(), $offset, $whence) === -1) {
            throw new \RuntimeException("Unable to seek to stream position '{$offset}' with whence '{$whence}'");
        }
    }

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

    /**
     * {@inheritdoc}
     */
    public function isWritable()
    {
        $mode = $this->getMetadata('mode');
        foreach (['w', 'c', 'a', 'x', 'r+'] as $key) {
            if (strpos($mode, $key) !== false) {
                return true;
            }
        }
        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function write($string)
    {
        $result = fwrite($this->getResource(), $string);
        if ($result === false) {
            throw new \RuntimeException('Unable to write to stream');
        }
        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function isReadable()
    {
        $mode = $this->getMetadata('mode');
        foreach (['r', 'w+', 'a+', 'c+', 'x+'] as $key) {
            if (strpos($mode, $key) !== false) {
                return true;
            }
        }
        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function read($length)
    {
        $string = fread($this->getResource(), $length);
        if ($string === false) {
            throw new \RuntimeException('Unable to read from stream');
        }
        return $string;
    }

    /**
     * {@inheritdoc}
     */
    public function getContents()
    {
        $contents = stream_get_contents($this->getResource());
        if ($contents === false) {
            throw new \RuntimeException('Unable to read stream contents');
        }
        return $contents;
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($key = null)
    {
        if ($this->_metadata === null) {
            $this->_metadata = stream_get_meta_data($this->getResource());
        }

        if ($key === null) {
            return $this->_metadata;
        }

        return isset($this->_metadata[$key]) ? $this->_metadata[$key] : null;
    }
}

1			<?php
2			/**
3			* @link http://www.yiiframework.com/
4			* @copyright Copyright (c) 2008 Yii Software LLC
5			* @license http://www.yiiframework.com/license/
6			*/
7
8			namespace yii\http;
9
10			use Psr\Http\Message\StreamInterface;
11			use Yii;
12			use yii\base\BaseObject;
13			use yii\base\ErrorHandler;
14			use yii\base\InvalidConfigException;
15
16			/**
17			* FileStream represents file stream.
18			*
19			* Example:
20			*
21			* ```php
22			* $stream = new FileSteam([
23			* 'filename' => '@app/files/items.txt',
24			* 'mode' => 'w+',
25			* ]);
26			*
27			* $stream->write('some content...');
28			* $stream->close();
29			* ```
30			*
31			* @author Paul Klimov <[email protected]>
32			* @since 2.1.0
33			*/
34			class FileStream extends BaseObject implements StreamInterface
35			{
36			/**
37			* @var string file or stream name.
38			* Path alias can be used here, for example: '@app/runtime/items.csv'.
39			* This field can also be PHP stream name, e.g. anything which can be passed to `fopen()`, for example: 'php://input'.
40			*/
41			public $filename;
42			/**
43			* @var string file open mode.
44			*/
45			public $mode = 'r';
46
47			/**
48			* @var resource\|null stream resource
49			*/
50			private $_resource;
51			/**
52			* @var array a resource metadata.
53			*/
54			private $_metadata;
55
56
57			/**
58			* Destructor.
59			* Closes the stream resource when destroyed.
60			*/
61			public function __destruct()
62			{
63			$this->close();
64			}
65
66			/**
67			* @return resource a file pointer resource.
68			* @throws InvalidConfigException if unable to open a resource.
69			*/
70			public function getResource()
71			{
72			if ($this->_resource === null) {
73			$resource = fopen(Yii::getAlias($this->filename), $this->mode);
74			if ($resource === false) {
75			throw new InvalidConfigException("Unable to open file '{$this->filename}' with mode '{$this->mode}'");
76			}
77			$this->_resource = $resource;
78			}
79			return $this->_resource;
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function __toString()
86			{
87			// __toString cannot throw exception
88			// use trigger_error to bypass this limitation
89			try {
90			$this->seek(0);
91			return $this->getContents();
92			} catch (\Exception $e) {
93			ErrorHandler::convertExceptionToError($e);
94			return '';
95			}
96			}
97
98			/**
99			* {@inheritdoc}
100			*/
101			public function close()
102			{
103			if ($this->_resource !== null) {
104			fclose($this->_resource);
105			$this->_resource = null;
106			$this->_metadata = null;
			0 ignored issues – show Documentation Bug introduced 2017-08-27 23:11 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$_metadata`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
107			}
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113			public function detach()
114			{
115			if ($this->_resource === null) {
116			return null;
117			}
118			$result = $this->_resource;
119			$this->_resource = null;
120			$this->_metadata = null;
			0 ignored issues – show Documentation Bug introduced 2017-08-27 23:11 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$_metadata`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
121			return $result;
122			}
123
124			/**
125			* {@inheritdoc}
126			*/
127			public function getSize()
128			{
129			$uri = $this->getMetadata('uri');
130			if (!empty($uri)) {
131			// clear the stat cache in case stream has a URI
132			clearstatcache(true, $uri);
133			}
134
135			$stats = fstat($this->getResource());
136			if (isset($stats['size'])) {
137			return $stats['size'];
138			}
139			return null;
140			}
141
142			/**
143			* {@inheritdoc}
144			*/
145			public function tell()
146			{
147			$result = ftell($this->getResource());
148			if ($result === false) {
149			throw new \RuntimeException('Unable to determine stream position');
150			}
151			return $result;
152			}
153
154			/**
155			* {@inheritdoc}
156			*/
157			public function eof()
158			{
159			return feof($this->getResource());
160			}
161
162			/**
163			* {@inheritdoc}
164			*/
165			public function isSeekable()
166			{
167			return (bool)$this->getMetadata('seekable');
168			}
169
170			/**
171			* {@inheritdoc}
172			*/
173			public function seek($offset, $whence = SEEK_SET)
174			{
175			if (fseek($this->getResource(), $offset, $whence) === -1) {
176			throw new \RuntimeException("Unable to seek to stream position '{$offset}' with whence '{$whence}'");
177			}
178			}
179
180			/**
181			* {@inheritdoc}
182			*/
183			public function rewind()
184			{
185			$this->seek(0);
186			}
187
188			/**
189			* {@inheritdoc}
190			*/
191			public function isWritable()
192			{
193			$mode = $this->getMetadata('mode');
194			foreach (['w', 'c', 'a', 'x', 'r+'] as $key) {
195			if (strpos($mode, $key) !== false) {
196			return true;
197			}
198			}
199			return false;
200			}
201
202			/**
203			* {@inheritdoc}
204			*/
205			public function write($string)
206			{
207			$result = fwrite($this->getResource(), $string);
208			if ($result === false) {
209			throw new \RuntimeException('Unable to write to stream');
210			}
211			return $result;
212			}
213
214			/**
215			* {@inheritdoc}
216			*/
217			public function isReadable()
218			{
219			$mode = $this->getMetadata('mode');
220			foreach (['r', 'w+', 'a+', 'c+', 'x+'] as $key) {
221			if (strpos($mode, $key) !== false) {
222			return true;
223			}
224			}
225			return false;
226			}
227
228			/**
229			* {@inheritdoc}
230			*/
231			public function read($length)
232			{
233			$string = fread($this->getResource(), $length);
234			if ($string === false) {
235			throw new \RuntimeException('Unable to read from stream');
236			}
237			return $string;
238			}
239
240			/**
241			* {@inheritdoc}
242			*/
243			public function getContents()
244			{
245			$contents = stream_get_contents($this->getResource());
246			if ($contents === false) {
247			throw new \RuntimeException('Unable to read stream contents');
248			}
249			return $contents;
250			}
251
252			/**
253			* {@inheritdoc}
254			*/
255			public function getMetadata($key = null)
256			{
257			if ($this->_metadata === null) {
258			$this->_metadata = stream_get_meta_data($this->getResource());
259			}
260
261			if ($key === null) {
262			return $this->_metadata;
263			}
264
265			return isset($this->_metadata[$key]) ? $this->_metadata[$key] : null;
266			}
267			}

yiisoft / yii2

Push — remove-yii-autoloader ( 560d61...5f8600 )

FileStream::tell() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like