虚字段

虚字段可以将任意的SQL表达式当作模型中的字段来使用,这些字段不能保存数据,但是像其他字段一样可以进行读操作。和其他字段一样。作为model的键名使用,

创建虚字段

创建虚拟字段很简单。在每个模型中可以设置 $virtualFields 属性,该属性是一个数组, 形式如 字段名 => 表达式。下面是一个使用MySQL定义虚字段的例子:

public $virtualFields = array(
    'name' => 'CONCAT(User.first_name, " ", User.last_name)'
);

PostgreSQL中的写法:

public $virtualFields = array(
    'name' => 'User.first_name || \' \' || User.last_name'
);

在随后的查找操作中,User的查询结果中会一个多出键名为 name 键值为连接内容的字段。虚字段不要与数据库中已存在的字段名相同。否则会导致错误。

有时可以不带 User.first_name,如果不遵循规范,(比如和其他表有多个关联)可能会出现错误。这种情况下,应该不带模型名,最好使用 first_name || \' \' || last_name

使用虚字段

操作虚拟字段有多种方法。

Model::hasField()

如果模型中存在第一个参数指定的实际存在的字段,将返回true。 将第二个参数 hasField() 设为true,虚拟字段也会被检查。使用上面的代码来举例:

$this->User->hasField('name'); // 返回false,因为不存在名为name的实际字段
$this->User->hasField('name', true); // 放回true,因为存在名为name的虚字段

Model::isVirtualField()

检测一个字段/列是虚字段还是实际字段。如果是虚拟字段将返回true:

$this->User->isVirtualField('name'); //true
$this->User->isVirtualField('first_name'); //false

Model::getVirtualField()

该方法用来取得虚字段对应的SQL表达式,如果没有参数,会返回该模型所有的虚字段:

//将返回 'CONCAT(User.first_name, ' ', User.last_name)'
$this->User->getVirtualField('name');

模型的find()方法和虚字段

如前所述,Model::find() 像处理其他字段一样处理虚字段。虚字段的值会包括在模型的结果中:

$results = $this->User->find('first');

// 输出的结果
array(
    'User' => array(
        'first_name' => 'Mark',
        'last_name' => 'Story',
        'name' => 'Mark Story',
        //更多的字段...
    )
);

分页和虚字段

由于查询时虚字段与一般字段的行为一样,所以也可以用 Controller::paginate() 来排序。

虚字段和模型别名(model aliases)

当你使用虚字段和带别名的模型,可能会遇到虚字段的模型不会更新映射到新的模型别名中去。 如果使用的虚字段所在的模型中有多个别名,最好在模型的构造函数中来定义虚字段:

public function __construct($id = false, $table = null, $ds = null) {
    parent::__construct($id, $table, $ds);
    $this->virtualFields['name'] = sprintf(
        'CONCAT(%s.first_name, " ", %s.last_name)', $this->alias, $this->alias
    );
}

这将使虚字段在给定模型的所有别名中都有效。

SQL查询中的虚字段

使用query函数直接进行SQL查询,其返回的数据并不和模型的数据一样。比如:

$this->Timelog->query(
    "SELECT
        project_id, SUM(id) as TotalHours
    FROM
        timelogs
    AS
        Timelog
    GROUP BY
        project_id;"
);

返回如下格式的数据:

Array
(
    [0] => Array
        (
            [Timelog] => Array
                (
                    [project_id] => 1234
                )
             [0] => Array
                 (
                     [TotalHours] => 25.5
                 )
        )
 )

如果想把TotalHours放到Timelog数组中,我们需要为合计列指定一个虚拟字段。 我们可以临时定义虚拟字段比定义在模型中更有效果。我们设定默认值为 0,免得其他查询使用这个虚拟字段。 如果那样,TotalHours列会返回 0

$this->Timelog->virtualFields['TotalHours'] = 0;

除了增加虚拟字段,我们还需要用 MyModel__MyField 的形式给列起别名。比如:

$this->Timelog->query(
    "SELECT
        project_id, SUM(id) as Timelog__TotalHours
    FROM
        timelogs
    AS
        Timelog
    GROUP BY
        project_id;"
);

在指定虚拟字段后再次查询,将会得到一个格式化好的的结果:

Array
(
    [0] => Array
        (
            [Timelog] => Array
                (
                    [project_id] => 1234
                    [TotalHours] => 25.5
                )
        )
)

虚字段的局限

使用虚字段会带来一些局限。首先,不能在模型关联的条件(conditions),排序(order),字段(fields)数组中使用虚拟字段。如果那样做会产生SQL错误。因为字段被没有被ORM替代。很难去估算模型关联的深度。

常见的解决办法是在运行时将 virtualFields 复制到其他模型:

$this->virtualFields['name'] = $this->Author->virtualFields['name'];

或:

$this->virtualFields += $this->Author->virtualFields;