Docs For Class PATH

static string absoluteToRelative(
string
$base, string
$path)

絶対パスを相対パスに変換します。

$baseには相対パスに変換するベースとなるパスを指定します。 $pathには変換したい絶対パスを指定します。

なお、変換後のディレクトリ区切は Windows 環境であろうとも "/" に統一されます。また、変換後の末尾には "/" は付かないことに注意してください。

Tags:

return:	生成された相対パス
access:	public

Parameters:

string	$base	ベースパス
string	$path	絶対パス

[ Top ]

static void addIndexFile(
string
$indexName)

標準のドキュメントとして認識されるファイル名を追加設定します。

標準では以下のファイル名が標準のドキュメントとして登録されています。

index.htm
index.html
index.php

5. index.cgi

Tags:

see:	PATH::excludeIndexFile()
access:	public

Parameters:

string

$indexName

追加したい標準のドキュメントのファイル名

[ Top ]

static void closedir(
resource
$dir_handle)

ディレクトリハンドルをクローズします。

PATH::closedirメソッドはPHP標準のclosedir関数のラッパーですが、特殊な処理は一切導入していません。これは一連のPATH::opendir、PATH::readdirメソッドに対する整合性を得るためにのみ用意されています。コードの視認性よりも高度な処理速度を要求する場合にはPHP標準のclosedir関数を直接利用します。（もっとも、そのような要求を貸すシステムでAg:PUREを使うこと自体が間違いでしょうが）

Tags:

access:

public

Parameters:

resource

$dir_handle

opendir関数で事前にオープンしたディレクトリハンドルのリソース

[ Top ]

static string excludeIndexFile(
string
$path)

パスの末尾から標準のドキュメントのファイル名を削除して返します。

ApacheなどのHTTPサーバでは、ファイル名が指定されずにディレクトリまでが指定されている場合に標準のドキュメントを自動的に探し出して出力する機能があります。 excludeIndexFileメソッドは指定のパスが標準のドキュメントを差している場合に削除して返します。例えば、"/upper/lower/index.htm"は"/upper/lower/"と変換されて返されます。標準のドキュメントを取り除いて結果として空のパスになってしまった場合には"./"が返されます。

標準のドキュメントではない場合には指定のパスがそのまま返されます。なお、返却値のディレクトリ区切は標準のドキュメントを削除したか否かにかかわらず、かつ Windows 環境であろうとも "/" に統一されます。

標準のドキュメントとして認識するファイル名はaddIndexFileメソッドで指定することが出来ます。

Tags:

return:	標準のドキュメントのファイル名が削除されたパス
see:	PATH::addIndexFile()
access:	public

Parameters:

string

$path

標準のドキュメントのファイル名を削除したいパス

[ Top ]

static string excludeTrailingPathDelimiter(
string
$path)

パス名の末尾がパスの区切文字だった場合に削除して返します。

パスの区切文字としては環境に関係なく"\"と"/"が認識されることに注意してください。

Tags:

return:	パス区切が削除された文字列
access:	public

Parameters:

string

$path

パス区切を削除したい文字列

[ Top ]

static int fileatime(
string
$filename)

ファイルの最終アクセス時刻を取得します。

PATH::fileatimeメソッドはPHP標準のfileatime関数のラッパーです。 PATH::fileatimeメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfileatime関数を呼び出します。

Tags:

return:	ファイルの最終アクセス時刻
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static int filectime(
string
$filename)

ファイルのinode変更時刻を取得します。

PATH::filectimeメソッドはPHP標準のfilectime関数のラッパーです。 PATH::filectimeメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfilectime関数を呼び出します。

Tags:

return:	ファイルのinode変更時刻
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static int filemtime(
string
$filename)

ファイルの更新時刻を取得します。

PATH::filemtimeメソッドはPHP標準のfilemtime関数のラッパーです。 PATH::filemtimeメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfilemtime関数を呼び出します。

Tags:

return:	ファイルの最終更新時刻
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static int filesize(
string
$filename)

ファイルのサイズを取得します。

PATH::filesizeメソッドはPHP標準のfilesize関数のラッパーです。 PATH::filesizeメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfilesize関数を呼び出します。

