Yii2：在 JOIN 查询中获取 ActiveRecord 对象时包含额外字段（字段.额外.获取.包含.对象...）

yii2：在 join 查询中获取 activerecord 对象时包含额外字段

本文档旨在解决在使用 Yii2 的 ActiveRecord 进行 JOIN 查询时，如何将关联表中的额外字段包含在结果对象中的问题。我们将通过一个具体的示例，详细介绍如何配置模型和查询，以便在获取 ActiveRecord 对象时，能够访问 JOIN 表中的字段数据。

问题描述

在使用 Yii2 的 ActiveRecord 进行 JOIN 查询时，如果直接使用 select('pu.*, tag')，并期望将 shop 表中的 tag 字段包含到 ProductUrl 模型的 ActiveRecord 对象中，可能会发现 tag 字段丢失。这是因为 ActiveRecord 默认只映射数据库表中的字段到模型属性。

解决方案

要解决这个问题，需要在 ProductUrl 模型中显式地声明 tag 属性，并确保查询能够正确地将 tag 值填充到该属性中。

步骤 1：在模型中声明属性

首先，在 ProductUrl 模型类中添加一个公共属性 $tag：

namespace app\models;

use Yii;
use yii\db\ActiveRecord;

/**
 * This is the model class for table "product_url".
 *
 * @property int $id
 * @property int $product_id
 * @property string $url
 *
 * @property Product $product
 * @property Shop $shop
 */
class ProductUrl extends ActiveRecord
{
    public $tag; // 声明 tag 属性

    // ... 其他代码
}

步骤 2：执行 JOIN 查询

接下来，使用 ActiveQuery 执行 JOIN 查询。关键在于 select 方法，确保选择了所有 ProductUrl 的字段以及 shop 表的 tag 字段。

$product_url = ProductUrl::find()
    ->alias('pu')
    ->select(['pu.*', 'shop.tag']) // 选择 ProductUrl 的所有字段和 shop.tag
    ->leftJoin('shop', "SUBSTRING_INDEX(pu.url, '/', 3) = SUBSTRING_INDEX(shop.url, '/', 3)")
    ->all();

解释：

PIA

全面的AI聚合平台，一站式访问所有顶级AI模型

226 查看详情 PIA

select(['pu.*', 'shop.tag'])：明确指定要选择的字段，包括 ProductUrl 表的所有字段（通过 pu.*）和 shop 表的 tag 字段。
leftJoin('shop', "SUBSTRING_INDEX(pu.url, '/', 3) = SUBSTRING_INDEX(shop.url, '/', 3)")：执行 LEFT JOIN 操作，连接 product_url 和 shop 表。

步骤 3：访问 tag 属性

现在，当你遍历 $product_url 数组时，每个 ProductUrl 对象都应该包含 tag 属性，并且该属性的值来自 shop 表。

foreach ($product_url as $product) {
    echo $product->id . ' - ' . $product->product_id . ' - ' . $product->url . ' - ' . $product->tag . '<br>';
}

完整示例

以下是一个完整的示例，展示了如何配置模型和执行查询：

模型 (ProductUrl.php):

namespace app\models;

use Yii;
use yii\db\ActiveRecord;

/**
 * This is the model class for table "product_url".
 *
 * @property int $id
 * @property int $product_id
 * @property string $url
 *
 * @property Product $product
 * @property Shop $shop
 */
class ProductUrl extends ActiveRecord
{
    public $tag; // 声明 tag 属性

    /**
     * {@inheritdoc}
     */
    public static function tableName()
    {
        return 'product_url';
    }

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        return [
            [['product_id', 'url'], 'required'],
            [['product_id'], 'integer'],
            [['url'], 'string', 'max' => 255],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return [
            'id' => 'ID',
            'product_id' => 'Product ID',
            'url' => 'Url',
        ];
    }

    /**
     * Gets query for [[Product]].
     *
     * @return \yii\db\ActiveQuery
     */
    public function getProduct()
    {
        return $this->hasOne(Product::className(), ['id' => 'product_id']);
    }

    /**
     * Gets query for [[Shop]].
     *
     * @return \yii\db\ActiveQuery
     */
    public function getShop()
    {
        return $this->hasOne(Shop::className(), ["SUBSTRING_INDEX(url,'/',3)" => "SUBSTRING_INDEX(url,'/',3)"]);
    }
}

控制器代码:

namespace app\controllers;

use Yii;
use app\models\ProductUrl;
use yii\web\Controller;

class ProductController extends Controller
{
    public function actionIndex()
    {
        $product_url = ProductUrl::find()
            ->alias('pu')
            ->select(['pu.*', 'shop.tag']) // 选择 ProductUrl 的所有字段和 shop.tag
            ->leftJoin('shop', "SUBSTRING_INDEX(pu.url, '/', 3) = SUBSTRING_INDEX(shop.url, '/', 3)")
            ->all();

        return $this->render('index', ['products' => $product_url]);
    }
}

视图 (index.php):

<?php
use yii\helpers\Html;

?>
<h1>Products</h1>

<ul>
    <?php foreach ($products as $product): ?>
        <li>
            <?= Html::encode("{$product->id} - {$product->product_id} - {$product->url} - {$product->tag}") ?>
        </li>
    <?php endforeach; ?>
</ul>

注意事项

确保数据库查询返回的字段名与模型中声明的属性名一致。如果字段名不一致，可以使用 AS 关键字在 SQL 查询中进行别名设置。
如果 tag 字段在 shop 表中允许为 NULL，则在 ProductUrl 模型中声明 tag 属性时，也要考虑到 NULL 值的情况。
虽然可以通过定义关系 getShop() 来获取关联的 Shop 对象，但直接在 JOIN 查询中选择 tag 字段通常更高效，因为它避免了额外的数据库查询。

总结

通过在模型中显式声明属性并正确配置 JOIN 查询的 select 方法，可以轻松地将关联表中的字段包含在 ActiveRecord 对象中。这种方法避免了使用 asArray() 并允许你继续利用 ActiveRecord 的优势，例如模型验证和事件处理。

以上就是Yii2：在 JOIN 查询中获取 ActiveRecord 对象时包含额外字段的详细内容，更多请关注知识资源分享宝库其它相关文章！

相关标签： php html app red php sql NULL select 对象事件数据库大家都在看： php如何实现一个基本的用户登录系统？php用户认证与登录系统开发步骤 php如何重定向页面_php实现页面跳转的方法 php如何压缩和解压zip文件？php ZipArchive类压缩解压操作生成准确表达文章主题的标题使用嵌套循环在PHP中镜像三角形图案 php PSR标准是什么 php PSR规范核心内容解读