プログラミング

【PHP】可変長引数とは「点(ドット)3つ」 多次元連想配列の検索

PHP
【PHP】可変長引数とは「点(ドット)3つ」 多次元連想配列の検索

可変長引数とは

 引数の数が決まっていない状況に応じて複数の引数を指定したいときに、関数の引数で指定する点(ドット)3つのことです。PHP5.6以降で使用することができます。 

  

配列にまとめる

 以下の関数を見てみましょう。

<?php

function listAnimals(...$a){
    return $a;
}

$result = listAnimals('羊', '兎', '猫');

var_export($result);

?>

 

出力結果は以下の通りです。

# 出力結果
array (
  0 => '羊',
  1 => '兎',
  2 => '猫',
)

 

7行目の関数発火時に指定した引数が配列として受け取れていることがわかりますね。このように、関数で引数を宣言する際に点(ドット)3つを手前につけることで、複数の値が飛んでくることを想定し、受取時に自動で配列に格納してくれるのです。

状況によって関数へ渡す値の数が異なる場合などに、わざわざ配列で受け渡しをする必要がないため便利です。

 

型の指定

 では、可変長引数の型の指定方法を見てみましょう。

<?php

function sum(...$a){
    return array_sum($a);
}
 
$result = sum(1, 2, 3, 4);
 
var_export($result);
 
?>

 

出力結果は以下の通りです。

# 出力結果
10

 

sum関数内のarray_sumを使って、配列の合計値を計算しています。わざわざ関数にする必要性はありませんが、そこについては今回スルーしましょう。

array_sumで合計値を出す以上、配列内に含まれるものはすべて数字でなくてはなりません。数値が文字列として指定されていた場合は数値に変換して計算されますが、数値でなければ0として認識されてしまうのです。

 

以下のコードを見てみましょう。

<?php
 
function sum(...$a){
    return array_sum($a);
}
 
$result = sum(1, 2, 3, 4, '5');
 
var_export($result);
 
?>

 

出力結果は以下の通りです。

# 出力結果
10

 

追加した5が計算されていないことがわかります。これは5が全角数字だからです。しかし計算結果が出力されていると、見逃してしまう可能性も考えられます。

そうならないためにも、可変長引数で受け取る値の型を指定します。

<?php
 
function sum(int ...$a){
    return array_sum($a);
}
 
$result = sum(1, 2, 3, 4, '5');
 
var_export($result);
 
?>

 

結果は以下の通りです。

# 出力結果(エラー)
PHP Fatal error:  Uncaught TypeError: Argument 5 passed to sum() must be of the type int, string given, called in...

 

エラーが表示されましたね。これなら開発段階で予期しない結果を生む危険性を回避することができます

可変長引数を型指定する場合は、ドット3つの前に型を宣言します。そうすれば受け取るすべての値を指定した型で検証することができます。

 

サンプルコード「多次元連想配列の検索」

 では可変長引数を使った実用的な関数のサンプルコードを見てみましょう。

今回実装したのは、多次元連想配列のキーと値を指定して、該当する行を取り出すという処理になります。複数キーを使ったandorの検索はできませんが、多次元連想配列を簡易データベースのように扱えるような関数を実装します。

<?php
# 完成コード「多次元連想配列の検索」
function searchAnimals($key, ...$vals){
    $animals = [
        0 => ['id' => 1, 'name' => 'うさぎ', 'type' => '草食'],
        1 => ['id' => 2, 'name' => 'ライオン', 'type' => '肉食'],
        2 => ['id' => 3, 'name' => 'シマウマ', 'type' => '草食'],
        3 => ['id' => 4, 'name' => 'アヒル', 'type' => '雑食'],
    ];
    $column = array_column($animals, $key);
    $results = [];
    foreach($vals as $val){
        $indexs = array_keys($column, $val);
        foreach($indexs as $index){
            $results[] = $animals[$index];
        }
    }

    return $results;
}
 
$result = searchAnimals('name', 'うさぎ');
 
var_export($result);
 
?>

 

出力結果は以下の通りです。

# 出力結果
array (
  0 =>
  array (
    'id' => 1,
    'name' => 'うさぎ',
    'type' => '草食',
  ),
)

 

25行目のsearchAnimals第一引数に検索するキー第二引数で検索する値を指定しています。nameキーがうさぎに一致するものを検索して、該当結果が取得できました。

 

第二引数は可変長引数になっているので、複数検索が可能です。25行目を以下のように変更してみましょう。

$result = searchAnimals('type', '草食', '肉食');

 

出力結果は以下の通りです。

# 出力結果
array (
  0 =>
  array (
    'id' => 1,
    'name' => 'うさぎ',
    'type' => '草食',
  ),
  1 =>
  array (
    'id' => 3,
    'name' => 'シマウマ',
    'type' => '草食',
  ),
  2 =>
  array (
    'id' => 2,
    'name' => 'ライオン',
    'type' => '肉食',
  ),
)

 

typeが草食と肉食に該当する「うさぎ」「シマウマ」「ライオン」が問題なく取得できましたね。

 