PHPの整数型は32bitの符号付き整数であるため、2GBを越えるファイルサイズは正常に取得できない可能性があることに注意してください。この制限はPHP標準のfilesize関数に依存しています。

Tags:

return:	ファイルのサイズ
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static string file_get_contents(
string
$filename, [bool
$use_include_path = null], [resource
$context = null], [int
$offset = null], [int
$maxlen = null])

ファイルの内容を全て文字列に読み込みます。

PATH::file_get_contentsメソッドはPHP標準のfile_get_contents関数のラッパーです。 PATH::file_get_contentsメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfile_get_contents関数を呼び出します。

Tags:

return:	読み込んだデータ。失敗した場合はfalse
access:	public

Parameters:

string	$filename	ファイル名
bool	$use_include_path	include_pathを含むか否か
resource	$context	コンテキスト
int	$offset	読み込みを開始するオフセット位置
int	$maxlen	読み込むデータの最大バイト数

[ Top ]

static int file_put_contents(
string
$filename, string
$data, [int
$flags = null], [resource
$context = null])

文字列をファイルに書き込みます。

PATH::file_put_contentsメソッドはPHP標準のfile_put_contents関数のラッパーです。 PATH::file_put_contentsメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfile_put_contents関数を呼び出します。

Tags:

return:	ファイルに書き込まれたバイト数。失敗した場合はfalse
access:	public

Parameters:

string	$filename	ファイル名
string	$data	書き込むデータ
int	$flags	処理フラグ
resource	$context	コンテキスト

[ Top ]

static resource fopen(
string
$filename, string
$mode, [bool
$use_include_path = null], [resource
$context = null])

ファイルまたは URL をオープンします。

PATH::fopenメソッドはPHP標準のfopen関数のラッパーです。 PATH::fopenメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してfopen関数を呼び出します。

Tags:

return:	ファイルポインタリソース。エラー時はfalse
access:	public

Parameters:

string	$filename	ファイル名
string	$mode	アクセス形式
bool	$use_include_path	include_pathを含むか否か
resource	$context	コンテキスト

[ Top ]

static string includeTrailingPathDelimiter(
string
$path, [bool
$envDepend = false])

パス名の末尾がパスの区切文字ではない場合に場合に区切文字を追加して返します。

パスの区切文字としては環境に関係なく"\"と"/"が認識されることに注意してください。

なお、追加が必要な場合に追加される区切文字は通常'/'になりますが、$envDepend引数にtrueを指定することで環境依存にすることが出来ます。環境依存で区切文字を追加する場合にはDIRECTORY_SEPARATOR定数が参照されます。

Tags:

return:	パス区切が追加された文字列
access:	public

Parameters:

string	$path	パス区切を追加したい文字列
bool	$envDepend	環境依存するか否か

[ Top ]

static bool is_dir(
string
$filename)

指定したファイルがディレクトリかどうかを調べます。

PATH::is_dirメソッドはPHP標準のis_dir関数のラッパーです。 PATH::is_dirメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してis_dir関数を呼び出します。

Tags:

return:	ディレクトリが存在するか否か
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static bool is_executable(
string
$filename)

ファイルが実行可能かどうかを調べます。

PATH::is_executableメソッドはPHP標準のis_executable関数のラッパーです。 PATH::is_executableメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してis_executable関数を呼び出します。

Tags:

return:	ファイルが存在し、ファイルが実行可能かどうか
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static bool is_file(
string
$filename)

指定したファイルが通常のファイルかどうかを調べます。

PATH::is_fileメソッドはPHP標準のis_file関数のラッパーです。 PATH::is_fileメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してis_file関数を呼び出します。

Tags:

return:	ファイルが存在し、それが通常ファイルであるか否か
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static bool is_readable(
string
$filename)

ファイルが読み込み可能かどうかを調べます。

PATH::is_readableメソッドはPHP標準のis_readable関数のラッパーです。 PATH::is_readableメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してis_readable関数を呼び出します。

Tags:

return:	ファイルが存在し、ファイルが読み込み可能かどうか
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static bool is_writable(
string
$filename)

ファイルが書き込み可能かどうかを調べます。

PATH::is_writableメソッドはPHP標準のis_writable関数のラッパーです。 PATH::is_writableメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してis_writable関数を呼び出します。

Tags:

