【PHP8.x】realpath関数の使い方

Copy
1<?php
2
3// realpath_cache_size の設定例
4
5// realpath キャッシュのサイズを 4MB に設定する
6ini_set('realpath_cache_size', '4M');
7
8// 現在の realpath キャッシュサイズを取得する
9$cache_size = ini_get('realpath_cache_size');
10
11echo "現在の realpath キャッシュサイズ: " . $cache_size . "\n";
12
13// realpath() を使用して絶対パスを取得する
14$relative_path = 'test.txt';
15$absolute_path = realpath($relative_path);
16
17if ($absolute_path === false) {
18    echo "ファイルが見つかりませんでした。\n";
19} else {
20    echo "相対パス: " . $relative_path . "\n";
21    echo "絶対パス: " . $absolute_path . "\n";
22}
23
24?>

このサンプルコードは、PHPのrealpath()関数とrealpath_cache_sizeの設定について解説しています。realpath()関数は、引数に指定された相対パスを絶対パスに変換します。もしファイルが存在しない場合はfalseを返します。

realpath_cache_sizeは、realpath()関数が変換したパスをキャッシュするサイズを設定するための設定です。キャッシュを利用することで、同じパスに対するrealpath()の呼び出しを高速化できます。サンプルコードでは、ini_set()関数を使ってrealpath_cache_sizeを4MBに設定しています。設定値はini_get()関数で確認できます。

コード例ではまず、realpath_cache_sizeを4MBに設定し、現在のキャッシュサイズを表示します。次に、test.txtという相対パスをrealpath()関数で絶対パスに変換しています。もしtest.txtが存在しなければ、「ファイルが見つかりませんでした。」と表示されます。存在する場合は、相対パスと絶対パスをそれぞれ表示します。

realpath()関数は、ファイルやディレクトリの存在確認や、パスの正規化に役立ちます。realpath_cache_sizeを適切に設定することで、パフォーマンスを向上させることができます。

Copy
1<?php
2
3/**
4 * 指定されたパスの絶対パスを返します。
5 * ファイルやディレクトリが存在しない場合でも、存在しないパスの絶対パスを返そうとします。
6 *
7 * @param string $path 相対パスまたは絶対パス
8 * @return string|false 絶対パス。エラー時は false
9 */
10function get_absolute_path(string $path): string|false
11{
12    // 一時ファイルを作成して、realpath() を利用する
13    $temp_file = tempnam(sys_get_temp_dir(), 'temp_');
14    if ($temp_file === false) {
15        return false;
16    }
17    unlink($temp_file); // 一時ファイルを削除
18
19    // 指定されたパスと一時ファイルを結合
20    $combined_path = $path . '/' . basename($temp_file);
21
22    // realpath() を使用して絶対パスを取得
23    $absolute_path = realpath($combined_path);
24
25    if ($absolute_path === false) {
26        return false;
27    }
28
29    // 最後に生成したファイル名を削除
30    $absolute_path = str_replace('/' . basename($temp_file), '', $absolute_path);
31    return $absolute_path;
32}
33
34// 使用例
35$relative_path = 'path/to/non/existing/file';
36$absolute_path = get_absolute_path($relative_path);
37
38if ($absolute_path !== false) {
39    echo "Absolute path: " . $absolute_path . PHP_EOL;
40} else {
41    echo "Failed to get absolute path." . PHP_EOL;
42}
43

このサンプルコードは、PHPのrealpath()関数を用いて、存在しないファイルやディレクトリを含むパスの絶対パスを取得する方法を示しています。通常のrealpath()関数は、ファイルやディレクトリが存在しない場合にfalseを返しますが、この例では、一時ファイルを作成し、それをパスに結合することで、存在しないパスでも絶対パスを解決しようと試みます。

まず、get_absolute_path()関数は、引数として相対パスまたは絶対パス $path を受け取ります。関数内部では、tempnam()関数を使って一時ファイルを作成し、そのファイル名をパスに結合します。次に、realpath()関数を用いて結合されたパスの絶対パスを取得します。最後に、一時ファイル名をパスから取り除くことで、元のパスに対応する絶対パスを返します。

realpath()関数が失敗した場合や、一時ファイルの作成に失敗した場合は、関数はfalseを返します。

使用例では、path/to/non/existing/fileという存在しない相対パスをget_absolute_path()関数に渡し、絶対パスを取得しています。取得した絶対パスは、成功すれば表示され、失敗すればエラーメッセージが表示されます。この手法は、例えば、設定ファイルが存在しない場合に、その設定ファイルを配置すべき絶対パスを動的に決定するような場合に役立ちます。