CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

2017/03/04 2019/07/22

ビューで受取ったテーブルのオブジェクトを連想配列に変換

オブジェクトを連想配列に変換する解説の前提

　
テーブルから取得したレコード情報（オブジェクト）を、コントローラーからビューに送ります。
その送ったオブジェクトを、ビュー内で連想配列として扱う方法について解説します。
　
　
「CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る」の記事で利用したユーザテーブルと権限マスタテーブルを利用しています。
というか、「CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る」の記事のあれこれ試す中で確認した内容になります。
　
やりたいことは、「UsersController.php」で取得した「権限マスタテーブル」のオブジェクトを、コントローラーからビューに送信し、ビュー側で「権限マスタ」にある「権限名（master_roles.name）」を、Usersの一覧表の「権限名」のところに編集する方法です。
　
そのため、ビューで受けとたオブジェクトを連想配列に変換する方法を必要としました。
　
　

コントローラーからビューに送る処理

　
「CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る」のテーブル情報を見ながら確認してほしいのですが、下記の様に「UsersController.php」で権限マスタの情報を取得し、21行目の setで「$masterRoles」変数としてビューに渡しています。
　

<?php
namespace App\Controller;

use App\Controller\AppController;
use Cake\ORM\TableRegistry;

/**
 * Users Controller
 *
 * @property \App\Model\Table\UsersTable $Users
 */
class UsersController extends AppController
{

    public function initialize(){
        parent::initialize();
        $this->MasterRoles = TableRegistry::getTableLocator()->get("master_roles");
    }