では、どういった処理になっているかを順に見てみましょう。まずは関数の引数についてです。

searchAnimals($key, ...$vals)

 

第一引数にキー名、第二引数に可変長引数指定で値を指定します。複数キーを使ったand検索などはできませんが、複数の値に該当するものを検索することが可変長引数のおかげで可能にしています。

 

次に動物データの多次元連想配列を準備します。

$animals = [
    0 => ['id' => 1, 'name' => 'うさぎ', 'type' => '草食'],
    1 => ['id' => 2, 'name' => 'ライオン', 'type' => '肉食'],
    2 => ['id' => 3, 'name' => 'シマウマ', 'type' => '草食'],
    3 => ['id' => 4, 'name' => 'アヒル', 'type' => '雑食'],
];

 

後の説明でわかりやすいように、一層目に0から順にインデックスを指定しています。

※番号が間違うと意図しない検索結果が変える可能性があるため、実装する際は省略をオススメします

 

最初の処理は、指定されたキーを使って多次元配列からカラム(列)を取り出します。

$column = array_column($animals, $key);

 

$keytypeが指定されていた場合、$columnは以下の値が格納されます。

# 出力結果
array (
  0 => '草食',
  1 => '肉食',
  2 => '草食',
  3 => '雑食',
)

 

typeの列だけを取り出しています。上から順番に取得しているため、$animalsのインデックスと$columnsのインデックスは一致しています。

 

では次の処理を見てみましょう。

$results = [];
foreach($vals as $val){
    $indexs = array_keys($column, $val);
    foreach($indexs as $index){
        $results[] = $animals[$index];
    }
}

 

$resultsに結果を格納するためのから配列を準備します。

最初のforeach($vals as $val)で、検索する値を順番に処理します。searchAnimalsの第二引数で「草食」と「肉食」が指定されていた場合は、順に先程取得した$columnに該当する値があるかを検索するためです。

 

$indexsに格納しているarray_keys($column, $val)を確認してみましょう。「草食」が$valに入っている1回目であれば、以下のような結果になります。

# 出力結果
array (
  0 => 0,
  1 => 2,
)

 

array_keysの返り値は配列になります。今回のインデックス番号は必要ないので、以下のように省略した値で見ていきましょう。

# 出力結果(インデックス省略)
array ( 0, 2 )

 

番と2番が返ってきました。これは、$animalsのインデックス番号と一致しています。このインデックス番号に該当する行を$animalsから取り出すために、更にforeachを使って処理をしています。

foreach($indexs as $index){
    $results[] = $animals[$index];
}

 

これで、インデックス番号を順番に$animalsに当てはめ、その結果を$resultsに順番に格納していきます。

草食が終われば、次は肉食を検索して、同じように該当したものを$resultsに格納していきます。

 

あとは、returnで検索結果を格納した$results返却するだけです。

return $results;
# 出力結果
array (
  0 =>
  array (
    'id' => 1,
    'name' => 'うさぎ',
    'type' => '草食',
  ),
  1 =>
  array (
    'id' => 3,
    'name' => 'シマウマ',
    'type' => '草食',
  ),
  2 =>
  array (
    'id' => 2,
    'name' => 'ライオン',
    'type' => '肉食',
  ),
)

  

まとめ

 いかがだったでしょうか。

今回は「PHPの可変長引数について」を実用的な多次元連想配列の検索サンプルを使ってご紹介しました。

可変長引数を使えば、関数の処理を簡略化したり、複数の値を引数として指定する可能性がある関数の汎用性を高くすることができます。

現在PHPを使って開発をしている人や、これからPHPを学習しようと考えている人は、ぜひ参考にしてくださいね。

 

注目の記事

PHPポケモン「コントローラー編」〜POSTとSESSIONの活用〜 10
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「コントローラー編」〜POSTとSESSIONの活用〜 10

  今回のPHPポケモンでは、今まで作った機能用のコントローラーになるインターフェースを作成します。ポケモンやメソッドを選択できるようにして、よりゲーム性の高いアプリケーションを実装しましょう。   第1回から学習したい方はコチラ     コントローラーの実装   それでは実装したアクション...

構成見直し編(クラス名) PHPポケモン49
プログラミング
PHP,PHPポケモン,ポケモン
構成見直し編(クラス名) PHPポケモン49

構成の見直し 今回は全体構成の見直しをします。ディレクトリについては変更ありませんが、ファイル名とクラス名について大幅な修正をかけていきます。   クラス名の重複回避 まず、クラス名の重複についてです。状態異常・状態変化の子クラスでは重複回避のために接頭語を着けて管理していましたが、他にも重複...

なぜ、お金を配るの?悪質メール・SNSを利用した詐欺的手法への対処法とは
ネットワーク
amazon,SNS,Twitter,お金配り,楽天,迷惑メール
なぜ、お金を配るの?悪質メール・SNSを利用した詐欺的手法への対処法とは