return:	ファイルが存在し、ファイルが書き込み可能かどうか
access:	public

Parameters:

string

$filename

ファイルへのパス

[ Top ]

static bool mkdir(
string
$pathname, [int
$mode = null], [bool
$recursive = null], [resource
$context = null])

ディレクトリを作成します。

PATH::mkdirメソッドはPHP標準のmkdir関数のラッパーです。 PATH::mkdirメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してmkdir関数を呼び出します。

ただし、$recursive引数にtrueを指定した場合、Windows環境でファイルシステムの文字コードがShift JISの場合には致命的な不具合が発生する可能性があります。これはディレクトリ区切"\"がマルチバイトコードの2文字目に出現する可能性があるためです。

Tags:

return:	成功したか否か
access:	public

Parameters:

string	$pathname	パス
int	$mode	アクセス制限
bool	$recursive	必要な親ディレクトリを作成するか否か
resource	$context	コンテキスト

[ Top ]

static 成功した場合にディレクトリハンドルのリソース、失敗した場合にはFALSE opendir(
string
$path)

ディレクトリハンドルをオープンします。

PATH::opendirメソッドはPHP標準のopendir関数のラッパーです。 PATH::opendirメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してopendir関数を呼び出します。

Tags:

access:

public

Parameters:

string

$path

オープンするディレクトリのパス

[ Top ]

static 次のファイル名、見つからなかった場合にはFALSE readdir(
resource
$dir_handle)

ディレクトリから次のファイルのファイル名を返します。ファイル名はファイルシステム上に格納されている順番で返されます。

PATH::readdirメソッドはPHP標準のreaddir関数のラッパーです。 PATH::readdirメソッドは取得されたファイル名を自動的に内部エンコーディングに変換して返します。

Tags:

access:

public

Parameters:

resource

$dir_handle

opendir関数で事前にオープンしたディレクトリハンドルのリソース

[ Top ]

static string relativeToAbsolute(
string
$base, string
$path)

相対パスを絶対パスに変換します。

$baseには絶対パスに変換するベースとなるパスを指定します。 $pathには変換したい相対パスを指定します。変換に失敗した場合にはfalseが返されることに注意してください。変換に失敗するケースとしては、文字列がパスとして不正である、絶対パスへ変換不能、などが考えられます。

なお、変換後のディレクトリ区切は Windows 環境であろうとも "/" に統一されます。また、変換後の末尾には "/" は付かないことに注意してください。

Tags:

return:	生成された絶対パス
access:	public

Parameters:

string	$base	ベースパス
string	$path	相対パス

[ Top ]

static bool rename(
string
$oldname, 
$newname, [resource
$context = null], string
$$newname)

ファイルをリネームします。

PATH::renameメソッドはPHP標準のrename関数のラッパーです。 PATH::renameメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してrename関数を呼び出します。

Tags:

return:	成功したか否か
access:	public

Parameters:

string	$oldname	変更前の名前
string	$$newname	変更後の名前
resource	$context	コンテキスト
	$newname

[ Top ]

static bool rmdir(
string
$pathname, [resource
$context = null])

ディレクトリを削除します。

PATH::rmdirメソッドはPHP標準のrmdir関数のラッパーです。 PATH::rmdirメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してrmdir関数を呼び出します。

Tags:

return:	成功したか否か
access:	public

Parameters:

string	$pathname	パス
resource	$context	コンテキスト

[ Top ]

static array scandir(
string
$path, [int
$options = 0], [string
$regex = ""])

指定されたパスのファイルとディレクトリのリストを取得します。

scandirメソッドは指定のパスに存在するファイルとディレクトリを探し出して配列に格納して返します。取得する条件は$options引数に定数の論理和で指定します。

PATH::SCANDIR_GET_DIR ディレクトリを取得します。

PATH::SCANDIR_GET_FILE ファイルを取得します。

PATH::SCANDIR_GET_ANY 種類にかかわらず取得します。 PATH::SCANDIR_GET_DIRとPATH::SCANDIR_GET_FILEの論理和になります。

PATH::SCANDIR_GET_HIDDEN 先頭がピリオドの隠しファイルも取得したい場合に指定します。 Linuxでは通常、先頭がピリオドのファイルは隠しファイルになります。 (Windowsでは拡張子のみのファイルと認識されます) Apacheの設定ファイルである".htaccess"などがこれに当たります。また自分自身のディレクトリを表す"."や、親ディレクトリを表す".."も取得の対象になることに注意してください。

