Laravel，数据表，具有关系计数的列
Laravel, Datatables, column with relations count
我有两个模型，User 和 Training，它们之间有 Many to many 关系。我正在使用 Laravel Datatables 包来显示所有用户的 table。数据控制器方法（检索查询结果并创建 Datatables table）如下所示：
public function getData()
{
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
如何向创建的 table 添加一列，显示每个用户的关系总数（即每个 User 有多少 Training） ？
我会使用 http://laravel.com/docs/4.2/eloquent 中提供的约定设置您的数据库 tables 和 Eloquent 模型。在您的示例中，您将有三个 tables.
- 培训
- training_user
- 用户
您的模型看起来像这样。
class Training {
public function users() {
return $this->belongsToMany('User');
}
}
class User {
public function trainings() {
return $this->belongsToMany('Training');
}
}
然后您可以使用 Eloquent 获取用户列表并预先加载他们的培训。
// Get all users and eager load their trainings
$users = User::with('trainings')->get();
如果您想计算每个用户的培训次数，您可以简单地遍历 $users 并计算培训数组的大小。
foreach ( $users as $v ) {
$numberOfTrainings = sizeof($v->trainings);
}
或者您可以简单地在 SQL 中进行。请注意，我在下面的示例假定您遵循 Laravel 的命名约定 table 和列。
SELECT
u.*, COUNT(p.user_id) AS number_of_trainings
FROM
users u
JOIN
training_user p ON u.id = p.user_id
GROUP BY
u.id
现在您已经有了几种计算关系数量的方法，您可以使用任何您喜欢的方法将该值存储在某处。请记住，如果您将该数字作为值存储在用户 table 中，则每次用户 creates/updates/deletes 训练时都需要更新它（反之亦然！）。
蛮力方法是尝试 User::selectRaw(...)，它有一个内置的子查询来获取用户的培训计数并将其公开为一个字段。
但是，有一种更内置的方法可以做到这一点。您可以预先加载关系（以避免 n+1 查询），并使用 DataTables add_column 方法添加计数。假设您的关系名为 trainings:
public function getData() {
$users = User::with('trainings')->select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->add_column('trainings', function($user) {
return $user->trainings->count();
})
->remove_column('id')
->make();
}
add_column 中列的名称应与加载的关系同名。如果出于某种原因使用不同的名称，则需要确保删除关系列，以便将其从数据数组中删除。例如：
return \Datatables::of($users)
->add_column('trainings_count', function($user) {
return $user->trainings->count();
})
->remove_column('id')
->remove_column('trainings')
->make();
编辑
不幸的是，如果你想在计数字段上排序，你将需要暴力法。该包通过调用传递给 of() 方法的 Builder 对象上的 ->orderBy() 来进行排序，因此查询本身需要用于排序的字段。
然而，即使您需要做一些原始的 SQL，也可以做得更干净一些。您可以添加一个模型范围，该范围将增加关系的数量。例如，将以下方法添加到您的用户模型中：
注意：以下函数仅适用于hasOne/hasMany关系。请参阅下面的 Edit 2，了解适用于所有关系的更新函数。
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$parentKey = $relation->getQualifiedParentKeyName(); // ex: users.id
$relatedKey = $relation->getForeignKey(); // ex: trainings.user_id
$fieldName = $fieldName ?: $relationName; // ex: trainings
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $related->select(DB::raw('count(*)'))->whereRaw($relatedKey . ' = ' . $parentKey);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
// add the select to the query
return $query->addSelect(DB::raw($select));
}
将该作用域添加到您的用户模型后，您的 getData 函数变为：
public function getData() {
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->selectRelatedCount('trainings')
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
如果您希望计数字段具有不同的名称，您可以将字段名称作为第二个参数传递给 selectRelatedCount 范围（例如 selectRelatedCount('trainings', 'training_count')）。
编辑 2
上述 scopeSelectRelatedCount() 方法存在一些问题。
首先，对 $relation->getQualifiedParentKeyName() 的调用仅适用于 hasOne/hasMany 关系。这是该方法定义为 public 的唯一关系。所有其他关系将此方法定义为 protected。因此，将此作用域与非 hasOne/hasMany 的关系一起使用会引发 Illuminate\Database\Query\Builder::getQualifiedParentKeyName() 异常。
其次，生成的计数 SQL 并非对所有关系都是正确的。同样，它适用于 hasOne/hasMany，但生成的手册 SQL 对于多对多关系 (belongsToMany) 根本不起作用。
不过，我确实找到了解决这两个问题的方法。在查看关系代码以确定异常原因后，我发现 Laravel 已经提供了一个 public 方法来为关系生成计数 SQL：getRelationCountQuery()。适用于所有关系的更新范围方法是：
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$fieldName = $fieldName ?: $relationName; // ex: trainings
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $relation->getRelationCountQuery($related->newQuery(), $query);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
// add the select to the query
return $query->addSelect(DB::raw($select));
}
编辑 3
此更新允许您将闭包传递到将修改添加到 select 字段的计数子查询的范围。
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null, $callback = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$fieldName = $fieldName ?: $relationName; // ex: trainings
// start a new query for the count statement
$countQuery = $related->newQuery();
// if a callback closure was given, call it with the count query and relationship
if ($callback instanceof Closure) {
call_user_func($callback, $countQuery, $relation);
}
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $relation->getRelationCountQuery($countQuery, $query);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
$queryBindings = $query->getBindings();
$countBindings = $countQuery->getBindings();
// if the new count query has parameter bindings, they need to be spliced
// into the existing query bindings in the correct spot
if (!empty($countBindings)) {
// if the current query has no bindings, just set the current bindings
// to the bindings for the count query
if (empty($queryBindings)) {
$queryBindings = $countBindings;
} else {
// the new count query bindings must be placed directly after any
// existing bindings for the select fields
$fields = implode(',', $query->getQuery()->columns);
$numFieldParams = 0;
// shortcut the regex if no ? at all in fields
if (strpos($fields, '?') !== false) {
// count the number of unquoted parameters (?) in the field list
$paramRegex = '/(?:(["\'])(?:\\.|[^])*|\\.|[^\?])+/';
$numFieldParams = preg_match_all($paramRegex, $fields) - 1;
}
// splice into the current query bindings the bindings needed for the count subquery
array_splice($queryBindings, $numFieldParams, 0, $countBindings);
}
}
// add the select to the query and update the bindings
return $query->addSelect(DB::raw($select))->setBindings($queryBindings);
}
有了更新的作用域，您可以使用闭包来修改计数查询：
public function getData() {
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->selectRelatedCount('trainings', 'trainings', function($query, $relation) {
return $query
->where($relation->getTable().'.is_creator', false)
->where($relation->getTable().'.is_speaker', false)
->where($relation->getTable().'.was_absent', false);
})
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
注意：在撰写本文时，bllim/laravel4-datatables-package 数据表包在 select 字段的子查询中存在参数绑定问题。数据将正确返回，但计数不会 ("Showing 0 to 0 of 0 entries")。我已经详细说明了这个问题here。这两个选项是使用该问题中提供的代码手动更新数据表包，或者不在计数子查询中使用参数绑定。使用whereRaw避免参数绑定。
我有两个模型，User 和 Training，它们之间有 Many to many 关系。我正在使用 Laravel Datatables 包来显示所有用户的 table。数据控制器方法（检索查询结果并创建 Datatables table）如下所示：
public function getData()
{
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
如何向创建的 table 添加一列，显示每个用户的关系总数（即每个 User 有多少 Training） ？
我会使用 http://laravel.com/docs/4.2/eloquent 中提供的约定设置您的数据库 tables 和 Eloquent 模型。在您的示例中，您将有三个 tables.
- 培训
- training_user
- 用户
您的模型看起来像这样。
class Training {
public function users() {
return $this->belongsToMany('User');
}
}
class User {
public function trainings() {
return $this->belongsToMany('Training');
}
}
然后您可以使用 Eloquent 获取用户列表并预先加载他们的培训。
// Get all users and eager load their trainings
$users = User::with('trainings')->get();
如果您想计算每个用户的培训次数，您可以简单地遍历 $users 并计算培训数组的大小。
foreach ( $users as $v ) {
$numberOfTrainings = sizeof($v->trainings);
}
或者您可以简单地在 SQL 中进行。请注意，我在下面的示例假定您遵循 Laravel 的命名约定 table 和列。
SELECT
u.*, COUNT(p.user_id) AS number_of_trainings
FROM
users u
JOIN
training_user p ON u.id = p.user_id
GROUP BY
u.id
现在您已经有了几种计算关系数量的方法，您可以使用任何您喜欢的方法将该值存储在某处。请记住，如果您将该数字作为值存储在用户 table 中，则每次用户 creates/updates/deletes 训练时都需要更新它（反之亦然！）。
蛮力方法是尝试 User::selectRaw(...)，它有一个内置的子查询来获取用户的培训计数并将其公开为一个字段。
但是，有一种更内置的方法可以做到这一点。您可以预先加载关系（以避免 n+1 查询），并使用 DataTables add_column 方法添加计数。假设您的关系名为 trainings:
public function getData() {
$users = User::with('trainings')->select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->add_column('trainings', function($user) {
return $user->trainings->count();
})
->remove_column('id')
->make();
}
add_column 中列的名称应与加载的关系同名。如果出于某种原因使用不同的名称，则需要确保删除关系列，以便将其从数据数组中删除。例如：
return \Datatables::of($users)
->add_column('trainings_count', function($user) {
return $user->trainings->count();
})
->remove_column('id')
->remove_column('trainings')
->make();
编辑
不幸的是，如果你想在计数字段上排序，你将需要暴力法。该包通过调用传递给 of() 方法的 Builder 对象上的 ->orderBy() 来进行排序，因此查询本身需要用于排序的字段。
然而，即使您需要做一些原始的 SQL，也可以做得更干净一些。您可以添加一个模型范围，该范围将增加关系的数量。例如，将以下方法添加到您的用户模型中：
注意：以下函数仅适用于hasOne/hasMany关系。请参阅下面的 Edit 2，了解适用于所有关系的更新函数。
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$parentKey = $relation->getQualifiedParentKeyName(); // ex: users.id
$relatedKey = $relation->getForeignKey(); // ex: trainings.user_id
$fieldName = $fieldName ?: $relationName; // ex: trainings
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $related->select(DB::raw('count(*)'))->whereRaw($relatedKey . ' = ' . $parentKey);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
// add the select to the query
return $query->addSelect(DB::raw($select));
}
将该作用域添加到您的用户模型后，您的 getData 函数变为：
public function getData() {
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->selectRelatedCount('trainings')
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
如果您希望计数字段具有不同的名称，您可以将字段名称作为第二个参数传递给 selectRelatedCount 范围（例如 selectRelatedCount('trainings', 'training_count')）。
编辑 2
上述 scopeSelectRelatedCount() 方法存在一些问题。
首先，对 $relation->getQualifiedParentKeyName() 的调用仅适用于 hasOne/hasMany 关系。这是该方法定义为 public 的唯一关系。所有其他关系将此方法定义为 protected。因此，将此作用域与非 hasOne/hasMany 的关系一起使用会引发 Illuminate\Database\Query\Builder::getQualifiedParentKeyName() 异常。
其次，生成的计数 SQL 并非对所有关系都是正确的。同样，它适用于 hasOne/hasMany，但生成的手册 SQL 对于多对多关系 (belongsToMany) 根本不起作用。
不过，我确实找到了解决这两个问题的方法。在查看关系代码以确定异常原因后，我发现 Laravel 已经提供了一个 public 方法来为关系生成计数 SQL：getRelationCountQuery()。适用于所有关系的更新范围方法是：
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$fieldName = $fieldName ?: $relationName; // ex: trainings
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $relation->getRelationCountQuery($related->newQuery(), $query);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
// add the select to the query
return $query->addSelect(DB::raw($select));
}
编辑 3
此更新允许您将闭包传递到将修改添加到 select 字段的计数子查询的范围。
public function scopeSelectRelatedCount($query, $relationName, $fieldName = null, $callback = null)
{
$relation = $this->$relationName(); // ex: $this->trainings()
$related = $relation->getRelated(); // ex: Training
$fieldName = $fieldName ?: $relationName; // ex: trainings
// start a new query for the count statement
$countQuery = $related->newQuery();
// if a callback closure was given, call it with the count query and relationship
if ($callback instanceof Closure) {
call_user_func($callback, $countQuery, $relation);
}
// build the query to get the count of the related records
// ex: select count(*) from trainings where trainings.id = users.id
$subQuery = $relation->getRelationCountQuery($countQuery, $query);
// build the select text to add to the query
// ex: (select count(*) from trainings where trainings.id = users.id) as trainings
$select = '(' . $subQuery->toSql() . ') as ' . $fieldName;
$queryBindings = $query->getBindings();
$countBindings = $countQuery->getBindings();
// if the new count query has parameter bindings, they need to be spliced
// into the existing query bindings in the correct spot
if (!empty($countBindings)) {
// if the current query has no bindings, just set the current bindings
// to the bindings for the count query
if (empty($queryBindings)) {
$queryBindings = $countBindings;
} else {
// the new count query bindings must be placed directly after any
// existing bindings for the select fields
$fields = implode(',', $query->getQuery()->columns);
$numFieldParams = 0;
// shortcut the regex if no ? at all in fields
if (strpos($fields, '?') !== false) {
// count the number of unquoted parameters (?) in the field list
$paramRegex = '/(?:(["\'])(?:\\.|[^])*|\\.|[^\?])+/';
$numFieldParams = preg_match_all($paramRegex, $fields) - 1;
}
// splice into the current query bindings the bindings needed for the count subquery
array_splice($queryBindings, $numFieldParams, 0, $countBindings);
}
}
// add the select to the query and update the bindings
return $query->addSelect(DB::raw($select))->setBindings($queryBindings);
}
有了更新的作用域，您可以使用闭包来修改计数查询：
public function getData() {
$users = User::select(array('users.id', 'users.full_name', 'users.email', 'users.business_unit', 'users.position_id'))
->selectRelatedCount('trainings', 'trainings', function($query, $relation) {
return $query
->where($relation->getTable().'.is_creator', false)
->where($relation->getTable().'.is_speaker', false)
->where($relation->getTable().'.was_absent', false);
})
->where('users.is_active', '=', 1);
return \Datatables::of($users)
->remove_column('id')
->make();
}
注意：在撰写本文时，bllim/laravel4-datatables-package 数据表包在 select 字段的子查询中存在参数绑定问题。数据将正确返回，但计数不会 ("Showing 0 to 0 of 0 entries")。我已经详细说明了这个问题here。这两个选项是使用该问题中提供的代码手动更新数据表包，或者不在计数子查询中使用参数绑定。使用whereRaw避免参数绑定。