FileAbstract::getContent() - Code Metrics - crossjoin/Browscap - Measure and Improve Code Quality continuously with Scrutinizer

FileAbstract::getContent() A
last analyzed 2017-02-02 16:53 UTC

↳ Parent: FileAbstract

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	9
nc	3
nop	0

<?php
declare(strict_types=1);

namespace Crossjoin\Browscap\Source;

use Crossjoin\Browscap\Exception\SourceUnavailableException;

/**
 * Class FileAbstract
 *
 * @package Crossjoin\Browscap\Source
 * @author Christoph Ziegenberg <[email protected]>
 * @link https://github.com/crossjoin/browscap
 */
abstract class FileAbstract
{
    /**
     * @var string
     */
    protected $file;

    /**
     * File constructor.
     *
     * @param string $file
     *
     * @throws SourceUnavailableException
     */
    public function __construct(string $file)
    {
        $this->setFilePath($file);
    }

    /**
     * @return string
     */
    protected function getFilePath() : string
    {
        return $this->file;
    }

    /**
     * @param string $file
     *
     * @throws SourceUnavailableException
     */
    protected function setFilePath(string $file)
    {
        if (!$this->isFileReadable($file)) {
            if (!file_exists($file)) {
                throw new SourceUnavailableException("File '$file' does not exist.", 1458977223);
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            } else {
                throw new SourceUnavailableException("File '$file' exists but is not readable.", 1458977224);
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
            }
        }
        $this->file = $file;
    }

    /**
     * @param string $file
     *
     * @return bool
     */
    protected function isFileReadable(string $file) : bool
    {
        return is_readable($file);
    }

    /**
     * @inheritdoc
     *
     * @codeCoverageIgnore All covered, but analysis does't work with Generators.
     *
     * @throws SourceUnavailableException
     */
    public function getContent() : \Generator
    {
        $file = $this->getFilePath();

        $handle = @fopen($file, 'r');
        if ($handle !== false) {
            while (!feof($handle)) {
                yield fread($handle, 4096);
            }
            fclose($handle);
        } else {
            throw new SourceUnavailableException("Could not open file '$file' for reading.", 1458977225);
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
        }
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Crossjoin\Browscap\Source;
5
6			use Crossjoin\Browscap\Exception\SourceUnavailableException;
7
8			/**
9			* Class FileAbstract
10			*
11			* @package Crossjoin\Browscap\Source
12			* @author Christoph Ziegenberg <[email protected]>
13			* @link https://github.com/crossjoin/browscap
14			*/
15			abstract class FileAbstract
16			{
17			/**
18			* @var string
19			*/
20			protected $file;
21
22			/**
23			* File constructor.
24			*
25			* @param string $file
26			*
27			* @throws SourceUnavailableException
28			*/
29			public function __construct(string $file)
30			{
31			$this->setFilePath($file);
32			}
33
34			/**
35			* @return string
36			*/
37			protected function getFilePath() : string
38			{
39			return $this->file;
40			}
41
42			/**
43			* @param string $file
44			*
45			* @throws SourceUnavailableException
46			*/
47			protected function setFilePath(string $file)
48			{
49			if (!$this->isFileReadable($file)) {
50			if (!file_exists($file)) {
51			throw new SourceUnavailableException("File '$file' does not exist.", 1458977223);
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-09 08:55 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$file` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
52			} else {
53			throw new SourceUnavailableException("File '$file' exists but is not readable.", 1458977224);
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-09 08:55 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$file` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
54			}
55			}
56			$this->file = $file;
57			}
58
59			/**
60			* @param string $file
61			*
62			* @return bool
63			*/
64			protected function isFileReadable(string $file) : bool
65			{
66			return is_readable($file);
67			}
68
69			/**
70			* @inheritdoc
71			*
72			* @codeCoverageIgnore All covered, but analysis does't work with Generators.
73			*
74			* @throws SourceUnavailableException
75			*/
76			public function getContent() : \Generator
77			{
78			$file = $this->getFilePath();
79
80			$handle = @fopen($file, 'r');
81			if ($handle !== false) {
82			while (!feof($handle)) {
83			yield fread($handle, 4096);
84			}
85			fclose($handle);
86			} else {
87			throw new SourceUnavailableException("Could not open file '$file' for reading.", 1458977225);
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-09 08:55 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$file` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
88			}
89			}
90			}
91

crossjoin / Browscap

FileAbstract::getContent() A last analyzed 2017-02-02 16:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FileAbstract::getContent() A
last analyzed 2017-02-02 16:53 UTC