【PHP8.x】SplStack::add()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplStack::add メソッドの使用例
5 *
6 * SplStack は、LIFO (Last In, First Out) のデータ構造であるスタックを
7 * 実装するためのクラスです。
8 * add メソッドは、SplDoublyLinkedList::add のエイリアスであり、
9 * スタック内の指定されたインデックスに要素を挿入するために使用されます。
10 * これは通常のスタック操作 (push/pop) とは異なり、任意のインデックスへの挿入が可能です。
11 *
12 * 【重要】
13 * このコードは、プロンプトのリファレンス情報で指定された `SplStack::add` メソッドに基づいています。
14 * PHP 8 の公式ドキュメントによると、`SplStack::add` の引数順序は `(int $index, mixed $value)` です。
15 * このコードはその正確なシグネチャに準拠しています。
16 */
17function demonstrateSplStackAdd(): void
18{
19    // SplStack のインスタンスを作成
20    $stack = new SplStack();
21
22    // SplStack のイテレーションモードを設定
23    // IT_MODE_LIFO: LIFO (Last In, First Out) 順でイテレーションします。
24    // IT_MODE_KEEP: イテレーション中に要素をスタックから削除しないようにします
25    //               (デフォルトではイテレーション中に要素が削除されます)。
26    $stack->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP);
27
28    echo "--- 初期スタックの状態 (pushで追加) ---\n";
29    // 通常のスタック操作で要素を追加
30    // push はスタックの末尾 (論理的な最上部) に要素を追加します。
31    $stack->push('Apple');  // 内部的なインデックス 0
32    $stack->push('Banana'); // 内部的なインデックス 1
33    $stack->push('Cherry'); // 内部的なインデックス 2 (スタックの最上部)
34
35    echo "スタックの要素数: " . $stack->count() . "\n";
36    echo "スタックの内容 (LIFO順でイテレーション): ";
37    // LIFO (Last In, First Out) のため、最後に追加された要素から表示されます。
38    foreach ($stack as $item) {
39        echo $item . " "; // 出力例: Cherry Banana Apple
40    }
41    echo "\n";
42    echo "スタックの最上部 (top()): " . $stack->top() . "\n"; // 出力例: Cherry
43
44    // SplStack::add(int $index, mixed $value) メソッドを使って要素を特定のインデックスに挿入
45    echo "\n--- SplStack::add(\$index, \$value) メソッドの使用例 ---\n";
46
47    // インデックス 1 の位置に 'Grape' を挿入
48    // 元のスタックの内部的な順序: [Apple (0), Banana (1), Cherry (2)]
49    // add(1, 'Grape') 後: [Apple (0), Grape (1), Banana (2), Cherry (3)]
50    // 最上部は 'Cherry' のままです。
51    $stack->add(1, 'Grape');
52
53    echo "スタックに 'Grape' をインデックス 1 に追加後:\n";
54    echo "スタックの要素数: " . $stack->count() . "\n";
55    echo "スタックの内容 (LIFO順でイテレーション): ";
56    foreach ($stack as $item) {
57        echo $item . " "; // 出力例: Cherry Banana Grape Apple
58    }
59    echo "\n";
60    echo "スタックの最上部 (top()): " . $stack->top() . "\n"; // 出力例: Cherry
61
62    // インデックス -1 (末尾) に 'Orange' を挿入
63    // `add(-1, $value)` は、スタックの末尾 (現在の最上部の次) に要素を追加します。
64    // この場合、追加された 'Orange' が新しいスタックの最上部になります。
65    // 内部的な順序: [Apple, Grape, Banana, Cherry, Orange]
66    $stack->add(-1, 'Orange');
67
68    echo "\nスタックに 'Orange' を末尾 (インデックス -1) に追加後:\n";
69    echo "スタックの要素数: " . $stack->count() . "\n";
70    echo "スタックの内容 (LIFO順でイテレーション): ";
71    foreach ($stack as $item) {
72        echo $item . " "; // 出力例: Orange Cherry Banana Grape Apple
73    }
74    echo "\n";
75    echo "スタックの最上部 (top()): " . $stack->top() . "\n"; // 出力例: Orange
76
77    // 通常のスタック操作 (pop) の確認
78    echo "\n--- 通常のスタック操作 (pop) の確認 ---\n";
79    echo "現在の最上部 (top()): " . $stack->top() . "\n"; // 'Orange'
80    echo "要素を pop: " . $stack->pop() . "\n"; // 'Orange' が削除され、返される
81    echo "新しい最上部 (top()): " . $stack->top() . "\n"; // 'Cherry'
82
83    echo "\n残りのスタック (LIFO順でイテレーション): ";
84    foreach ($stack as $item) {
85        echo $item . " "; // 出力例: Cherry Banana Grape Apple
86    }
87    echo "\n";
88}
89
90// 関数を実行して、SplStack::add の動作を確認
91demonstrateSplStackAdd();
92

PHPのSplStackクラスは、LIFO（Last In, First Out）という原則に従って要素を管理するスタックデータ構造を実装します。SplStack::addメソッドは、このスタック内の指定された位置に要素を挿入するために使用されます。これは通常のスタック操作である要素の追加（push）や取り出し（pop）とは異なり、スタックの中間や末尾にも要素を挿入できる柔軟な機能を提供します。