定期的に書きたくなるコラムのコーナー! 今回は、迷惑メールやSNSのDMを活用した悪質な勧誘、巷で流行っているお金配りを隠れ蓑のした巧妙な詐欺的手法などをいくつかご紹介、その対策・リクス回避の方法をまとめました。   まず結論からお伝えすると 「怪しいと思うなら手を出すな」 です。その詳細を知りたい...

WordPressのJSファイル読み込みで覚えておきたい便利ワザを2つ紹介します
プログラミング
jQuery,PHP,WordPress
WordPressのJSファイル読み込みで覚えておきたい便利ワザを2つ紹介します

  JSファイルを読み込むときに、deferやasyncを付与したい・・・ get_template_directory_uri()をJSファイル内で使用したい・・・   WordPressには便利な関数が沢山用意されていますが、その全てが万能だということはありません。 今回はSEO対策でも必要になるdeferやasyncをスクリプトタグに付与させる...

PHPポケモン「状態異常編〜まひ〜」23
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「状態異常編〜まひ〜」23

  今回のPHPポケモンでは「状態異常」を導入します。バトルシステムにも関係してくる部分ですが、それ以外にも影響を与える部分が多く、且つ非常に判定がややこしく、作り込む必要があったため1つずつ片付けていきます。   状態異常の実装  ポケモンの除隊異常に該当するものは以下の7通りです。 ...

SEOで強いURLとは?安易に決めると危険だった!「よく分かるSEO対策」パーマリンク編
SEO対策
WordPress,ブログ
SEOで強いURLとは?安易に決めると危険だった!「よく分かるSEO対策」パーマリンク編

  パーマリンクの設定ってSEO対策に関係あるの?   意外と気になっているポイントではないでしょうか。実は、URLとSEO対策には全くの無関係ではなく、安易に決めてしまうとせっかく積み上げた資産的価値を台無しにしてしまうかも知れない危険なポイントでもあるのです。   今回は、ブログの収益化を目指...

PHPポケモン「バトルシステム編〜状態異常2〜」31
プログラミング
PHP,PHPポケモン,ポケモン
PHPポケモン「バトルシステム編〜状態異常2〜」31

  前回に引き続き、状態異常チェックを実装します。 まず、前回実装した「ねむり」の処理についてですが、やはりターン数をセットして経過ターン数を引いていくという処理の方が解除率もゲーム再現になるので、まず修正をしておきます。サーセン。   チェック格納トレイト(/Traits/Battle/CheckTrait.php) ...

ポケモン預かりシステム編 PHPポケモン 85
プログラミング
PHP,PHPポケモン,ポケモン
ポケモン預かりシステム編 PHPポケモン 85

ポケモン預かりシステムとは ポケモンは手持ち(パーティー)に6匹しか入れることができません。そのため、ポケモンを捕まえた際にその上限に達していれば、ボックスへ転送するという仕組みをPHPポケモンでも実装していきます。これが、ポケモン預かりシステムです。 今回は前段階であるボックスの仕様決めをメイン...

カテゴリ

SEO対策 イベント デザイン ネットワーク ビジネスモデル フリーランス プログラミング マーケティング ライティング 動画編集 雑記

タグ

5G Adobe AfterEffects AI ajax amazon Animate api artisan atom Automator AWS Bluetooth CSS CVR description EC-CUBE4 ECショップ ESLint Facebook feedly foreach fortify function Google Google AdSense Honeycode htaccess HTML IEEE 802.11ax Illustrator Instagram IoT JavaScript jetstream jQuery jQuery UI keyword LAN Laravel Linux MacBook MAMP meta MLM MySQL NoCode note OS OSI参照モデル Paypal Photoshop PHP phpMyAdmin PHPポケモン PremierePro rss SEO SEO対策 Sequel Pro Skype SNS SSH Symfony TCP/IP title Toastr Trait Twig Twitter UCC V系 WAN WebSub Wi-Fi wiki Windows WordPress XAMPP xml Xserver YouTube YouTuber Zoom アーティスト アウトプット アクセス層 アニメーション アフィリエイト イーブイ インターネット インプット エンジニア オブジェクト指向 お金配り クリック単価 クリック数 コミュニケーション能力 コロナ コンサルティング サムネイル システムエンジニア スタートアップ スタイルシート スパム データベース ディープフェイク デザイナー デザイン テレワーク ナンパ ニュース ネットワークモデル ノマドワーク バナー ピカチュウ ビジネス フィード フリーランス ブロガー ブログ プログラマー プログラミング プログラミング学習 プログラミング教育 プロトコル ホームページ制作 ポケモン マークアップ マーケティング メール リモートワーク レンダリング 三井住友 三宮 仕事依頼 児童デイ 児童デイサービス 児童発達支援 公開鍵 初心者 助成金 勉強法 営業 広告 広告収入 必勝マニュアル 放課後等デイサービス 朝活 楽天 深層学習 無線LAN 独立 神戸 福祉 秘密鍵 翻訳 自己啓発 英語 見積書 計算機 認証 読書 起業 迷惑メール 配列 銀の弾丸 集客 雑学力