PATH::SCANDIR_MATCH_REGEX ファイル名、ディレクトリ名に$regex引数で指定した正規表現でマッチングを試行し、マッチした場合のみ取得します。マッチング処理にはpreg_match関数が利用されます。 $regex引数の内容はそのままpreg_match関数にパターンとして渡されます。

PATH::SCANDIR_ORDER_ASCENDING 取得されたファイルとディレクトリを昇順でソートしてから返します。

PATH::SCANDIR_ORDER_DESCENDING 取得されたファイルとディレクトリを降順でソートしてから返します。 PATH::SCANDIR_ORDER_ASCENDINGと共に指定した場合、PATH::SCANDIR_ORDER_ASCENDINGが優先されることに注意してください。

なお、PATH::SCANDIR_GET_DIRとPATH::SCANDIR_GET_FILEのどちらも指定されていない場合にはPATH::SCANDIR_GET_ANYが指定されている物として処理されます。また、ソート順序を表すPATH::SCANDIR_ORDER_ASCENDINGとPATH::SCANDIR_ORDER_DESCENDINGが共に指定されていない場合、PATH::SCANDIR_ORDER_ASCENDINGが指定されている物として昇順でソートして返します。

指定のパスがディレクトリとして存在しない場合にはfalseを返します。指定の条件にマッチするファイルとディレクトリが存在しない場合には空の配列を返します。

なお、scandirメソッドはPHP内部文字エンコーディングと、ファイルシステムの採用しているエンコーディングを自動変換します。自動変換に利用するエンコーディングの設定はpure.confに従うことに注意してください。 Windows環境などで日本語のフォルダ名を正常に取得したい場合には、pure.confのencoding.filesystemディレクティブを"SJIS-win"に設定する必要があります。

Tags:

return:	ファイルとディレクトリのリスト
access:	public

Parameters:

string	$path	ファイルとディレクトリのリストを作成したいディレクトリ
int	$options	取得オプション
string	$regex	ファイル名、ディレクトリ名とマッチされるパターン

[ Top ]

static bool unlink(
string
$filename, [resource
$context = null])

ファイルを削除します。

PATH::unlinkメソッドはPHP標準のunlink関数のラッパーです。 PATH::unlinkメソッドは指定されたパス名を自動的にファイルシステムのエンコーディングに変換してunlink関数を呼び出します。

Tags:

return:	成功したか否か
access:	public

Parameters:

string	$filename	ファイルへのパス
resource	$context	コンテキスト

[ Top ]

Class: PATH

Class Overview

Constants

Methods

Class Details

Class Methods

static method absoluteToRelative [line 77]

Tags:

Parameters:

static method addIndexFile [line 114]

Tags:

Parameters:

static method closedir [line 439]

Tags:

Parameters:

static method excludeIndexFile [line 136]

Tags:

Parameters:

static method excludeTrailingPathDelimiter [line 158]

Tags:

Parameters:

static method fileatime [line 346]

Tags:

Parameters:

static method filectime [line 360]

Tags:

Parameters:

static method filemtime [line 374]

Tags:

Parameters:

static method filesize [line 391]

Tags:

Parameters:

static method file_get_contents [line 299]

Tags:

Parameters:

static method file_put_contents [line 326]

Tags:

Parameters:

static method fopen [line 275]

Tags:

Parameters:

static method includeTrailingPathDelimiter [line 180]

Tags:

Parameters:

static method is_dir [line 202]

Tags:

Parameters:

static method is_executable [line 216]

Tags:

Parameters:

static method is_file [line 230]

Tags:

Parameters:

static method is_readable [line 244]

Tags:

Parameters:

static method is_writable [line 258]

Tags:

Parameters:

static method mkdir [line 498]

Tags:

Parameters:

static method opendir [line 405]

Tags:

Parameters:

static method readdir [line 420]

Tags:

Parameters:

static method relativeToAbsolute [line 45]

Tags:

Parameters:

static method rename [line 455]

Tags:

Parameters:

static method rmdir [line 521]

Tags:

Parameters:

static method scandir [line 610]

Tags: