Upgrade Guide

From version 6.x to 7.x.

• From version 6.x to 7.x.
  • PHP version 8.1 required
  • Laravel v10.x
  • Field Criteria
  • Date Filter
  • Api Resource Service Provider
  • Audit Package
  • Changed publicPath() and langPath() in Core Application
  • Removed SearchProcessor::language()
  • Removed Str::tree()
• Onward

PHP version 8.1 required

You need PHP v8.1 or higher to run Athenaeum packages.

Note: PHP v8.2 is supported!

Laravel v10.x

Please read Laravel's upgrade guide, before continuing here.

Field Criteria

The \Aedart\Contracts\Database\Query\FieldCriteria::make() and \Aedart\Database\Query\FieldFilter::make() now have optional $field argument. This will allow creating instances of custom filters, without specifying a field. The instance will NOT be applicable, until a field has been set.

use Aedart\Filters\Query\Filters\Fields\BelongsToFilter;

$filter = BelongsToFilter::make();

// ...later in your application
$filter->setField('authors');

Date Filter

The \Aedart\Filters\Query\Filters\Fields\DateFilter::allowedDateFormats() method's visibility has been changed to public (previously protected). The method now returns a default set of supported date formats. These can also be specified via the setAllowedDateFormats() method.

use Aedart\Filters\Query\Filters\Fields\DateFilter;

$filter = DateFilter::make('event_date')
    ->setAllowedDateFormats('Y-m-d');

Api Resource Service Provider

The ApiResourceServiceProvider is now an aggregate service provider, which automatically registers the ETagsServiceProvider and the new JsonResourceServiceProvider (the previous version of ApiResourceServiceProvider).

Audit Package

The Audit package has been slightly refactored. As a result, a few components have been deprecated and replaced with improved versions. However, the dispatched events have undergone some breaking changes.

Deprecations

• \Aedart\Audit\Traits\RecordsChanges trait. Replaced by \Aedart\Audit\Concerns\ChangeRecording.
• \Aedart\Audit\Traits\HasAuditTrail trait Replaced by \Aedart\Audit\Concerns\AuditTrail.
• \Aedart\Audit\Models\Concerns\AuditTrailConfiguration concern. Replaced by \Aedart\Audit\Concerns\AuditTrailConfig.

The deprecated components will be removed in the next major version.

Dispatch Multiple Models Changed

The ModelChangedEvents::dispatchMultipleModelsChanged() no longer skips all models, if the first is marked as "skip next recording" (via model's skipRecordingNextChange()). Instead, models are now filtered by their skip state. Only if the models allow recording, will they be included in the dispatched event.

Multiple Models Changed Event

The public $models attribute can no longer be an array, in MultipleModelsChanged. The attribute must now be a Collection instance.

Model Changed Events (trait)

The \Aedart\Audit\Observers\Concerns\ModelChangedEvents concern/trait has been redesigned. Its methods now accept all supported arguments of ModelHasChanged event. Previously, only $model, event $type and a $message was accepted. Now, the all create / make methods accept the following arguments:

• Model $model The model that has changed.
• string $type The event type.
• array|null $original = null (optional) Original data (attributes) before change occurred. Default's to given model's original data, if none given.
• array|null $changed = null (optional) Changed data (attributes) after change occurred. Default's to given model's changed data, if none given.
• string|null $message = null (optional) Eventual user provided message associated with the event. Defaults to model's Audit Trail Message, if available.
• Model|Authenticatable|null $user = null (optional) The user that caused the change. Defaults to current authenticated user.
• DateTimeInterface|Carbon|string|null $performedAt = null (optional) Date and time of when the event happened. Defaults to model's "updated at" value, if available, If not, then current date time is used.

Changed publicPath() and langPath() in Core Application

From Laravel v10.x, the \Illuminate\Contracts\Foundation\Application interface defines publicPath() and langPath(), which the Core application inherits from. The method signature has changed and may cause compatible issues, if you overwrite these methods.

Before

// ...In \Aedart\Contracts\Core\Application...

public function publicPath();

public function langPath(string $path = ''): string;

Now

// ...Inherited from \Illuminate\Contracts\Foundation\Application...

public function publicPath($path = '');

public function langPath($path = '');

If you have overwritten these methods, then you must ensure that the method signature is compatible with Laravel's Application interface.

Removed SearchProcessor::language()

The deprecated \Aedart\Filters\Processors\SearchProcessor::language() method has been removed. This features didn't work as intended. No replacement has been implemented.

Removed Str::tree()

\Aedart\Utils\Str::tree() was deprecated in v6.4. It has been replaced by \Aedart\Utils\Arr::tree().

Onward

More extensive details can be found in the changelog.