加载模型的所有关系

时间：2015-01-02 12:38:38

标签： php laravel

通常为了加载关系我会做这样的事情：

Model::with('foo', 'bar', 'baz')...

解决方案可能是设置$with = ['foo','bar','baz']但是每当我调用Model时，它总会加载这三种关系

是否可以执行以下操作：Model::with('*')？

8 个答案:

答案 0 :(得分：19)

不，它不是，至少没有一些额外的工作，因为你的模型在实际加载之前不知道它支持哪些关系。

我在自己的Laravel套餐中遇到过这个问题。没有办法获得模型与Laravel的关系列表。如果你看看它们是如何定义的，那很明显。返回Relation对象的简单函数。你甚至无法使用php的反射类获得函数的返回类型，因此无法区分关系函数和任何其他函数。

您可以做的更容易的事情是定义一个添加所有关系的函数。 为此，您可以使用eloquents query scopes（感谢Jarek Tkaczyk在评论中提及它。）

public function scopeWithAll($query) 
{
    $query->with('foo', 'bar', 'baz');
}

使用范围而不是静态函数不仅允许您直接在模型上使用函数，而且还可以在以任何顺序链接查询构建器方法（如where）时使用：

Model::where('something', 'Lorem ipsum dolor')->withAll()->where('somethingelse', '>', 10)->get();

获得支持关系的替代方案

虽然Laravel不支持开箱即用的东西，但你可以自己添加它。

注解

我使用注释来确定函数是否是我上面提到的包中的关系。注释不是php的正式部分，但很多人使用doc块来模拟它们。 Laravel 5也将在其路线定义中使用注释，因此我认为在这种情况下它不是不好的做法。优点是，您不需要维护单独的支持关系列表。

为每个关系添加注释：

/**
 * @Relation
 */
public function foo() 
{
    return $this->belongsTo('Foo');
}

编写一个函数来解析模型中所有方法的doc块并返回名称。您可以在模型或父类中执行此操作：

public static function getSupportedRelations() 
{
    $relations = [];
    $reflextionClass = new ReflectionClass(get_called_class());

    foreach($reflextionClass->getMethods() as $method) 
    {
        $doc = $method->getDocComment();

        if($doc && strpos($doc, '@Relation') !== false) 
        {
            $relations[] = $method->getName();
        }
    }

    return $relations;
}

然后在withAll函数中使用它们：

public function scopeWithAll($query) 
{
    $query->with($this->getSupportedRelations());
}

有些像php中的注释，有些不喜欢。我喜欢这个简单的用例。

支持的关系数组

您还可以维护所有受支持关系的数组。然而，这需要您始终将其与可用关系同步，特别是如果涉及多个开发人员，则不是总是那么容易。

protected $supportedRelations = ['foo','bar', 'baz'];

然后在withAll函数中使用它们：

public function scopeWithAll($query) 
{
    return $query->with($this->supportedRelations);
}

你当然也可以override with like lukasgeiter mentioned in his answer。这比使用withAll更清晰。如果您使用注释或配置数组，则意见问题。

答案 1 :(得分：4)

我不会使用static这样的建议方法，因为......它的滔滔不绝;） 只需利用它已经提供的功能 - 范围。

当然它不会为你（主要问题）做到这一点，但这绝对是要走的路：

// SomeModel
public function scopeWithAll($query)
{
    $query->with([ ... all relations here ... ]); 
    // or store them in protected variable - whatever you prefer
    // the latter would be the way if you want to have the method
    // in your BaseModel. Then simply define it as [] there and use:
    // $query->with($this->allRelations); 
}

通过这种方式，您可以随意使用它：

// static-like
SomeModel::withAll()->get();

// dynamically on the eloquent Builder
SomeModel::query()->withAll()->get();
SomeModel::where('something', 'some value')->withAll()->get();

另外，实际上你可以让Eloquent为你做这件事，就像Doctrine一样 - 使用doctrine/annotations和DocBlocks。你可以这样做：

// SomeModel

/**
 * @Eloquent\Relation
 */
public function someRelation()
{
  return $this->hasMany(..);
}