このメソッドは、引数として最初に挿入したい値（mixed $value）、次にその値を挿入するインデックス（int $index）を受け取ります。インデックス0はスタックの論理的な先頭を、正の数は先頭からの位置を、そして負の数（例えば-1）はスタックの末尾、つまり現在の最上部の次に要素を挿入する位置を示します。このメソッドは要素を挿入するだけで、特に値を返しません。

サンプルコードでは、まずpushで「Apple」「Banana」「Cherry」をスタックに追加し、この時点では「Cherry」が最上部となります。次にadd('Grape', 1)と記述することで、スタックの内部的なインデックス1の位置に「Grape」が挿入され、既存の要素が後ろにずれますが、最上部は依然として「Cherry」です。さらにadd('Orange', -1)と指定すると、スタックの末尾、現在の最上部であった「Cherry」の次に「Orange」が挿入され、「Orange」が新しい最上部となります。その後popメソッドで最上部の要素を取り出すと、「Orange」が削除され、「Cherry」が次の最上部となることが確認できます。このように、addメソッドはスタックの任意の場所への要素挿入を可能にし、より細かなデータ操作を実現します。

Copy
1<?php
2
3/**
4 * 文字列にバックスラッシュを追加して、データベースクエリなどで特殊文字をエスケープする例を示します。
5 *
6 * addslashes() 関数は、シングルクォート ('), ダブルクォート ("),
7 * バックスラッシュ (\) および NULL 文字に対してバックスラッシュを追加します。
8 * これは主に、データベースに文字列を挿入する際のエスケープ処理に使われることがありますが、
9 * 現代のPHP開発では、SQLインジェクション攻撃を防ぐために、PDOなどのプリペアドステートメントを使用することが強く推奨されます。
10 * addslashes() を直接使用する機会は非常に少なくなっていますが、関数の基本的な動作を理解する目的で示します。
11 */
12function demonstrateAddSlashes(): void
13{
14    // エスケープしたい元の文字列を定義します。
15    // シングルクォート、ダブルクォート、バックスラッシュ、NULL文字が含まれています。
16    $originalString = "これは '引用符' と \"ダブルクォート\"、そして \\バックスラッシュ\\ を含む文字列です。\0NULL文字も含まれます。";
17    echo "元の文字列: " . $originalString . PHP_EOL;
18
19    // addslashes() 関数を適用して文字列をエスケープします。
20    $escapedString = addslashes($originalString);
21    echo "エスケープ後の文字列: " . $escapedString . PHP_EOL;
22
23    echo PHP_EOL;
24
25    // 実際のアプリケーションでのより具体的な使用例（推奨される方法ではありません）
26    $userName = "O'Reilly"; // 名前にシングルクォートが含まれる場合
27    $userComment = "Hello! It's a \"great\" day.\\ What do you think?"; // コメントにダブルクォートやバックスラッシュが含まれる場合
28
29    echo "元のユーザー名: " . $userName . PHP_EOL;
30    echo "エスケープ後のユーザー名: " . addslashes($userName) . PHP_EOL;
31
32    echo "元のユーザーコメント: " . $userComment . PHP_EOL;
33    echo "エスケープ後のユーザーコメント: " . addslashes($userComment) . PHP_EOL;
34
35    // 注意: 上記のaddslashesの使用は、SQLインジェクション対策として不十分な場合があります。
36    // データベースとのやり取りには、必ずプリペアドステートメント（例: PDO）を使用してください。
37    // 例:
38    // $pdo = new PDO("mysql:host=localhost;dbname=testdb", "user", "pass");
39    // $stmt = $pdo->prepare("INSERT INTO users (name, comment) VALUES (:name, :comment)");
40    // $stmt->execute([':name' => $userName, ':comment' => $userComment]);
41}
42
43// 関数を実行して、addslashesの動作を確認します。
44demonstrateAddSlashes();
45

PHPのaddslashes()関数は、特定の特殊文字の前にバックスラッシュを追加することで、それらの文字をエスケープする役割があります。これは主に、データベースに文字列を挿入する際に、SQLクエリが正しく解釈されるようにするために利用されていました。

エスケープの対象となる文字は、シングルクォート (')、ダブルクォート ("), バックスラッシュ (\), そしてNULL文字 (\0) です。この関数は、エスケープしたい文字列を唯一の引数として受け取ります。戻り値としては、特殊文字がエスケープされた新しい文字列を返します。

サンプルコードでは、シングルクォートやダブルクォート、バックスラッシュ、NULL文字を含む元の文字列にaddslashes()関数を適用し、どのようにエスケープされるかを確認できます。例えば、「O'Reilly」という文字列は「O'Reilly」のように変換されます。

しかし、現代のPHP開発においては、セキュリティの観点からaddslashes()をデータベースクエリに直接使用することは推奨されません。SQLインジェクション攻撃を防ぐため、PDOなどのプリペアドステートメントを用いることが強く推奨されており、これにより安全かつ効率的にデータを処理できます。addslashes()は、関数の基本的な動作を理解するため、または特定の非データベース用途でのエスケープに限定して使用されることがほとんどです。