Yii2：在 JOIN 查询中获取 ActiveRecord 对象时包含额外字段-php教程-PHP中文网

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

DDD

发布： 2025-09-09 20:12:12

原创

973人浏览过

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();

登录后复制

解释：

晓象AI资讯阅读神器

晓象-AI时代的资讯阅读神器

查看详情

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>

登录后复制