BaseFilesystemItem::__construct() - Code Metrics - Inspection of "Merge pull request #121 for v0.2.1" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7b9015...c5b311 )

by Vladimir

created 2020-07-04 02:09 UTC

BaseFilesystemItem::__construct() A

↳ Parent: BaseFilesystemItem

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
ccs	9
cts	9
cp	1
crap	2

<?php

namespace allejo\stakx\Filesystem;

use allejo\stakx\Service;
use allejo\stakx\Filesystem\FilesystemLoader as fs;
use Symfony\Component\Filesystem\Exception\FileNotFoundException;

class BaseFilesystemItem extends \SplFileInfo
{
    /** @var string The path relative to the site's working directory. */
    protected $relativePath;

    /** @var string The original raw path given to the constructor. */
    protected $rawPath;

    /**
     * @param string $filePath an absolute file path or a path relative to the current working directory
     *
     * @since 0.2.0
     *
     * @throws FileNotFoundException
     */
    public function __construct($filePath)
    {
        $this->rawPath = $filePath;
        $realPath = fs::realpath($filePath);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        if ($realPath === false)
        {
            throw $this->buildNotFoundException();
        }

        parent::__construct($realPath);

        $this->relativePath = str_replace(Service::getWorkingDirectory() . DIRECTORY_SEPARATOR, '', $this->getAbsolutePath());

        $this->isSafeToRead();
    }

    /**
     * Whether or not this file exists on the filesystem.
     *
     * @return bool
     */
    public function exists()
    {
        return file_exists($this->getAbsolutePath());
    }

    /**
     * Get the absolute path to this file.
     *
     * @since 0.2.0
     *
     * @return string
     */
    public function getAbsolutePath()
    {
        return $this->getPathname();
    }

    /**
     * Get the path to the parent folder of this file.
     *
     * @since 0.2.0
     *
     * @return string
     */
    public function getParentFolder()
    {
        return $this->getPath();
    }

    /**
     * Get the file path to this file, relative to where it was created; likely the current working directory.
     *
     * @since 0.2.0
     *
     * @return string
     */
    public function getRelativeFilePath()
    {
        return $this->relativePath;
    }

    /**
     * Get the path to the parent folder this file, relative to where it was created; likely the current working directory.
     *
     * @since 0.2.0
     *
     * @return string
     */
    public function getRelativeParentFolder()
    {
        return dirname($this->getRelativeFilePath());
    }

    /**
     * Gets the last modified time.
     *
     * @return int The last modified time for the file, in a Unix timestamp
     */
    public function getLastModified()
    {
        return $this->getMTime();
    }

    /**
     * Get the full name of this file or folder.
     *
     * @return string
     */
    protected function getFullName()
    {
        return parent::getBasename();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    /**
     * Check if a file is safe to read.
     *
     * @throws FileNotFoundException
     */
    protected function isSafeToRead()
    {
        if (fs::isVFS($this->getAbsolutePath()))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        {
            return;
        }

        if (strpos($this->getAbsolutePath(), Service::getWorkingDirectory()) !== 0)
        {
            throw $this->buildNotFoundException();
        }
    }

    protected function buildNotFoundException()
    {
        return new FileNotFoundException(
            sprintf('The given path "%s" does not exist or is outside the website working directory', $this->rawPath),
            0,
            null,
            $this->rawPath
        );
    }
}


1		<?php
2
3		namespace allejo\stakx\Filesystem;
4
5		use allejo\stakx\Service;
6		use allejo\stakx\Filesystem\FilesystemLoader as fs;
7		use Symfony\Component\Filesystem\Exception\FileNotFoundException;
8
9		class BaseFilesystemItem extends \SplFileInfo
10		{
11		/** @var string The path relative to the site's working directory. */
12		protected $relativePath;
13
14		/** @var string The original raw path given to the constructor. */
15		protected $rawPath;
16
17		/**
18		* @param string $filePath an absolute file path or a path relative to the current working directory
19		*
20		* @since 0.2.0
21		*
22		* @throws FileNotFoundException
23		*/
24	180	public function __construct($filePath)
25		{
26	180	$this->rawPath = $filePath;
27	180	$realPath = fs::realpath($filePath);
		0 ignored issues – show Documentation introduced 2018-11-15 06:46 UTC by Report Bug Copy Issue Report `$filePath` is of type `string`, but the function expects a `object<string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
28
29	180	if ($realPath === false)
30		{
31	4	throw $this->buildNotFoundException();
32		}
33
34	177	parent::__construct($realPath);
35
36	177	$this->relativePath = str_replace(Service::getWorkingDirectory() . DIRECTORY_SEPARATOR, '', $this->getAbsolutePath());
37
38	177	$this->isSafeToRead();
39	177	}
40
41		/**
42		* Whether or not this file exists on the filesystem.
43		*
44		* @return bool
45		*/
46	158	public function exists()
47		{
48	158	return file_exists($this->getAbsolutePath());
49		}
50
51		/**
52		* Get the absolute path to this file.
53		*
54		* @since 0.2.0
55		*
56		* @return string
57		*/
58	177	public function getAbsolutePath()
59		{
60	177	return $this->getPathname();
61		}
62
63		/**
64		* Get the path to the parent folder of this file.
65		*
66		* @since 0.2.0
67		*
68		* @return string
69		*/
70	1	public function getParentFolder()
71		{
72	1	return $this->getPath();
73		}
74
75		/**
76		* Get the file path to this file, relative to where it was created; likely the current working directory.
77		*
78		* @since 0.2.0
79		*
80		* @return string
81		*/
82	150	public function getRelativeFilePath()
83		{
84	150	return $this->relativePath;
85		}
86
87		/**
88		* Get the path to the parent folder this file, relative to where it was created; likely the current working directory.
89		*
90		* @since 0.2.0
91		*
92		* @return string
93		*/
94	2	public function getRelativeParentFolder()
95		{
96	2	return dirname($this->getRelativeFilePath());
97		}
98
99		/**
100		* Gets the last modified time.
101		*
102		* @return int The last modified time for the file, in a Unix timestamp
103		*/
104	1	public function getLastModified()
105		{
106	1	return $this->getMTime();
107		}
108
109		/**
110		* Get the full name of this file or folder.
111		*
112		* @return string
113		*/
114	101	protected function getFullName()
115		{
116	101	return parent::getBasename();
		0 ignored issues – show Comprehensibility Bug introduced 2019-12-29 23:04 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getBasename()` instead of `getFullName()`). Are you sure this is correct? If so, you might want to change this to `$this->getBasename()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
117		}
118
119		/**
120		* Check if a file is safe to read.
121		*
122		* @throws FileNotFoundException
123		*/
124	177	protected function isSafeToRead()
125		{
126	177	if (fs::isVFS($this->getAbsolutePath()))
		0 ignored issues – show Documentation introduced 2018-11-15 06:46 UTC by Report Bug Copy Issue Report `$this->getAbsolutePath()` is of type `string`, but the function expects a `object<string>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
127		{
128	131	return;
129		}
130
131	51	if (strpos($this->getAbsolutePath(), Service::getWorkingDirectory()) !== 0)
132		{
133		throw $this->buildNotFoundException();
134		}
135	51	}
136
137	5	protected function buildNotFoundException()
138		{
139	5	return new FileNotFoundException(
140	5	sprintf('The given path "%s" does not exist or is outside the website working directory', $this->rawPath),
141	5	0,
142	5	null,
143	5	$this->rawPath
144		);
145		}
146		}
147

stakx-io / stakx

Push — master ( 7b9015...c5b311 )

BaseFilesystemItem::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like