［PHP］配列操作：key関数の使い方完全ガイド – 配列の内部ポインタとキー取得

はじめに

PHPのkey関数は、配列の内部ポインタが現在指している要素のキーを取得する関数です。配列の走査や操作において、現在の位置を把握するために重要な役割を果たします。

この記事では、key関数の基本的な使い方から実践的な応用例まで、詳しく解説していきます。

key関数とは？

key関数は、配列の内部ポインタが現在指している要素のキー（添字）を返す関数です。配列には見えない「内部ポインタ」があり、このポインタが指している要素のキーを取得できます。

基本構文

key(array $array): mixed

パラメータ

$array: キーを取得したい配列

戻り値

現在の要素のキー（文字列または数値）
内部ポインタが有効な要素を指していない場合はnull

内部ポインタとは？

PHPの配列には「内部ポインタ」という概念があります：

<?php
$fruits = ['apple', 'banana', 'orange'];

// 配列作成時、内部ポインタは最初の要素を指している
echo key($fruits);     // 0（最初の要素のキー）
echo current($fruits); // apple（最初の要素の値）

// next()で内部ポインタを次に移動
next($fruits);
echo key($fruits);     // 1
echo current($fruits); // banana

// さらに次へ
next($fruits);
echo key($fruits);     // 2
echo current($fruits); // orange
?>

基本的な使い方

連想配列でのキー取得

<?php
$person = [
    'name' => '田中太郎',
    'age' => 30,
    'city' => '東京'
];

// 最初のキーを取得
echo key($person); // name

// 内部ポインタを移動してキーを取得
next($person);
echo key($person); // age

next($person);
echo key($person); // city
?>

数値配列でのキー取得

<?php
$numbers = [10, 20, 30, 40, 50];

echo key($numbers); // 0

next($numbers);
echo key($numbers); // 1

// 内部ポインタを最後に移動
end($numbers);
echo key($numbers); // 4（最後の要素のインデックス）
?>

ポインタ操作関数との組み合わせ

<?php
$data = ['a' => 1, 'b' => 2, 'c' => 3];

// 最初に戻す
reset($data);
echo key($data); // a

// 最後に移動
end($data);
echo key($data); // c

// 一つ前に戻る
prev($data);
echo key($data); // b

// 範囲外に移動した場合
next($data); // c を指す
next($data); // 範囲外
var_dump(key($data)); // null
?>

実践的な活用例

each関数の代替実装

PHP 7.2で非推奨になったeach関数の代替：

<?php
function myEach(&$array) {
    $key = key($array);
    $value = current($array);
    
    if ($key !== null) {
        next($array);
        return [
            0 => $key,
            1 => $value,
            'key' => $key,
            'value' => $value
        ];
    }
    
    return false;
}

// 使用例
$data = ['name' => '太郎', 'age' => 25];
reset($data);

while (($item = myEach($data)) !== false) {
    echo "キー: {$item['key']}, 値: {$item['value']}\n";
}
// 出力:
// キー: name, 値: 太郎
// キー: age, 値: 25
?>

配列の現在位置追跡

<?php
class ArrayIterator {
    private $array;
    
    public function __construct($array) {
        $this->array = $array;
        reset($this->array);
    }
    
    public function getCurrentKey() {
        return key($this->array);
    }
    
    public function getCurrentValue() {
        return current($this->array);
    }
    
    public function next() {
        return next($this->array);
    }
    
    public function hasMore() {
        return key($this->array) !== null;
    }
    
    public function getPosition() {
        $keys = array_keys($this->array);
        $currentKey = key($this->array);
        
        if ($currentKey === null) {
            return -1; // 範囲外
        }
        
        return array_search($currentKey, $keys);
    }
}

// 使用例
$iterator = new ArrayIterator(['a', 'b', 'c', 'd']);

while ($iterator->hasMore()) {
    printf(
        "位置: %d, キー: %s, 値: %s\n",
        $iterator->getPosition(),
        $iterator->getCurrentKey(),
        $iterator->getCurrentValue()
    );
    $iterator->next();
}
?>

配列の部分的な処理

<?php
function processFromKey($array, $startKey) {
    // 指定されたキーまで内部ポインタを移動
    reset($array);
    while (key($array) !== null && key($array) !== $startKey) {
        next($array);
    }
    
    $result = [];
    
    // 現在の位置から最後まで処理
    while (key($array) !== null) {
        $currentKey = key($array);
        $currentValue = current($array);
        
        $result[$currentKey] = $currentValue * 2; // 例：値を2倍
        
        next($array);
    }
    
    return $result;
}

// 使用例
$numbers = [
    'first' => 10,
    'second' => 20,
    'third' => 30,
    'fourth' => 40
];

$processed = processFromKey($numbers, 'second');
print_r($processed);
// 出力:
// Array
// (
//     [second] => 40
//     [third] => 60
//     [fourth] => 80
// )
?>

カスタムループ処理

<?php
function customLoop($array, $callback) {
    reset($array);
    $index = 0;
    
    while (key($array) !== null) {
        $currentKey = key($array);
        $currentValue = current($array);
        
        // コールバック関数を実行
        $result = $callback($currentKey, $currentValue, $index);
        
        // falseが返されたらループを終了
        if ($result === false) {
            break;
        }
        
        next($array);
        $index++;
    }
}

