Folder & File

Folder と File ユーティリティは、ファイルの読み書きやフォルダ内のファイル名一覧の取得、その他ディレクトリに関連するタスクにおいて便利なクラスです。

基本的な使い方

Folder と File クラスはオートロードされるため、そのままインスタンスを作成できます。新しいフォルダインスタンスは次のようにセットアップします。

$dir = new Folder('/path/to/folder');

インスタンスを作成したフォルダ内から .ctp の拡張子が付いたファイルを正規表現検索する場合はこのようにします。

$files = $dir->find('.*\.ctp');

これでファイルの読み込みや、コンテンツの書き込み、ファイルの削除などが行えるようになります。

foreach ($files as $file) {
    $file = new File($dir->pwd() . DS . $file);
    $contents = $file->read();
    // $file->write('このファイルの内容を上書きします');
    // $file->append('このファイルの最後に追記します。');
    // $file->delete(); // このファイルを削除します
    $file->close(); // 終了時にファイルをクローズしましょう
}

Folder API

class Folder(string $path = false, boolean $create = false, mixed $mode = false)

// 0755 のパーミッションで新しいフォルダを作成します
$dir = new Folder('/path/to/folder', true, 0755);

property Folder::$path

フォルダの現在のパス。Folder::pwd() も同じ情報を返します。

property Folder::$sort

ファイルリストを取得する際に、名前によるソートを実行するか否かの値。

property Folder::$mode

フォルダ作成時のモード。デフォルトは 0755 です。 Windows マシンでは何も影響しません。

static Folder::addPathElement(string $path, string $element)

戻り値の型: string

$path と $element の間に適切なスラッシュを加えて返します。

$path = Folder::addPathElement('/a/path/for', 'testing');
// $path は /a/path/for/testing となります

Added in version 2.5

2.5 から $element パラメータは配列も使用できます。

method Folder::cd(string $path)

method Folder::chmod(string $path, integer $mode = false, boolean $recursive = true, array $exceptions = [])

method Folder::copy(array|string $options = [])

static Folder::correctSlashFor(string $path)

戻り値の型: string

$path に与えるべき適切なスラッシュを返します。（Windows のパスは '\ で、その他のパスは '/'）

method Folder::create(string $pathname, integer $mode = false)

method Folder::delete(string $path = null)

method Folder::dirsize()

method Folder::errors()

method Folder::find(string $regexpPattern = '.*', boolean $sort = false)

NOTE

フォルダの find メソッドと findRecursive メソッドは、ファイルのみを検索します。フォルダとファイルを取得したい場合は、 Folder::read() もしくは Folder::tree() 参照してください。

method Folder::findRecursive(string $pattern = '.*', boolean $sort = false)

method Folder::inCakePath(string $path = '')

method Folder::inPath(string $path = '', boolean $reverse = false)

static Folder::isAbsolute(string $path)

戻り値の型: boolean

与えられた $path が絶対パスであれば true を返します。

static Folder::isSlashTerm(string $path)

戻り値の型: boolean

与えられた $path がスラッシュで終了していれば true を返します。（つまり、 slash-terminated）:

$result = Folder::isSlashTerm('/my/test/path');
// $result = false
$result = Folder::isSlashTerm('/my/test/path/');
// $result = true

static Folder::isWindowsPath(string $path)

戻り値の型: boolean

与えられた $path が Windows のパスであれば true を返します。

method Folder::messages()

method Folder::move(array $options)

static Folder::normalizePath(string $path)

戻り値の型: string

与えられた $path を適切なスラッシュに調整して返します。（Windows のパスは '\ で、その他のパスは '/'）

method Folder::pwd()

method Folder::read(boolean $sort = true, array|boolean $exceptions = false, boolean $fullPath = false)

method Folder::realpath(string $path)

static Folder::slashTerm(string $path)

戻り値の型: string

引数の $path に (Windows や、その他の OS で正しい) 終端のスラッシュを付けたパスを返します。

method Folder::tree(null|string $path = null, array|boolean $exceptions = true, null|string $type = null)

File API

class File(string $path, boolean $create = false, integer $mode = 755)

// 0644 のパーミッションで新しいファイルを作成します
$file = new File('/path/to/file.php', true, 0644);

property File::$Folder

ファイルが属するフォルダ・オブジェクト。

property File::$name

拡張子付きのファイル名。拡張子なしのファイル名を返す File::name() とは異なります。

property File::$info

ファイル情報の配列。代わりに File::info() を使用してください。

property File::$handle

ファイルをオープンしている場合のファイルハンドラを保持します。

property File::$lock

ファイルの読み書き時のロックを有効にします。

property File::$path

現在のファイルの絶対パス。

method File::append(string $data, boolean $force = false)

method File::close()

method File::copy(string $dest, boolean $overwrite = true)

method File::create()

method File::delete()

method File::executable()

method File::exists()

method File::ext()

method File::Folder()

method File::group()

method File::info()

method File::lastAccess()

method File::lastChange()

method File::md5(integer|boolean $maxsize = 5)

method File::name()

method File::offset(integer|boolean $offset = false, integer $seek = 0)

method File::open(string $mode = 'r', boolean $force = false)

method File::owner()

method File::perms()

<File::prepare(string> $data, boolean $forceWindows = false)

戻り値の型: string

ASCII 文字列をファイルへ書き出す事前処理を行います。現在の実行環境に合わせて改行文字を変換します。 Windows なら "\r\n" を、その他の環境なら "\n" が利用されます。

method File::pwd()

method File::read(string $bytes = false, string $mode = 'rb', boolean $force = false)

method File::readable()

method File::safe(string $name = null, string $ext = null)

method File::size()

method File::writable()

method File::write(string $data, string $mode = 'w', boolean$force = false)

Added in version 2.1

File::mime()

method File::mime()

method File::replaceText( $search, $replace )

双方のクラスの各メソッドの使い方について、より良い解説が必要です。

Folder & File ​

基本的な使い方 ​

Folder API ​

File API ​

Folder & File

基本的な使い方

Folder API

File API