Skip to content

[12.x] Add Boot and Initialize Model attributes #56518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/Illuminate/Database/Eloquent/Attributes/Boot.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Illuminate\Database\Eloquent\Attributes;

use Attribute;

#[Attribute(Attribute::TARGET_METHOD)]
class Boot
{
//
}
11 changes: 11 additions & 0 deletions src/Illuminate/Database/Eloquent/Attributes/Initialize.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

namespace Illuminate\Database\Eloquent\Attributes;

use Attribute;

#[Attribute(Attribute::TARGET_METHOD)]
class Initialize
{
//
}
29 changes: 18 additions & 11 deletions src/Illuminate/Database/Eloquent/Model.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Database\ConnectionResolverInterface as Resolver;
use Illuminate\Database\Eloquent\Attributes\Boot;
use Illuminate\Database\Eloquent\Attributes\Initialize;
use Illuminate\Database\Eloquent\Attributes\Scope as LocalScope;
use Illuminate\Database\Eloquent\Attributes\UseEloquentBuilder;
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
Expand Down Expand Up @@ -360,23 +362,28 @@ protected static function bootTraits()

static::$traitInitializers[$class] = [];

foreach (class_uses_recursive($class) as $trait) {
$method = 'boot'.class_basename($trait);
$uses = class_uses_recursive($class);

if (method_exists($class, $method) && ! in_array($method, $booted)) {
forward_static_call([$class, $method]);
$conventionalBootMethods = array_map(static fn ($trait) => 'boot'.class_basename($trait), $uses);
$conventionalInitMethods = array_map(static fn ($trait) => 'initialize'.class_basename($trait), $uses);

$booted[] = $method;
}
foreach ((new ReflectionClass($class))->getMethods() as $method) {
if (! in_array($method->getName(), $booted) &&
$method->isStatic() &&
(in_array($method->getName(), $conventionalBootMethods) ||
$method->getAttributes(Boot::class) !== [])) {
$method->invoke(null);

if (method_exists($class, $method = 'initialize'.class_basename($trait))) {
static::$traitInitializers[$class][] = $method;
$booted[] = $method->getName();
}

static::$traitInitializers[$class] = array_unique(
static::$traitInitializers[$class]
);
if (in_array($method->getName(), $conventionalInitMethods) ||
$method->getAttributes(Initialize::class) !== []) {
static::$traitInitializers[$class][] = $method->getName();
}
}

static::$traitInitializers[$class] = array_unique(static::$traitInitializers[$class]);
}

/**
Expand Down
42 changes: 42 additions & 0 deletions tests/Integration/Queue/ModelSerializationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

namespace Illuminate\Tests\Integration\Queue;

use Illuminate\Database\Eloquent\Attributes\Boot;
use Illuminate\Database\Eloquent\Attributes\Initialize;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Pivot;
Expand Down Expand Up @@ -210,16 +212,26 @@ public function testItCanRunModelBootsAndTraitInitializations()
$model = new ModelBootTestWithTraitInitialization();

$this->assertTrue($model->fooBar);
$this->assertTrue($model->initializedViaAttributeInClass);
$this->assertTrue($model->initializedViaAttributeInTrait);
$this->assertTrue($model::hasGlobalScope('foo_bar'));
$this->assertTrue($model::hasGlobalScope('booted_attr_in_class'));
$this->assertTrue($model::hasGlobalScope('booted_attr_in_trait'));

$model::clearBootedModels();

$this->assertFalse($model::hasGlobalScope('foo_bar'));
$this->assertFalse($model::hasGlobalScope('booted_attr_in_class'));
$this->assertFalse($model::hasGlobalScope('booted_attr_in_trait'));

$unSerializedModel = unserialize(serialize($model));

$this->assertFalse($unSerializedModel->fooBar);
$this->assertFalse($unSerializedModel->initializedViaAttributeInClass);
$this->assertFalse($unSerializedModel->initializedViaAttributeInTrait);
$this->assertTrue($model::hasGlobalScope('foo_bar'));
$this->assertTrue($model::hasGlobalScope('booted_attr_in_class'));
$this->assertTrue($model::hasGlobalScope('booted_attr_in_trait'));
}

/**
Expand Down Expand Up @@ -402,6 +414,8 @@ public function test_serialization_types_empty_custom_eloquent_collection()

trait TraitBootsAndInitializersTest
{
public bool $initializedViaAttributeInTrait = false;

public $fooBar = false;

public function initializeTraitBootsAndInitializersTest()
Expand All @@ -414,11 +428,39 @@ public static function bootTraitBootsAndInitializersTest()
static::addGlobalScope('foo_bar', function () {
});
}

#[Boot]
public static function nonConventionalBootFunctionInTrait()
{
static::addGlobalScope('booted_attr_in_trait', function () {});
}

#[Initialize]
public function nonConventionalInitFunctionInTrait()
{
$this->initializedViaAttributeInTrait = ! $this->initializedViaAttributeInTrait;
}
}

class ModelBootTestWithTraitInitialization extends Model
{
use TraitBootsAndInitializersTest;

public static bool $bootedViaAttributeInClass = false;

public bool $initializedViaAttributeInClass = false;

#[Boot]
public static function nonConventionalBootFunctionInClass()
{
static::addGlobalScope('booted_attr_in_class', function () {});
}

#[Initialize]
public function nonConventionalInitFunctionInClass()
{
$this->initializedViaAttributeInClass = ! $this->initializedViaAttributeInClass;
}
}

class ModelSerializationTestUser extends Model
Expand Down
Loading