京都のシステム開発・ホームページ制作会社　株式会社Nextat（ネクスタット）

こんにちは、スズキです。

PHPで開発作業をしていて、知っておくと地味に便利だった小ネタです。

例えば、配列の入れ子構造のデータとして下記のようなデータがあったとします。

        $fieldSettings = [
            'group1' => [
                'field1' => [
                    'displayName' => 'フィールド１',
                ],
                'field2' => [
                    'displayName' => 'フィールド２',
                    'defaultValue' => "デフォルト値です",
                ],
            ],
            'group2' => [
                'field3' => [
                    'displayName' => 'フィールド３',
                ],
            ],
        ];

そして、例えば、設定値を取ってくるメソッドを作成することを考えます。

    private function getFieldSettingValue($fieldSettings, $groupId, $fieldId, $fieldSettingKey)
    {
        // 対象の設定値を返す
        $fieldSettingValue = $fieldSettings[$groupId][$fieldId][$fieldSettingKey];
        return $fieldSettingValue;
    }

上記のようなメソッドの場合、

        // OKパターン
        $fieldSettingValue1 = $this->getFieldSettingValue($fieldSettings, 'group1', 'field1', 'displayName');

という場合はうまくいきますが、

        // NGパターン
        $fieldSettingValue2 = $this->getFieldSettingValue($fieldSettings, 'group3', 'field2', 'displayName');

仕方が無いので、引数が不正な場合も正常に動作するように以下のような対応が必要になります。

    private function getFieldSettingValue($fieldSettings, $groupId, $fieldId, $fieldSettingKey, $defaultValue = null)
    {
        // 値が取得できない場合はデフォルト値を返す
        if($fieldSettings == null){ return $defaultValue; }
        if(!array_key_exists($groupId, $fieldSettings)){ return $defaultValue; }
        if(!array_key_exists($fieldId, $fieldSettings[$groupId])){ return $defaultValue; }
        if(!array_key_exists($fieldSettingKey, $fieldSettings[$groupId][$fieldId])){ return $defaultValue; }

        // 対象の設定値を返す
        $fieldSettingValue = $fieldSettings[$groupId][$fieldId][$fieldSettingKey];
        return $fieldSettingValue;
    }

中身がだいぶごちゃごちゃしちゃいましたね。

実は、上記のNGパターンを弾くためのチェックですが、issetメソッドを利用して以下のように簡略化して書くことができます。

    private function getFieldSettingValue($fieldSettings, $groupId, $fieldId, $fieldSettingKey, $defaultValue = null)
    {
        // 値が取得できない場合はデフォルト値を返す
        if(!isset($fieldSettings[$groupId][$fieldId][$fieldSettingKey])){
            return $defaultValue;
        }

        // 対象の設定値を返す
        $fieldSettingValue = $fieldSettings[$groupId][$fieldId][$fieldSettingKey];
        return $fieldSettingValue;
    }

という豆知識でした。