Skip to content
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

[11.x] Fix Macroable trait conflicting with class magic methods #54885

Closed
wants to merge 8 commits into from
14 changes: 14 additions & 0 deletions src/Illuminate/Macroable/Traits/Macroable.php
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ public static function flushMacros()
public static function __callStatic($method, $parameters)
{
if (! static::hasMacro($method)) {
foreach (class_parents(static::class) as $parent) {
if (method_exists($parent, '__callStatic')) {
/** @phpstan-ignore class.noParent, staticMethod.notFound */
return parent::__callStatic($method, $parameters);
}
}

Comment on lines +89 to +95
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
foreach (class_parents(static::class) as $parent) {
if (method_exists($parent, '__callStatic')) {
/** @phpstan-ignore class.noParent, staticMethod.notFound */
return parent::__callStatic($method, $parameters);
}
}
if(is_callable(['parent', '__callStatic']) {
return parent::__callStatic($method, $parameters);
}

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would be nicer, but it is deprecated by now.

throw new BadMethodCallException(sprintf(
'Method %s::%s does not exist.', static::class, $method
));
Expand All @@ -112,6 +119,13 @@ public static function __callStatic($method, $parameters)
public function __call($method, $parameters)
{
if (! static::hasMacro($method)) {
foreach (class_parents(static::class) as $parent) {
if (method_exists($parent, '__call')) {
/** @phpstan-ignore class.noParent, staticMethod.notFound */
return parent::__call($method, $parameters);
}
}
Comment on lines +122 to +127
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
foreach (class_parents(static::class) as $parent) {
if (method_exists($parent, '__call')) {
/** @phpstan-ignore class.noParent, staticMethod.notFound */
return parent::__call($method, $parameters);
}
}
if(is_callable(['parent', '__call']) {
return parent::__call($method, $parameters);
}

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would be nicer, but it is deprecated by now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MrPunyapal

is_callable(['parent', '__call'])

Using parent as a string on a callable is deprecated.

Reference: https://wiki.php.net/rfc/deprecate_partially_supported_callables

But this is fine:

if(is_callable([parent::class, '__call']) {
   return parent::__call($method, $parameters);
}

See this section on the RFC: https://wiki.php.net/rfc/deprecate_partially_supported_callables#backward_incompatible_changes

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks I thought that is_callable is deprecated!
Thanks for clearing 🫡


throw new BadMethodCallException(sprintf(
'Method %s::%s does not exist.', static::class, $method
));
Expand Down
163 changes: 163 additions & 0 deletions tests/Integration/Database/EloquentMacroableTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<?php

namespace Illuminate\Tests\Integration\Database;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Foundation\Testing\LazilyRefreshDatabase;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Traits\Macroable;
use Orchestra\Testbench\TestCase;

class EloquentMacroableTest extends TestCase
{
use LazilyRefreshDatabase;

protected function setUp(): void
{
parent::setUp();

// Create tables
Schema::create('test_companies', function (Blueprint $table) {
$table->id();
$table->string('name');
$table->timestamps();
});

Schema::create('test_teams', function (Blueprint $table) {
$table->id();
$table->foreignId('company_id')->constrained('test_companies');
$table->string('name');
$table->timestamps();
});

// Register the service provider to define the macro
$this->app->register(TestMacroServiceProvider::class);
}

public function test_create_static_method_works_with_macroable()
{
// This test verifies that static methods like create() continue to work
// even when the Macroable trait is used

$company = TestCompany::create(['name' => 'Test Company']);

$this->assertInstanceOf(TestCompany::class, $company);
$this->assertEquals('Test Company', $company->name);
$this->assertTrue($company->exists);
}

public function test_query_first_works_with_macroable()
{
// This test verifies that eloquent methods for retrieving models from the database
// work correctly even when the Macroable trait is used

// Create a company using the create method
TestCompany::create(['name' => 'First Company']);

// Retrieve it using first()
$company = TestCompany::query()->first();

$this->assertInstanceOf(TestCompany::class, $company);
$this->assertEquals('First Company', $company->name);
}

public function test_custom_macro_works()
{
// This test verifies that custom macros work with model instances

$company = TestCompany::create(['name' => 'Macro Test Company']);

// Use the custom macro
$result = $company->getCompanyDetails();

$this->assertEquals('Macro Test Company (ID: 1)', $result);
}

public function test_static_macro_works()
{
// This test verifies that static macros work

$result = TestCompany::findByName('Static Macro Company');

$this->assertNull($result); // Should be null since we haven't created this company

// Create the company and try again
TestCompany::create(['name' => 'Static Macro Company']);

$result = TestCompany::findByName('Static Macro Company');
$this->assertInstanceOf(TestCompany::class, $result);
$this->assertEquals('Static Macro Company', $result->name);
}

public function test_both_eloquent_and_macros_work_together()
{
// This test verifies the integration of Eloquent functionality and macros

// Create a company and its team
$company = TestCompany::create(['name' => 'Integrated Company']);
$team = $company->teams()->create(['name' => 'Integrated Team']);

// Retrieve the company and use both Eloquent methods and macros
$retrieved = TestCompany::find($company->id);
$this->assertEquals('Integrated Company', $retrieved->name);

// Use the custom macro
$details = $retrieved->getCompanyDetails();
$this->assertEquals('Integrated Company (ID: 1)', $details);

// Use the relationship
$this->assertCount(1, $retrieved->teams);
$this->assertEquals('Integrated Team', $retrieved->teams->first()->name);
}
}

class TestCompany extends Model
{
use Macroable;

protected $table = 'test_companies';
protected $fillable = ['name'];

public function teams()
{
return $this->hasMany(TestTeam::class, 'company_id');
}
}

class TestTeam extends Model
{
protected $table = 'test_teams';
protected $fillable = ['company_id', 'name'];

public function company()
{
return $this->belongsTo(TestCompany::class, 'company_id');
}
}

class TestMacroServiceProvider extends ServiceProvider
{
public function register()
{
// Nothing to register
}

public function boot()
{
// Instance macro
TestCompany::macro('getCompanyDetails', function () {
/** @var TestCompany $this */
return $this->name.' (ID: '.$this->id.')';
});

// Static macro
TestCompany::macro('findByName', function ($name) {
/** @var \Illuminate\Database\Eloquent\Builder $query */
$query = TestCompany::query();

return $query->where('name', $name)->first();
});
}
}
Loading