File
in package
AbstractYes
ファイル処理系。
Table of Contents
Methods
- appendContent() : int
- 追記。
- copy() : bool
- ファイルコピー。
- createEmptyFileIfNotExists() : void
- ファイルが存在しない場合に空ファイルの作成。
- createTemporaryFilePath() : string
- 一時ファイルの取得。
- createTemporaryFileStream() : Stream
- 一時ファイルのストリーム作成。
- createUniqueFilePath() : string
- 一意なファイルパスを取得。
- exists() : bool
- ファイルが存在するか。
- getFileSize() : int
- ファイルサイズを取得。
- readContent() : Binary
- ファイルの内容を取得。
- readJsonFile() : array<string|int, mixed>
- JSONとしてファイル読み込み。
- removeFile() : void
- ファイル削除。
- removeFileIfExists() : bool
- ファイルが存在する場合に削除する。
- writeContent() : int
- 書き込み。
- writeJsonFile() : int
- JSONファイルとして出力。
- saveContent() : int
- 対象ファイルに指定データを書き込み。
Methods
appendContent()
追記。
public
static appendContent(string $path, Binary $data) : int
Parameters
- $path : string
- $data : Binary
Tags
Return values
int —書き込みサイズ。
copy()
ファイルコピー。
public
static copy(string $fromPath, string $toPath) : bool
Parameters
- $fromPath : string
- $toPath : string
Tags
Return values
boolcreateEmptyFileIfNotExists()
ファイルが存在しない場合に空ファイルの作成。
public
static createEmptyFileIfNotExists(string $path) : void
touch ラッパー。
Parameters
- $path : string
Tags
createTemporaryFilePath()
一時ファイルの取得。
public
static createTemporaryFilePath([string $prefix = '' ]) : string
Parameters
- $prefix : string = ''
Return values
stringcreateTemporaryFileStream()
一時ファイルのストリーム作成。
public
static createTemporaryFileStream([Encoding|null $encoding = null ]) : Stream
メモリ・一時ファイル兼メモリのストリームを使用する場合は、
Stream::openMemory, Stream::openTemporary を参照のこと。
tmpfile ラッパー。
Parameters
- $encoding : Encoding|null = null
Tags
Return values
StreamcreateUniqueFilePath()
一意なファイルパスを取得。
public
static createUniqueFilePath(string $directoryPath, string $prefix) : string
tempnam ラッパー。
Parameters
- $directoryPath : string
-
ファイル名の親ディレクトリ。
- $prefix : string
-
プレフィックス。
Tags
Return values
stringexists()
ファイルが存在するか。
public
static exists(string $path) : bool
IOUtility::exists より速い。
file_existsよりis_fileの方が速いらすぃ
is_file ラッパー。
Parameters
- $path : string
Tags
Return values
bool —存在するか。
getFileSize()
ファイルサイズを取得。
public
static getFileSize(string $path) : int
Parameters
- $path : string
Tags
Return values
intreadContent()
ファイルの内容を取得。
public
static readContent(string $path) : Binary
Parameters
- $path : string
Tags
Return values
BinaryreadJsonFile()
JSONとしてファイル読み込み。
public
static readJsonFile(string $path[, JsonSerializer|null $jsonSerializer = null ]) : array<string|int, mixed>
Parameters
- $path : string
-
パス。
- $jsonSerializer : JsonSerializer|null = null
-
JSON処理
Tags
Return values
array<string|int, mixed> —応答JSON。
removeFile()
ファイル削除。
public
static removeFile(string $filePath) : void
Parameters
- $filePath : string
-
ファイルパス。
Tags
removeFileIfExists()
ファイルが存在する場合に削除する。
public
static removeFileIfExists(string $filePath) : bool
Parameters
- $filePath : string
Return values
boolwriteContent()
書き込み。
public
static writeContent(string $path, Binary $data) : int
Parameters
- $path : string
- $data : Binary
Tags
Return values
int —書き込みサイズ。
writeJsonFile()
JSONファイルとして出力。
public
static writeJsonFile(string $path, array<string|int, mixed>|object $data[, JsonSerializer|null $jsonSerializer = null ]) : int
Parameters
- $path : string
- $data : array<string|int, mixed>|object
- $jsonSerializer : JsonSerializer|null = null
-
JSON処理
Tags
Return values
int —書き込みサイズ。
saveContent()
対象ファイルに指定データを書き込み。
private
static saveContent(string $path, Binary $data, bool $append) : int
Parameters
- $path : string
- $data : Binary
- $append : bool
Tags
Return values
int —書き込みサイズ。