fileperms

(PHP 4, PHP 5, PHP 7, PHP 8)

filepermsファイルのパーミッションを取得する

説明

fileperms(string $filename): int|false

指定したファイルのパーミッションを取得します。

パラメータ

filename

ファイルへのパス。

戻り値

ファイルのパーミッションを数値モードで返します。このモードの下位ビットは chmod() に渡すのと同じ形式です。 しかし、大半のプラットフォームでは、それだけではなく filename のファイル形式に関する情報も含まれます。 以下の例で示すのは、ファイルのパーミッションやファイル形式を POSIX システム (Linux や macOS など) で調べる方法です。

ローカルファイルの場合、その戻り値は C ライブラリ関数 stat() が返す構造体の st_mode メンバーの値となります。 どのビットがセットされるかはプラットフォームによって異なるので、 パーミッション部分以外のビットをパースしたい場合は各プラットフォームのドキュメントを参照することをおすすめします。

失敗時に false を返します。

エラー / 例外

失敗したときは E_WARNING が発生します。

例1 八進形式でのパーミッションの表示

<?php
echo substr(sprintf('%o'fileperms('/tmp')), -4);
echo 
substr(sprintf('%o'fileperms('/etc/passwd')), -4);
?>

上の例の出力は以下となります。

1777
0644

例2 完全なパーミッションの表示

<?php
$perms 
fileperms('/etc/passwd');

switch (
$perms 0xF000) {
    case 
0xC000// ソケット
        
$info 's';
        break;
    case 
0xA000// シンボリックリンク
        
$info 'l';
        break;
    case 
0x8000// 通常のファイル
        
$info 'r';
        break;
    case 
0x6000// ブロックスペシャルファイル
        
$info 'b';
        break;
    case 
0x4000// ディレクトリ
        
$info 'd';
        break;
    case 
0x2000// キャラクタスペシャルファイル
        
$info 'c';
        break;
    case 
0x1000// FIFO パイプ
        
$info 'p';
        break;
    default: 
// 不明
        
$info 'u';
}

// 所有者
$info .= (($perms 0x0100) ? 'r' '-');
$info .= (($perms 0x0080) ? 'w' '-');
$info .= (($perms 0x0040) ?
            ((
$perms 0x0800) ? 's' 'x' ) :
            ((
$perms 0x0800) ? 'S' '-'));

// グループ
$info .= (($perms 0x0020) ? 'r' '-');
$info .= (($perms 0x0010) ? 'w' '-');
$info .= (($perms 0x0008) ?
            ((
$perms 0x0400) ? 's' 'x' ) :
            ((
$perms 0x0400) ? 'S' '-'));

// 全体
$info .= (($perms 0x0004) ? 'r' '-');
$info .= (($perms 0x0002) ? 'w' '-');
$info .= (($perms 0x0001) ?
            ((
$perms 0x0200) ? 't' 'x' ) :
            ((
$perms 0x0200) ? 'T' '-'));

echo 
$info;
?>

上の例の出力は以下となります。

-rw-r--r--

注意

注意: この関数の結果は キャッシュされます。詳細は、clearstatcache() を参照してください。

ヒント

PHP 5.0.0 以降、この関数は、 何らかの URL ラッパーと組合せて使用することができます。 どのラッパーが stat() ファミリーをサポートしているかを調べるには サポートするプロトコル/ラッパー を参照してください。

参考

  • chmod() - ファイルのモードを変更する
  • is_readable() - ファイルが存在し、読み込み可能であるかどうかを知る
  • stat() - ファイルに関する情報を取得する

関連キーワード:  取得, ファイル, 関数, 形式, 参照, fileperms, stat, filename, プラットフォーム, モード