Directory
in package
AbstractYes
ディレクトリ処理系。
Table of Contents
Constants
- DIRECTORY_PERMISSIONS = 0755
- ディレクトリ作成時の通常権限。
Methods
- cleanupDirectory() : void
- ディレクトリを破棄・作成する
- createDirectory() : bool
- ディレクトリ作成する。
- createDirectoryIfNotExists() : bool
- ディレクトリが存在しない場合に作成する。
- createParentDirectoryIfNotExists() : bool
- 対象パスの親ディレクトリが存在しない場合に親ディレクトリを作成する。
- exists() : bool
- ディレクトリが存在するか。
- find() : array<string|int, string>
- パターンに一致するファイル・ディレクトリ一覧取得。
- getChildren() : array<string|int, string>
- ファイル/ディレクトリ一覧を取得する。
- getDirectories() : array<string|int, string>
- ディレクトリ一覧を取得する。
- getFiles() : array<string|int, string>
- ファイル一覧を取得する。
- getTemporaryDirectory() : string
- 一時ディレクトリ取得。
- removeDirectory() : bool
- ディレクトリを削除する。 ファイル・ディレクトリはすべて破棄される。
- setTemporaryDirectory() : bool
- 一時ディレクトリ設定。
- getChildrenCore() : array<string|int, string>
- ファイル/ディレクトリ一覧を取得する。
Constants
DIRECTORY_PERMISSIONS
ディレクトリ作成時の通常権限。
public
mixed
DIRECTORY_PERMISSIONS
= 0755
Methods
cleanupDirectory()
ディレクトリを破棄・作成する
public
static cleanupDirectory(string $directoryPath[, int $permissions = self::DIRECTORY_PERMISSIONS ]) : void
Parameters
- $directoryPath : string
-
対象ディレクトリ。
- $permissions : int = self::DIRECTORY_PERMISSIONS
createDirectory()
ディレクトリ作成する。
public
static createDirectory(string $directoryPath[, int $permissions = self::DIRECTORY_PERMISSIONS ]) : bool
ディレクトリは再帰的に作成される。
mkdir ラッパー。
Parameters
- $directoryPath : string
-
ディレクトリパス。
- $permissions : int = self::DIRECTORY_PERMISSIONS
Tags
Return values
bool —作成出来たか。
createDirectoryIfNotExists()
ディレクトリが存在しない場合に作成する。
public
static createDirectoryIfNotExists(string $directoryPath[, int $permissions = self::DIRECTORY_PERMISSIONS ]) : bool
ディレクトリは再帰的に作成される。
Parameters
- $directoryPath : string
-
ディレクトリパス
- $permissions : int = self::DIRECTORY_PERMISSIONS
Return values
bool —作成出来たか。
createParentDirectoryIfNotExists()
対象パスの親ディレクトリが存在しない場合に親ディレクトリを作成する。
public
static createParentDirectoryIfNotExists(string $path[, int $permissions = self::DIRECTORY_PERMISSIONS ]) : bool
ディレクトリは再帰的に作成される。
Parameters
- $path : string
-
対象パス（メソッド自体はファイルパスとして使用することを前提としている）
- $permissions : int = self::DIRECTORY_PERMISSIONS
Return values
bool —作成されたか。
exists()
ディレクトリが存在するか。
public
static exists(string $path) : bool
is_dir ラッパー。
Parameters
- $path : string
Tags
Return values
bool —存在するか。
find()
パターンに一致するファイル・ディレクトリ一覧取得。
public
static find(string $directoryPath, string $wildcard) : array<string|int, string>
glob ラッパー。
Parameters
- $directoryPath : string
-
ディレクトリパス
- $wildcard : string
-
ワイルドカード。
Tags
Return values
array<string|int, string> —一覧。
getChildren()
ファイル/ディレクトリ一覧を取得する。
public
static getChildren(string $directoryPath, bool $recursive) : array<string|int, string>
Parameters
- $directoryPath : string
-
ディレクトリパス。
- $recursive : bool
-
再帰的に取得するか。
Return values
array<string|int, string> —ファイル一覧。
getDirectories()
ディレクトリ一覧を取得する。
public
static getDirectories(string $directoryPath, bool $recursive) : array<string|int, string>
Parameters
- $directoryPath : string
-
ディレクトリパス。
- $recursive : bool
-
再帰的に取得するか。
Return values
array<string|int, string> —ファイル一覧。
getFiles()
ファイル一覧を取得する。
public
static getFiles(string $directoryPath, bool $recursive) : array<string|int, string>
Parameters
- $directoryPath : string
-
ディレクトリパス。
- $recursive : bool
-
再帰的に取得するか。
Return values
array<string|int, string> —ファイル一覧。
getTemporaryDirectory()
一時ディレクトリ取得。
public
static getTemporaryDirectory() : string
sys_get_temp_di ラッパー。
Tags
Return values
stringremoveDirectory()
ディレクトリを削除する。 ファイル・ディレクトリはすべて破棄される。
public
static removeDirectory(string $directoryPath[, bool $recursive = false ]) : bool
Parameters
- $directoryPath : string
-
削除ディレクトリ。
- $recursive : bool = false
-
再帰的削除を行うか。
Tags
Return values
boolsetTemporaryDirectory()
一時ディレクトリ設定。
public
static setTemporaryDirectory(string $path) : bool
Parameters
- $path : string
Return values
boolgetChildrenCore()
ファイル/ディレクトリ一覧を取得する。
private
static getChildrenCore(string $directoryPath, bool $directory, bool $file, bool $recursive) : array<string|int, string>
Parameters
- $directoryPath : string
-
ディレクトリパス。
- $directory : bool
- $file : bool
- $recursive : bool
-
再帰的に取得するか。
Return values
array<string|int, string> —ファイル一覧。