【PHP8.x】fileperms関数の使い方
fileperms関数は、指定されたファイルまたはディレクトリのパーミッション(権限)情報を取得する関数です。パーミッションとは、ファイルやディレクトリに対して、誰がどのような操作(読み取り、書き込み、実行)を許可されているかを示す設定のことです。
この関数は、パーミッションを調べたいファイルまたはディレクトリのパスを引数として受け取ります。引数には、例えば /path/to/your/file.txt
のように、対象のパスを文字列で指定します。
関数が成功すると、そのパスが指す対象のパーミッションを整数値として返します。この戻り値の整数値は、通常、8進数表記(例: 0755
)で解釈されます。0755
という表記は、先頭の 0
が8進数であることを示し、続く 7
がファイルの所有者、最初の 5
がファイルのグループ、最後の 5
がその他のユーザーに対する権限を示しています。それぞれの数字は、読み取り、書き込み、実行の組み合わせに対応する特別な意味を持っています。
ファイルが存在しない場合や、パーミッションを取得するための適切な権限がない場合など、エラーが発生した際にはブール値の false
が返されます。そのため、この関数を使用する際には、戻り値が false
でないかを確認し、エラーハンドリングを行うことが重要です。取得した整数値を人間が読める8進数形式で表示したい場合は、PHPの sprintf()
関数などを用いると便利です。この関数は、主にUNIX系のファイルシステムにおけるパーミッション情報を扱う際に利用されます。
基本的な使い方
構文(syntax)
<?php
$filePath = 'path/to/your/file.txt';
$filePermissions = fileperms($filePath);
引数(parameters)
string $filename
- string $filename: ファイルのパーミッション情報を取得したいファイルパスを指定する文字列
戻り値(return)
int|false
指定されたファイルのパーミッションを整数値で返します。パーミッションの取得に失敗した場合は false を返します。