Macroable trait conflict with Classes with Magic Methods

[rsd]

Laravel Version

10.x to master

PHP Version

8.x

Database Driver & Version

No response

Description

Hello,

The Macroable trait does not work if used in a class that also uses __call or __callStatic magic methods.

That's because when either __call or __callStatic is called it assumes that it is because of a registered macro. If not found it will throw an error instead of passing the call upstream in (e.g.) parent::_call[Static].

I created a very small project to demonstrate this problem at https://github.com/rsd/macroable-test.

This problem affects, but is not limited to Eloquent Models.

One could argue that resolveRelationUsing() could be used. However, resolveRelationUsing() does not take any arguments. If your method needs one or more arguments macro() is the only way.

Keeping with the Eloquent scenario, one reason to want to use this way instead of having it all in the Model is to be able to break optional dependable Models into different Laravel Modules or packages.

For example:
Students model has all general information for students in a College.
Different Colleges could need other models to expand Students information depending on the majors it offers, like Engineer, Physics, Arts.
So, different Colleges would install the modules / packages it needs.
Otherwise, it would need all relationships to be hardcoded into the Students Model breaking modularity.

I have already created PRs for:

• 13.x (master) [13.x] Fix Macroable trait conflicting with class magic methods #54884 ,
• 12.x [12.x] Fix Macroable trait conflicting with class magic methods #54881 ,
• 11.x [11.x] Fix Macroable trait conflicting with class magic methods #54885 and
• 10.x [10.x] Fix Macroable trait conflicting with class magic methods #54886 which was closed (but I would like the chance to have it reexamined).

Note that the solution is barely 3 lines per method.

Steps To Reproduce

1 - Create a Model like:

class TestCompany extends Model
{
    use Macroable;

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

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

2 - Register a macro() at a ServiceProvider like:

class TestMacroServiceProvider extends ServiceProvider
{
    public function boot()
    {
        // Instance macro
        TestCompany::macro('getCompanyDetails', function () {
            return $this->name.' (ID: '.$this->id.')';
        });
    }
}

Call it like:

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

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

Macroable will throw an exception for create or hydrate.

[macropay-solutions]

As you can see, it is enough to check first parent not all parents.

class_parents should be replaced with get_parent_class

  if (\is_string($parent = \get_parent_class(static::class)) && \method_exists($parent, '__callStatic')) {
          /** @phpstan-ignore class.noParent, staticMethod.notFound */
          return $parent::__callStatic($method, $parameters);
      }
  }

  if (\is_string($parent = \get_parent_class(static::class)) && \method_exists($parent, '__call')) {
      /** @phpstan-ignore class.noParent, staticMethod.notFound */
      return parent::__call($method, $parameters);
  }