File::exists() - Code Metrics - Inspection of "InputStream系クラス追加(未テスト)" - webstream-framework/WebStream - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/0.7.0 ( c0c2ef...83eb72 )

by Ryuichi

created 2016-02-07 13:23 UTC

File::exists() A

↳ Parent: File

Complexity

Conditions	3
Paths	3

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	3
eloc	3
nc	3
nop	0

<?php
namespace WebStream\IO;

use WebStream\Exception\Extend\IOException;

/**
 * File
 * 状態を表さないもの(ファイルパス等)はキャッシュし、
 * 状態を表すもの(存在チェク、ファイル種別、権限等)はキャッシュクリアし都度取得する
 * @author Ryuichi TANAKA.
 * @since 2016/02/05
 * @version 0.7
 */
class File
{
    /**
     * @var string ファイルパス
     */
    private $filePath;

    /**
     * @var string ファイル名
     */
    private $fileName;

    /**
     * @var string ファイル拡張子
     */
    private $fileExt;

    /**
     * constructor
     * @param string $filepath ファイルパス
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(stirng $filePath)
    {
        // realpathを含めてキャッシュクリア
        clearstatcache(true);

        if ($realpath = realpath($filePath)) {
            $this->filePath = $realpath;
            $this->fileName = basename($filePath);
            $this->fileExt = pathinfo($filePath, PATHINFO_FILENAME);
        }
    }

    /**
     * ファイル名を返却する
     * @return string ファイル名
     */
    public function getFileName()
    {
        return $this->fileName;
    }

    /**
     * ファイル拡張子を返却する
     * @return string ファイル拡張子
     */
    public function getFileExtension()
    {
        return $this->fileExt;
    }

    /**
     * ファイルパスを返却する
     * シンボリックリンクの場合、シンボリックリンクファイルパスを返却する
     * @return string ファイルパス
     */
    public function getFilePath()
    {
        return $this->filePath;
    }

    /**
     * ファイルパスを返却する
     * シンボリックリンクの場合、実ファイルパスを返却する
     * @throws IOException
     * @return string ファイルパス
     */
    public function getAbsoluteFilePath()
    {
        if ($this->isLink()) {
            $filePath = $this->filePath;
            while (@is_link($filePath)) {
                $linkPath = readlink($filePath);
                if ($linkPath === false) {
                    throw new IOException("Symbolic link read error: " . $filePath);
                }
                $filePath = $linkPath;
            }

            return $filePath;
        }

        return $this->getFilePath();
    }

    /**
     * 読み込み権限があるか返却する
     * @return bool ファイルが存在し、読み込み権限があればtrue
     */
    public function isReadable()
    {
        if (!$this->exists()) {
            return false;
        }

        // Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
        clearstatcache();

        return @is_readable($this->filePath);
    }

    /**
     * 書き込み権限があるか返却する
     * @return bool ファイルが存在し、書き込み権限があればtrue
     */
    public function isWritable()
    {
        if (!$this->exists()) {
            return false;
        }

        // Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
        clearstatcache();

        return @is_writable($this->filePath);
    }

    /**
     * 実行権限があるか返却する
     * @return bool ファイルが存在し、実行権限があればtrue
     */
    public function isExecutable()
    {
        if (!$this->exists()) {
            return false;
        }

        // Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
        clearstatcache();

        return @is_executable($this->filePath);
    }

    /**
     * ファイルかどうか
     * @return bool ファイルならtrue
     */
    public function isFile()
    {
        clearstatcache();

        return is_file($this->filePath);
    }

    /**
     * ディレクトリかどうか
     * @return bool ディレクトリならtrue
     */
    public function isDirectory()
    {
        clearstatcache();

        return is_dir($this->filePath);
    }

    /**
     * リンクかどうか
     * @return bool リンクならtrue
     */
    public function isLink()
    {
        // Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
        clearstatcache();

        // 読み込み不可のシンボリックリンクの場合、例外を発生させる
        if (!$this->isReadable()) {
            throw new IOException("No read access to " . $this->filePath);
        }

        return @is_link($this->filePath);
    }

    /**
     * ファイルサイズを返却する
     * ファイルが存在しなければ0
     * @return int ファイルサイズ
     */
    public function length()
    {
        $length = 0;

        if ($this->exists()) {
            $filePath = $this->getAbsoluteFilePath();
            $length = filesize($filePath);

            if ($length === false) {
                throw new IOException("Cannot get filesize of " . $filePath);
            }
        }

        return $length;
    }

    /**
     * ファイル(ディレクトリ、リンク含む)が存在するか
     * @return bool 存在すればtrue
     */
    public function exists()
    {
        // Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
        clearstatcache();

        return $this->isLink() || $this->isDirectory() || $this->isFile();
    }

}


1			<?php
2			namespace WebStream\IO;
3
4			use WebStream\Exception\Extend\IOException;
5
6			/**
7			* File
8			* 状態を表さないもの(ファイルパス等)はキャッシュし、
9			* 状態を表すもの(存在チェク、ファイル種別、権限等)はキャッシュクリアし都度取得する
10			* @author Ryuichi TANAKA.
11			* @since 2016/02/05
12			* @version 0.7
13			*/
14			class File
15			{
16			/**
17			* @var string ファイルパス
18			*/
19			private $filePath;
20
21			/**
22			* @var string ファイル名
23			*/
24			private $fileName;
25
26			/**
27			* @var string ファイル拡張子
28			*/
29			private $fileExt;
30
31			/**
32			* constructor
33			* @param string $filepath ファイルパス
			0 ignored issues – show Documentation introduced 2016-02-07 13:26 UTC by Report Bug Copy Issue Report There is no parameter named `$filepath`. Did you maybe mean `$filePath`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
34			*/
35			public function __construct(stirng $filePath)
36			{
37			// realpathを含めてキャッシュクリア
38			clearstatcache(true);
39
40			if ($realpath = realpath($filePath)) {
41			$this->filePath = $realpath;
42			$this->fileName = basename($filePath);
43			$this->fileExt = pathinfo($filePath, PATHINFO_FILENAME);
44			}
45			}
46
47			/**
48			* ファイル名を返却する
49			* @return string ファイル名
50			*/
51			public function getFileName()
52			{
53			return $this->fileName;
54			}
55
56			/**
57			* ファイル拡張子を返却する
58			* @return string ファイル拡張子
59			*/
60			public function getFileExtension()
61			{
62			return $this->fileExt;
63			}
64
65			/**
66			* ファイルパスを返却する
67			* シンボリックリンクの場合、シンボリックリンクファイルパスを返却する
68			* @return string ファイルパス
69			*/
70			public function getFilePath()
71			{
72			return $this->filePath;
73			}
74
75			/**
76			* ファイルパスを返却する
77			* シンボリックリンクの場合、実ファイルパスを返却する
78			* @throws IOException
79			* @return string ファイルパス
80			*/
81			public function getAbsoluteFilePath()
82			{
83			if ($this->isLink()) {
84			$filePath = $this->filePath;
85			while (@is_link($filePath)) {
86			$linkPath = readlink($filePath);
87			if ($linkPath === false) {
88			throw new IOException("Symbolic link read error: " . $filePath);
89			}
90			$filePath = $linkPath;
91			}
92
93			return $filePath;
94			}
95
96			return $this->getFilePath();
97			}
98
99			/**
100			* 読み込み権限があるか返却する
101			* @return bool ファイルが存在し、読み込み権限があればtrue
102			*/
103			public function isReadable()
104			{
105			if (!$this->exists()) {
106			return false;
107			}
108
109			// Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
110			clearstatcache();
111
112			return @is_readable($this->filePath);
113			}
114
115			/**
116			* 書き込み権限があるか返却する
117			* @return bool ファイルが存在し、書き込み権限があればtrue
118			*/
119			public function isWritable()
120			{
121			if (!$this->exists()) {
122			return false;
123			}
124
125			// Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
126			clearstatcache();
127
128			return @is_writable($this->filePath);
129			}
130
131			/**
132			* 実行権限があるか返却する
133			* @return bool ファイルが存在し、実行権限があればtrue
134			*/
135			public function isExecutable()
136			{
137			if (!$this->exists()) {
138			return false;
139			}
140
141			// Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
142			clearstatcache();
143
144			return @is_executable($this->filePath);
145			}
146
147			/**
148			* ファイルかどうか
149			* @return bool ファイルならtrue
150			*/
151			public function isFile()
152			{
153			clearstatcache();
154
155			return is_file($this->filePath);
156			}
157
158			/**
159			* ディレクトリかどうか
160			* @return bool ディレクトリならtrue
161			*/
162			public function isDirectory()
163			{
164			clearstatcache();
165
166			return is_dir($this->filePath);
167			}
168
169			/**
170			* リンクかどうか
171			* @return bool リンクならtrue
172			*/
173			public function isLink()
174			{
175			// Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
176			clearstatcache();
177
178			// 読み込み不可のシンボリックリンクの場合、例外を発生させる
179			if (!$this->isReadable()) {
180			throw new IOException("No read access to " . $this->filePath);
181			}
182
183			return @is_link($this->filePath);
184			}
185
186			/**
187			* ファイルサイズを返却する
188			* ファイルが存在しなければ0
189			* @return int ファイルサイズ
190			*/
191			public function length()
192			{
193			$length = 0;
194
195			if ($this->exists()) {
196			$filePath = $this->getAbsoluteFilePath();
197			$length = filesize($filePath);
198
199			if ($length === false) {
200			throw new IOException("Cannot get filesize of " . $filePath);
201			}
202			}
203
204			return $length;
205			}
206
207			/**
208			* ファイル(ディレクトリ、リンク含む)が存在するか
209			* @return bool 存在すればtrue
210			*/
211			public function exists()
212			{
213			// Fileオブジェクト作成後に属性が変わることを考慮しキャッシュクリアする
214			clearstatcache();
215
216			return $this->isLink() \|\| $this->isDirectory() \|\| $this->isFile();
217			}
218
219			}
220

webstream-framework / WebStream

Push — feature/0.7.0 ( c0c2ef...83eb72 )

File::exists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like