CakePHP4、5でSELECT telephone as tel FROM usersの様にasでカラムに別名を付ける方法

2024/12/22 2025/01/31

CakePHP4、5のクエリビルダーを使用してカラムに別名を付与する方法

SQLでカラムに別名を付与して値を取得する方法

　
SQL文で、取得するカラム名と違う別名を付けて値を取得する場合は、下記のように「as」を使用してカラムの別名を指定します。
　

SELECT telephone as tel FROM users;

1	SELECT telephone as tel FROM users;

　
上記の例は、usersテーブル内のカラム名は「telephone」ですが、短い「tel」という別名に変更して取得します。
　
　
CakePHP4、CakePHP5で、この「as」を使用してカラムの別名を指定する処理の実装方法を解説します。
　
　

CakePHP4、5のクエリビルダーを使用してカラムに別名を付与する方法

　
下記は、基本的な処理であるテーブル内のカラム名である「telephone」として値を取得する処理です。
　

$select = [
  "telephone"
];
$users = $this->Users->find()->select($select);

$select = [

"telephone"

];

$users = $this->Users->find()->select($select);

　
　
これに対して、「telephone」のカラムの値を「tel」として取得する場合は、「$select」に指定している配列のキーとして「tel」を指定すれば OKです。
　

$select = [
  "tel" => "telephone"
];
$users = $this->Users->find()->select($select);

$select = [

"tel" => "telephone"

];

$users = $this->Users->find()->select($select);

　
　
仕組みが分かっていれば非常に簡単です。
　
　

CakePHP4、5のクエリビルダーを使用してカラムに別名を付与する際の注意点

　
処理自体は特に問題なく簡単なのですが、いろいろ試してみた結果、「as」で指定する項目名には「-（ハイフン）」を使用することができない、ということが分かりました。
　

$select = [
  "tele-phone" => "telephone"
];

$select = [

"tele-phone" => "telephone"

];

　
具体的には上記の「tele-phone」のように「-（ハイフン）」を入れると、下記のようなエラーが発生します。
　
SQLSTATE[42000]: Syntax error or access violation: 1064 You have an error in your SQL syntax; check the manual that corresponds to your MariaDB server version for the right syntax to use near '-amount AS telephone...' at line 1
　
このほか「+（プラス）」「*（アスタリスク）」「/（スラッシュ）」なども同様のエラーが発生します。
　
「tele-phone」を囲う「"（ダブルクオーテーション）」を「'（シングルクォーテーション）」に変えてもエラーが発生する状況に変化はありませんでした。
　
ちなみに、「_（アンダースコア）」は問題ありませんでした。
　
ご注意ください。
　
　

- CakePHP 3.x 4.x 5.x CakePHP5

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4の定数定義ファイルを環境変数によって本番と開発を振り分ける方法解説

CakePHP4で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定しそれを読み込み判別する。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

: CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

: CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単！

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。