Use HasAttributes::originalIsEquivalent() for attribute change detection

[Gummibeer]

Found the \Illuminate\Database\Eloquent\Concerns\HasAttributes::originalIsEquivalent() method during code diving and it should be usable for our trait! 🎉
This PR would be mainly reasearch when that method was added, if it's compatible with our version support rules and switching our own change detection logic with the core one.

[kallepyorala]

Does that work with attribute casting as well? I was just playing with state attribute which is casted to ModelState and got it working by adding this to LogsActivity trait's attributeValuesToBeLogged function:

if ($old instanceof Spatie\ModelStates\State && $new instanceof Spatie\ModelStates\State) {
    return $old->equals($new) ? 0 : 1;
}

I think there should be some generic way to handle all casted attributes.

[Gummibeer]

@azurinspire no, it has a lot of cases but none for custom casts - these will fall back to strcmp.
https://github.com/laravel/framework/blob/95c86075d80daf54ba370db8a991c378cba1ebcd/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php#L1646-L1680

I think it would help if we move the current diff-check callback to its own method and write it that you can easily override and extend it.

laravel-activitylog/src/Traits/LogsActivity.php

Lines 289 to 304 in 334e742

	function ($new, $old) {
	// Strict check for php's weird behaviors
	if ($old === null || $new === null) {
	return $new === $old ? 0 : 1;
	}
	// Handels Date intervels comparsons since php cannot use spaceship
	// Operator to compare them and will throw ErrorException.
	if ($old instanceof DateInterval) {
	return CarbonInterval::make($old)->equalTo($new) ? 0 : 1;
	} elseif ($new instanceof DateInterval) {
	return CarbonInterval::make($new)->equalTo($old) ? 0 : 1;
	}
	return $new <=> $old;
	}

public function foobar(): int
{
    $foo = parent::foobar();

    if ($old instanceof Spatie\ModelStates\State && $new instanceof Spatie\ModelStates\State) {
        return $old->equals($new) ? 0 : 1;
    }

    return $foo;
}

(intentionally used foobar as I didn't have time now to imagine a proper name)

But such a change would help allow you to adjust the value comparison without overriding the whole surrounding method!?

[kallepyorala]

@Gummibeer sounds good solution to me