// 使用例
$products = [
    'laptop' => 80000,
    'mouse' => 2000,
    'keyboard' => 5000,
    'monitor' => 30000
];

customLoop($products, function($key, $value, $index) {
    echo "商品{$index}: {$key} - ¥{$value}\n";
    
    // 値段が10000円以上の商品で処理を停止
    if ($value >= 10000) {
        echo "高額商品が見つかりました。処理を終了します。\n";
        return false;
    }
    
    return true;
});
?>

ループ処理での活用

while文での配列走査

<?php
$config = [
    'database' => 'mysql',
    'host' => 'localhost',
    'port' => 3306,
    'charset' => 'utf8mb4'
];

reset($config);

while (key($config) !== null) {
    $key = key($config);
    $value = current($config);
    
    echo "{$key}: {$value}\n";
    
    next($config);
}
?>

条件付きループ

<?php
function findKeyByValue($array, $searchValue) {
    reset($array);
    
    while (key($array) !== null) {
        if (current($array) === $searchValue) {
            return key($array);
        }
        next($array);
    }
    
    return null; // 見つからない場合
}

// 使用例
$colors = [
    'red' => '#FF0000',
    'green' => '#00FF00',
    'blue' => '#0000FF'
];

$foundKey = findKeyByValue($colors, '#00FF00');
echo $foundKey; // green
?>

パフォーマンスと注意点

メモリ効率的な大配列の処理

<?php
function processLargeArray($array) {
    reset($array);
    $processedCount = 0;
    
    while (key($array) !== null) {
        $currentKey = key($array);
        $currentValue = current($array);
        
        // メモリ効率を考慮した処理
        // 一度に全体をコピーせず、一つずつ処理
        
        if ($processedCount % 1000 === 0) {
            echo "処理済み: {$processedCount}件\n";
            // ガベージコレクションを促進
            gc_collect_cycles();
        }
        
        // 実際の処理をここに記述
        // ...
        
        next($array);
        $processedCount++;
    }
    
    return $processedCount;
}
?>

参照渡しの重要性

<?php
function demonstrateReference() {
    $original = ['a' => 1, 'b' => 2, 'c' => 3];
    
    // 値渡し（コピーが作成される）
    function processValueCopy($array) {
        next($array);
        return key($array);
    }
    
    // 参照渡し（元の配列の内部ポインタを操作）
    function processReference(&$array) {
        next($array);
        return key($array);
    }
    
    reset($original);
    echo "元の配列の現在キー: " . key($original) . "\n"; // a
    
    $result1 = processValueCopy($original);
    echo "値渡し後の結果: {$result1}\n";              // b
    echo "元の配列の現在キー: " . key($original) . "\n"; // a（変更されない）
    
    $result2 = processReference($original);
    echo "参照渡し後の結果: {$result2}\n";              // b
    echo "元の配列の現在キー: " . key($original) . "\n"; // b（変更される）
}

demonstrateReference();
?>

トラブルシューティング

よくあるエラーと対処法

<?php
// 1. 空配列での使用
$empty = [];
var_dump(key($empty)); // null

// 2. 非配列データでの使用
$notArray = "string";
// key($notArray); // Fatal error: key() expects parameter 1 to be array

// 3. 安全な key() の使用
function safeKey($data) {
    if (!is_array($data)) {
        return null;
    }
    
    if (empty($data)) {
        return null;
    }
    
    return key($data);
}

// 4. 内部ポインタがリセットされる操作
$array = ['a' => 1, 'b' => 2, 'c' => 3];
next($array);
echo key($array); // b

// 配列を変更すると内部ポインタがリセットされる場合がある
$array['d'] = 4;
echo key($array); // 実装依存（通常はリセットされる）

// 5. foreachループ後の内部ポインタ
$data = [1, 2, 3, 4, 5];
foreach ($data as $value) {
    // foreachは内部ポインタに影響しない（PHP 7以降）
}
echo key($data); // 0（最初の要素を指している）
?>

現代的な代替手法

イテレータの使用

<?php
// ArrayIteratorを使用した現代的なアプローチ
$data = ['name' => '太郎', 'age' => 30, 'city' => '東京'];

$iterator = new ArrayIterator($data);

foreach ($iterator as $key => $value) {
    echo "キー: {$key}, 値: {$value}\n";
}

// または手動でイテレート
$iterator->rewind();
while ($iterator->valid()) {
    echo "キー: " . $iterator->key() . ", 値: " . $iterator->current() . "\n";
    $iterator->next();
}
?>

Generator を使用した効率的な処理

<?php
function arrayKeyValueGenerator($array) {
    reset($array);
    
    while (key($array) !== null) {
        yield key($array) => current($array);
        next($array);
    }
}

// 使用例
$largeData = range(1, 1000000);
$assocData = array_combine($largeData, $largeData);

foreach (arrayKeyValueGenerator($assocData) as $key => $value) {
    if ($key > 10) break; // 最初の10個だけ処理
    echo "キー: {$key}, 値: {$value}\n";
}
?>