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

<?php

declare(strict_types=1);

/**
 * array_pad()関数の使用例を示す関数
 *
 * array_pad()は、指定した長さになるように配列の末尾または先頭を特定の値で埋めます。
 */
function demonstrateArrayPad(): void
{
    // パディングの元となる配列
    $inputArray = ['Apple', 'Banana', 'Cherry'];
    echo '元の配列:' . PHP_EOL;
    print_r($inputArray);
    echo PHP_EOL;

    // --- 例1: 配列の末尾（右側）をパディング ---
    // 第2引数 $length に正の数を指定すると、配列の末尾が埋められます。
    // 配列の要素数が 5 になるまで、末尾に 'Orange' を追加します。
    $paddedRight = array_pad($inputArray, 5, 'Orange');
    echo '末尾をパディングして要素数を5にした配列:' . PHP_EOL;
    print_r($paddedRight);
    echo PHP_EOL;

    // --- 例2: 配列の先頭（左側）をパディング ---
    // 第2引数 $length に負の数を指定すると、配列の先頭が埋められます。
    // 配列の要素数が 6 になるまで、先頭に 'Kiwi' を追加します (|-6| = 6)。
    $paddedLeft = array_pad($inputArray, -6, 'Kiwi');
    echo '先頭をパディングして要素数を6にした配列:' . PHP_EOL;
    print_r($paddedLeft);
    echo PHP_EOL;

    // --- 例3: 指定した長さが元の配列の長さ以下の場合 ---
    // $length の絶対値が元の配列の要素数以下の場合、配列は変更されません。
    $notPadded = array_pad($inputArray, 2, 'Grape');
    echo '指定した長さが元の配列より短いため変更されない配列:' . PHP_EOL;
    print_r($notPadded);
}

// 関数を実行して結果を出力します
demonstrateArrayPad();

PHPのarray_pad関数は、指定した長さになるように配列の末尾または先頭を特定の値で埋めるために使用されます。この関数は、新しい配列を生成して返すため、元の配列は変更されません。

第一引数$arrayにはパディングの元となる配列を指定します。第二引数$lengthは、パディング後の目的の配列の長さを整数で指定します。この値が正の場合、配列の末尾（右側）が埋められます。例えば5を指定すると、要素数が5になるまで末尾に値が追加されます。負の場合、配列の先頭（左側）が埋められます。例えば-6を指定すると、絶対値が6となり、要素数が6になるまで先頭に値が追加されます。もし$lengthの絶対値が元の配列の要素数以下の場合、配列はパディングされず、元の配列のコピーがそのまま返されます。第三引数$valueには、パディングに使用する値を指定します。

サンプルコードでは、['Apple', 'Banana', 'Cherry']という配列を準備しています。 array_pad($inputArray, 5, 'Orange')の例では、$lengthに5を指定しているため、配列の末尾に'Orange'が追加され、要素数が5の新しい配列['Apple', 'Banana', 'Cherry', 'Orange', 'Orange']が生成されます。 次にarray_pad($inputArray, -6, 'Kiwi')の例では、$lengthに-6を指定しているため、配列の先頭に'Kiwi'が追加され、要素数が6の新しい配列['Kiwi', 'Kiwi', 'Kiwi', 'Apple', 'Banana', 'Cherry']が生成されます。 最後のarray_pad($inputArray, 2, 'Grape')の例では、$lengthの2が元の配列の要素数3よりも短いため、配列は変更されず、元の配列のコピーがそのまま返されることを確認できます。

<?php

/**
 * 文字列をコンマで分割し、結果の配列が指定された最小長になるようにパディングします。
 *
 * この関数は、`explode` を使用して文字列を配列に分割し、
 * その後 `array_pad` を使用して、配列が指定された最小長よりも短い場合に
 * デフォルト値で埋める方法を示します。これは、入力データが不完全である可能性のある
 * 情報源からのデータを正規化するのに役立ちます。
 *
 * @param string $dataString 解析する入力文字列 (例: "item1,item2")。
 * @param int $minLength 出力配列の希望する最小長。
 * @param mixed $padValue 配列が短すぎる場合にパディングに使用する値。
 * @return array 文字列から作成され、$minLength にパディングされた配列。
 */