将故事包含在这里有点太长了，所以要了解它是如何运作的：http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/annotations-reference.html

答案 2 :(得分：3)

如果没有自己指定，就没有办法知道所有关系是什么。发布的其他答案如何是好的，但我想添加一些内容。

基本型号

我觉得你想要在多个模型中做到这一点，所以一开始我会创建一个BaseModel，如果你还没有。

class BaseModel extends Eloquent {
    public $allRelations = array();
}

“Config”数组

我建议您使用成员变量，而不是将关系硬编码到方法中。如您所见，我已经添加了$allRelations。请注意，由于Laravel已在内部使用它，因此无法将其命名为$relations。

覆盖with()

既然你想要with(*)，你也可以这样做。将其添加到BaseModel 

public static function with($relations){
    $instance = new static;
    if($relations == '*'){
        $relations = $instance->allRelations;
    }
    else if(is_string($relations)){
        $relations = func_get_args();
    }
    return $instance->newQuery()->with($relations);
}

（顺便说一下，这个函数的某些部分来自原始的Model类）

用法

class MyModel extends BaseModel {
    public $allRelations = array('foo', 'bar');
}

MyModel::with('*')->get();

答案 3 :(得分：2)

由于我遇到了类似的问题，并找到了一个很好的解决方案，这里没有描述，也不需要填写一些自定义数组或其他什么，我会发布它以供将来使用。

我做的是首先创建一个名为trait的{​​{1}}：

RelationsManager

现在你可以在任何类中使用它，比如 - 

trait RelationsManager
{
    protected static $relationsList = [];

    protected static $relationsInitialized = false;

    protected static $relationClasses = [
        HasOne::class,
        HasMany::class,
        BelongsTo::class,
        BelongsToMany::class
    ];

    public static function getAllRelations($type = null) : array
    {
        if (!self::$relationsInitialized) {
            self::initAllRelations();
        }

        return $type ? (self::$relationsList[$type] ?? []) : self::$relationsList;
    }

    protected static function initAllRelations()
    {
        self::$relationsInitialized = true;

        $reflect = new ReflectionClass(static::class);

        foreach($reflect->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
            /** @var ReflectionMethod $method */
            if ($method->hasReturnType() && in_array((string)$method->getReturnType(), self::$relationClasses)) {
                self::$relationsList[(string)$method->getReturnType()][] = $method->getName();
            }
        }
    }

    public static function withAll() : Builder
    {
        $relations = array_flatten(static::getAllRelations());

        return $relations ? self::with($relations) : self::query();
    }
}

然后当你需要从数据库中获取它们时：

class Project extends Model
{
    use RelationsManager;

    //... some relations

}

一些注意事项 - 我的示例关系类列表不包含变形关系，所以如果你想获得它们 - 你需要将它们添加到$projects = Project::withAll()->get(); 变量。此外，此解决方案仅适用于PHP 7。

答案 4 :(得分：1)

您可以尝试使用反射检测特定于模型的方法，例如：

$base_methods = get_class_methods('Illuminate\Database\Eloquent\Model');
$model_methods = get_class_methods(get_class($entry));
$maybe_relations = array_diff($model_methods, $base_methods);

dd($maybe_relations);

然后尝试将每个加载到一个控制良好的try/catch中。 Laravel的模型类具有加载和 loadMissing 方法，可用于预先加载。

请参阅api reference.

答案 5 :(得分：0)

您可以在模型中创建方法

public static function withAllRelations() {
   return static::with('foo', 'bar', 'baz');
}

并致电Model::withAllRelations()

或者

$instance->withAllRelations()->first(); // or ->get()

答案 6 :(得分：0)

您无法为某个型号加载动态关系。你需要告诉模型支持哪些关系。

答案 7 :(得分：0)

作曲家需要 adideas/laravel-get-relationship-eloquent-model

https://packagist.org/packages/adideas/laravel-get-relationship-eloquent-model

Laravel 获取所有 eloquent 模型的关系！

您无需知道模型中方法的名称即可执行此操作。拥有一个或多个 Eloquent 模型，多亏了这个包，你可以在运行时获取它的所有关系和它们的类型

相关问题
最新问题