Laravel 模型上的自定义查找方法应该是静态的吗？

Question

在下面的 Laravel 5 模型中，findByIdAndCourseOrFail 方法应该是静态的吗？

class Section extends Model {

    //should this method be static?
    public function findByIdAndCourseOrFail($id, $courseId)
    {

        $result = $this->where('id', $id)->where('course_id', $courseId)->first();

        if (!is_null($result))
        {
            return $result;
        }

        throw (new ModelNotFoundException())->setModel(Section::class);

    }


    }

使用控制器：

class SectionsController extends Controller {

protected $sections;

public function __construct(Section $section)
{

    $this->sections = $section;

}

public function foo($id, $courseId)  //illustration only
{
     $section = $this->sections->findOrFail($id);   

     $section = $this->sections->findByIdAndCourseOrFail($id, $courseId);  
     //would need to be non-static

     $section = Section::findByIdAndCourseOrFail($id, $courseId); 
     //weird when compared with find above
}

一方面，我们没有作用于 Section 实例 [参见注释]。另一方面，在通过Laravel's service container 进行自动依赖注入的控制器中，我们将作用于一个实例：$sections = $this->sections-> findByIdAndCourseOrFail(7,3);，如果Static，我的 IDE (PhpStorm) 会发出声音。

[注意]：此评论可能是对 Laravel 模型如何工作的误解。对我来说，我希望 find()、findOrFail() 是类方法，因此是静态的，而不是 find 方法将返回的实例。

Answer 1

class Section extends Model {


public static function findByIdAndCourseOrFail($id, $courseId)
{

    $result = self::where('id', $id)->where('course_id', $courseId)->first();

    if (!is_null($result))
    {
        return $result;
    }

    throw (new ModelNotFoundException())->setModel(Section::class);

}


}

Answer 2

就我个人而言，我会将其设为静态方法，但我不确定是否有“正确”的答案，尽管两者都可以。我在脑海中将它们分开的方式是，如果我对模型的实例做某事，那么我将其设为正常的公共函数。如果我对 Collection 做某事，我会使用静态。例如：

$person = new Person();
$person->setAdmin(true);
$person->save();

// OR

$admins = Person::getAdmins();

在第一个示例中，我们有一个 Person 的特定实例，并且我们正在对其进行操作，所有代码都只是在操作该特定实例。在第二个示例中，我们对Person 的整个集合进行操作，并且我们希望返回一个对象集合。

在您的情况下，您必须启动 Section 的实例才能使用您的非静态公共方法，如下所示：

$section = new Section();
$foundSection = $section->findByIdAndCourseOrFail(7,3);

所以$section 成为一个从未真正使用过的临时变量。另一方面，如果您将其设为静态，则无需执行此操作即可调用它。

$section = Section::findByIdAndCourseOrFail(7,3);

希望这是有道理的。

Answer 3

我不确定local scopes 是否打算这样使用。但它适用于 laravel 5.2：

public function scopeFindByIdAndCourseOrFail($query, $id, $courseId)
{
    $result = $query->where('id', $id)->where('course_id', $courseId)->first();

    if (!is_null($result))
    {
        return $result;
    }

    throw (new ModelNotFoundException())->setModel(Section::class);
}

在控制器中你可以同时使用它：

$section = Section::findByIdAndCourseOrFail($id, $courseId);

或者

$model = new Section();
$section = $model->findByIdAndCourseOrFail($id, $courseId);