ngmy/laravel.aop

Laravel.Aop integrates Ray.Aop with Laravel.

0.1.0 2024-04-09 05:56 UTC

Requires

• php: ^8.1
• laravel/framework: ^9.0 || ^10.0 || ^11.0
• olvlvl/composer-attribute-collector: *
• ray/aop: *
• symfony/finder: *

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8
• ergebnis/composer-normalize: ^2.42
• larastan/larastan: ^2.9
• mockery/mockery: ^1.6
• orchestra/testbench: ^7.0 || ^8.0 || ^9.0
• phpstan/extension-installer: ^1.3

MIT

• Yuta Nagamiya

• aop
• aspect
• laravel

README

Laravel.Aop integrates Ray.Aop with Laravel. It provides fast AOP by static weaving.

Installation

First, you should install Laravel.Aop via the Composer package manager:

composer require ngmy/laravel.aop

You will be asked if you trust the olvlvl/composer-attribute-collector package, so you should press y.

Next, you should configure the olvlvl/composer-attribute-collector package.

Tip

Please see the composer-attribute-collector documentation to learn how to configure the olvlvl/composer-attribute-collector package.

Then, you should publish the Laravel.Aop configuration file using the vendor:publish Artisan command. This command will publish the aop.php configuration file to your application's config directory:

php artisan vendor:publish --provider="Ngmy\LaravelAop\ServiceProvider"

Finally, you should add the @php artisan aop:compile --ansi script to the post-autoload-dump event hook of the composer.json file:

{
    "scripts": {
        "post-autoload-dump": [
            "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
            "@php artisan package:discover --ansi",
            "@php artisan aop:compile --ansi"
        ]
    }
}

Usage

First, you should define the attribute. For example, let's define the Transactional attribute:

<?php

declare(strict_types=1);

namespace App\Attributes;

#[\Attribute(\Attribute::TARGET_METHOD)]
class Transactional {}

Next, you should define the interceptor. For example, let's define the TransactionalInterceptor interceptor:

<?php

declare(strict_types=1);

namespace App\Interceptors;

use Illuminate\Support\Facades\DB;
use Ray\Aop\MethodInterceptor;
use Ray\Aop\MethodInvocation;

class Transactional implements MethodInterceptor
{
    public function invoke(MethodInvocation $invocation): mixed
    {
        return DB::transaction(static fn (): mixed => $invocation->proceed());
    }
}

Tip

Please see the Ray.Aop documentation to learn more about the interceptor.

Then, you should register the attribute and the interceptor in the intercept configuration option of the config/aop.php configuration file. For example, let's register the Transactional attribute and the TransactionalInterceptor interceptor:

use App\Attributes\Transactional;
use App\Interceptors\TransactionalInterceptor;

'intercept' => [
    Transactional::class => [
        TransactionalInterceptor::class,
    ],
],

Then, you should annotate the methods that you want to intercept with the attribute. For example, let's annotate the createUser method of the UserService class with the Transactional attribute:

<?php

declare(strict_types=1);

namespace App\Services;

use App\Attributes\Transactional;
use App\Models\User;

class UserService
{
    #[Transactional]
    public function createUser(string $name): void
    {
        User::create(['name' => $name]);
    }
}

Finally, you should run the dump-autoload Composer command to compile the AOP classes:

composer dump-autoload

Important

After changing the intercept configuration option or changing the annotation of the methods, you should compile the AOP classes again.

Now, the methods annotated with the attribute will be intercepted by the interceptor. In this example, the createUser method of the UserService class will be intercepted by the TransactionalInterceptor and will be executed in a transaction.

Important

The methods annotated with the attribute are intercepted by the interceptor only when the class instance is dependency resolved from the service container. If the class instance is created directly, the methods are not intercepted.

Changelog

Please see the changelog.

License

Laravel.Aop is open-sourced software licensed under the MIT license.