    public function beforeFilter(){
        $this->set("masterRoles",$this->MasterRoles->find()->all());
    }

<?php

namespace App\Controller;

use App\Controller\AppController;

use Cake\ORM\TableRegistry;

/**

* Users Controller

* @property \App\Model\Table\UsersTable $Users

class UsersController extends AppController

{

public function initialize(){

parent::initialize();

$this->MasterRoles = TableRegistry::getTableLocator()->get("master_roles");

}

public function beforeFilter(){

$this->set("masterRoles",$this->MasterRoles->find()->all());

}

　
2019.07.22　追記
CakePHP3.6から、TableRegistryクラスの使用方法が変更になりました。
そのため、上記のサンプルコードも CakePHP3.6 以降の記述方法に変更しました。
　

// 3.6.0 以降
$articles = TableRegistry::getTableLocator()->get('Articles');

// 3.6.0 より前
$articles = TableRegistry::get('Articles');

// 3.6.0 以降

$articles = TableRegistry::getTableLocator()->get('Articles');

// 3.6.0 より前

$articles = TableRegistry::get('Articles');

ビューで受け取り foreach文で処理

　
ビュー側で受け取ったオブジェクトは、下記のようなに foreach文でグルグル回しながら値を取得していくことができます。
　

foreach ($masterRoles as $role){
    $roleName = $role->name
      ：
      ：
}

foreach ($masterRoles as $role){

$roleName = $role->name

：

}

　
ここまでは特に問題がありません。
　
　

PHPフレームワーク CakePHP 3入門

問題点：オブジェクトのままでは個別の値が取得できない！

　
ですが、受け取った情報は「権限マスタ」ですので、foreach文でグルグル回しながら使うことはほぼなく、下記のように「0」の位置を指定して値を取得したいわけです。
　

echo $masterRoles[0]->name;

1	echo $masterRoles[0]->name;

　
ですが、コントローラーからビューに送られる値は、オブジェクトのため、こういう形式で受け取ることができないのです。
　
なので、いろいろ試してみました。
　

echo $masterRoles[0]->name;
echo $masterRoles->0->name;
echo $masterRoles[0]["name"];
echo ((array)$masterRoles)[0]->name;

echo $masterRoles[0]->name;

echo $masterRoles->0->name;

echo $masterRoles[0]["name"];

echo ((array)$masterRoles)[0]->name;

　
上記の記述方法ではいずれも「Error: Cannot use object of type Cake\ORM\ResultSet as array」というエラーになるのです。
　
最後の「((array)$masterRoles)[0]->name;」という記述方法は、オブジェクトがネストしていなければ有効なようですが、テーブル情報として送られてくるオブジェクトはネストしていますので、うまく機能しません。
　
　

解決方法：オブジェクトを連想配列にするには toArray()を使う！

　
前置きが長くなりましたが、ようやく解決方法です。
　
ビューで受け取ったオブジェクトを連想配列に変換する方法です。
連想配列に変換できればいつものように連想配列の位置を指定して値を取得できるようになります。
　
下記の様にコントローラーから受け取ったオブジェクト「$masterRoles」を「toArray()」メソッドを使うことで連想配列に変換することができます。
　

$masterRolesArray = $masterRoles->toArray();
echo $masterRolesArray[0]->name;

// 1行で書くことも可能
echo $masterRoles->toArray()[1]->name;

$masterRolesArray = $masterRoles->toArray();

echo $masterRolesArray[0]->name;

// 1行で書くことも可能

echo $masterRoles->toArray()[1]->name;

　
連想配列に変換できれば、あとは普通の連想配列ですので、0番目のレコードを取得する場合は「$masterRolesArray[0]」と指定することで取得できるようになります。
　
ちなみに、「$masterRolesArray[0]」で取得した中身はまたオブジェクトなので、「name」を取得する場合は「$masterRolesArray[0]->name」となります。
　
　
オフィシャルサイトでは下記の「データのロードに Finder を使う」の中に書いてありました。
https://book.cakephp.org/3.0/ja/orm/retrieving-data-and-resultsets.html#finder
　
　

オブジェクトを連想配列に変換する方法のあとがき

　
この「toArray()」メソッドを知る前は、一度 foreach文でグルグル回して連想配列に置き換えるという処理をしていました。
　
　
今回は、Usersコントローラーから $masterRolesという他のテーブルの情報を読み込んだときの話ですが、マスタ情報を読み込んだときだけの話ではありません。
「http://example.com/Users」で見ることができる一覧ページでは、下記の様に「$users」を foreach文でグルグル回して一覧表を生成する処理があります。
　

<?php foreach ($users as $user): ?>
<tr>
    <td><?= $this->Number->format($user->id) ?></td>
    <td><?= h($user->username) ?></td>
    <td><?= h($user->password) ?></td>
    <td><?= h($user->created) ?></td>
    <td><?= h($user->modified) ?></td>
    <td class="actions">
        <?= $this->Html->link(__('View'), ['action' => 'view', $user->id]) ?>
        <?= $this->Html->link(__('Edit'), ['action' => 'edit', $user->id]) ?>
        <?= $this->Form->postLink(__('Delete'), ['action' => 'delete', $user->id], ['confirm' => __('Are you sure you want to delete # {0}?', $user->id)]) ?>
    </td>
</tr>
<?php endforeach; ?>

<?php foreach ($users as $user): ?>

<tr>

<td><?= $this->Number->format($user->id) ?></td>

<td><?= h($user->username) ?></td>

<td><?= h($user->password) ?></td>

<td><?= h($user->created) ?></td>

<td><?= h($user->modified) ?></td>

<?= $this->Html->link(__('View'), ['action' => 'view', $user->id]) ?>

<?= $this->Html->link(__('Edit'), ['action' => 'edit', $user->id]) ?>

<?= $this->Form->postLink(__('Delete'), ['action' => 'delete', $user->id], ['confirm' => __('Are you sure you want to delete # {0}?', $user->id)]) ?>

</td>

</tr>

<?php endforeach; ?>

　
この Usersのページでも、一覧表を作るというのではなく、「『$users』のオブジェクトから 2件目のレコードの『username』を取得する」という場合も同じように「toArray()」メソッドを使うと連想配列になりますので、下記のような形で値の取得ができるようになります。
　

$usersArray = $users->toArray();
echo $usersArray[1]->username;

1 2	$usersArray = $users->toArray(); echo $usersArray[1]->username;

　
　
まぁ、「toArray()」メソッドを記述するだけで連想配列になるとはいえ、オブジェクトの 2個目の値を使いたい、っていうような要望はよくあると思うので、わざわざ連想配列に変換しなくても利用できる方法があってもよさそうな気がするんですが．．．
他に方法はないんですかね？
　
ちなみに、下記のサイトを見る感じでは、PHP自体には「toArray()」メソッドはなさそうですね。
http://qiita.com/ymm1x/items/f197ddd327356b1e9088
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP4、CakePHP5系の認証処理でログインの有無の確認、ユーザ情報の取得の方法

CakePHP4系、5系のログイン認証の可否のチェック、および、ログインユーザの情報を取得する方法のまとめ。複数の方法があるが手続きが微妙に異なるためまとめてみた。

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説

CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン（エレメント化、ブロック化）にして解説。

: CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説

CakePHP3でOGPを設定する方法を解説。fetch、assignを使用しレイアウトファイルに編集した変数にテンプレートファイルから値を指定する。これを利用してOGPを編集する。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。

CakePHP3でajaxを利用する処理の実装方法を解説。プルダウンを変更するとデータベースの値を取得し検索結果の内容を変更するというような処理を想定。CakePHP3.6以降の CSRF対策対応済。