function processAndPadStringToArray(string $dataString, int $minLength, mixed $padValue): array
{
    // 1. explode を使用して、コンマ区切りで文字列を配列に分割します。
    //    例: "apple,banana" は ["apple", "banana"] になります。
    //    例: "grape" は ["grape"] になります。
    $explodedArray = explode(',', $dataString);

    // 2. array_pad を使用して、配列が最小長に達していることを確認します。
    //    $explodedArray の要素数が $minLength よりも少ない場合、
    //    $minLength に達するまで $padValue でパディングされます。
    //    $explodedArray の要素数がすでに $minLength 以上の場合、配列は変更されません。
    $paddedArray = array_pad($explodedArray, $minLength, $padValue);

    return $paddedArray;
}

// --- 使用例 ---

// シナリオ 1: 入力文字列から生成された配列が最小長よりも短い場合
// 3つの要素 (果物の名前、色、産地) を期待しています。
$fruitData1 = "apple,red";
$processedFruit1 = processAndPadStringToArray($fruitData1, 3, "unknown");
// 期待される出力: ["apple", "red", "unknown"]
echo "処理 '{$fruitData1}': " . implode(", ", $processedFruit1) . PHP_EOL;

// シナリオ 2: 入力文字列から生成された配列がさらに短く、より多くのパディングが必要な場合
$fruitData2 = "grape";
$processedFruit2 = processAndPadStringToArray($fruitData2, 3, "N/A");
// 期待される出力: ["grape", "N/A", "N/A"]
echo "処理 '{$fruitData2}': " . implode(", ", $processedFruit2) . PHP_EOL;

// シナリオ 3: 入力文字列から生成された配列が最小長を満たすか、それを超える場合
// この場合、array_pad は配列を変更しません。
$fruitData3 = "banana,yellow,Ecuador";
$processedFruit3 = processAndPadStringToArray($fruitData3, 3, "unknown");
// 期待される出力: ["banana", "yellow", "Ecuador"]
echo "処理 '{$fruitData3}': " . implode(", ", $processedFruit3) . PHP_EOL;

// シナリオ 4: 入力文字列から生成された配列が最小長よりも長い場合
// array_pad は配列を変更しません。
$fruitData4 = "orange,orange,Florida,sweet";
$processedFruit4 = processAndPadStringToArray($fruitData4, 3, "unknown");
// 期待される出力: ["orange", "orange", "Florida", "sweet"]
echo "処理 '{$fruitData4}': " . implode(", ", $processedFruit4) . PHP_EOL;

PHPのarray_pad関数は、配列の要素数を指定された最小長まで埋めるために使用されます。このサンプルコードでは、まずexplode関数を用いてカンマ区切りの文字列を配列に分割し、その後array_padで配列の要素数を調整する方法を示しています。

explode関数は、第一引数に指定した区切り文字（この例ではカンマ ,）で第二引数の文字列を分割し、その結果を配列として返します。例えば、「apple,red」は["apple", "red"]となります。

次に登場するarray_pad関数は、第一引数に元の配列、第二引数に目標とする最小長、第三引数にパディング（埋め合わせ）に使う値を指定します。この関数は、元の配列の要素数が最小長よりも少ない場合にのみ、指定された値で配列の末尾に要素を追加し、新しい配列を返します。元の配列の要素数が最小長以上である場合、array_padは元の配列を変更せず、そのままの配列を返します。これにより、データが不完全な場合でも、常に一定の構造を持つ配列を生成し、後続の処理でエラーが発生しにくくすることができます。

サンプルコードのprocessAndPadStringToArray関数は、これらの機能を組み合わせ、入力文字列から作成された配列が、期待する最小長になるように調整する汎用的な処理を提供しています。これにより、データソースから受け取る情報が変動しても、統一された形式で扱えるようになります。