ray/aop

An aspect oriented framework

Monday, July 30, 2018
by koriym
Repository
10 Watchers
56 Stars
79,610 Installations

PHP
8 Dependents
0 Suggesters
13 Forks
0 Open issues
48 Versions
8 % Grown

The README.md

Ray.Aop

Aspect Oriented Framework

, _(*1)

, _(*2)

[Japanese], _(*3)

Ray.Aop package provides method interception. This feature enables you to write code that is executed each time a matching method is invoked. It's suited for cross cutting concerns ("aspects"), such as transactions, security and logging. Because interceptors divide a problem into aspects rather than objects, their use is called Aspect Oriented Programming (AOP)., _(*4)

A Matcher is a simple interface that either accepts or rejects a value. For Ray.AOP, you need two matchers: one that defines which classes participate, and another for the methods of those classes. To make this easy, there's factory class to satisfy the common scenarios., _(*5)

MethodInterceptors are executed whenever a matching method is invoked. They have the opportunity to inspect the call: the method, its arguments, and the receiving instance. They can perform their cross-cutting logic and then delegate to the underlying method. Finally, they may inspect the return value or exception and return. Since interceptors may be applied to many methods and will receive many calls, their implementation should be efficient and unintrusive., _(*6)

Example: Forbidding method calls on weekends

To illustrate how method interceptors work with Ray.Aop, we'll forbid calls to our pizza billing system on weekends. The delivery guys only work Monday thru Friday so we'll prevent pizza from being ordered when it can't be delivered! This example is structurally similar to use of AOP for authorization., _(*7)

To mark select methods as weekdays-only, we define an attribute., _(*8)

<?php
#[Attribute(Attribute::TARGET_METHOD)]
final class NotOnWeekends
{
}

...and apply it to the methods that need to be intercepted:, _(*9)

<?php
class RealBillingService
{
    #[NotOnWeekends] 
    public function chargeOrder(PizzaOrder $order, CreditCard $creditCard)
    {

Next, we define the interceptor by implementing the org.aopalliance.intercept.MethodInterceptor interface. When we need to call through to the underlying method, we do so by calling $invocation->proceed():, _(*10)

<?php
class WeekendBlocker implements MethodInterceptor
{
    public function invoke(MethodInvocation $invocation)
    {
        $today = getdate();
        if ($today['weekday'][0] === 'S') {
            throw new \RuntimeException(
                $invocation->getMethod()->getName() . " not allowed on weekends!"
            );
        }
        return $invocation->proceed();
    }
}

Finally, we configure everything using the Aspect class:, _(*11)

use Ray\Aop\Aspect;
use Ray\Aop\Matcher;

$aspect = new Aspect();
$aspect->bind(
    (new Matcher())->any(),
    (new Matcher())->annotatedWith(NotOnWeekends::class),
    [new WeekendBlocker()]
);

$billing = $aspect->newInstance(RealBillingService::class);
try {
    echo $billing->chargeOrder(); // Interceptors applied
} catch (\RuntimeException $e) {
    echo $e->getMessage() . "\n";
    exit(1);
}

Putting it all together, (and waiting until Saturday), we see the method is intercepted and our order is rejected:, _(*12)

chargeOrder not allowed on weekends!

PECL Extension

Ray.Aop also supports a PECL extension. When the extension is installed, you can use the weave method to apply aspects to all classes in a directory:, _(*13)

$aspect = new Aspect();
$aspect->bind(
    (new Matcher())->any(),
    (new Matcher())->annotatedWith(NotOnWeekends::class),
    [new WeekendBlocker()]
);
// Weave aspects into all matching classes in the source directory
$aspect->weave('/path/to/src');

// Or weave into specific target directory
$aspect->weave('/path/to/target');

$billing = new RealBillingService();
echo $billing->chargeOrder(); // Interceptors applied

With the PECL extension: - You can create new instances anywhere in your code using the normal new keyword. - Interception works even with final classes and methods., _(*14)

To use these features, simply install the PECL extension and Ray.Aop will automatically utilize it when available. PHP 8.1+ is required for the PECL extension., _(*15)

Installing the PECL extension

PHP 8.1 or higher is required to use the PECL extension. For more information, see ext-rayaop., _(*16)

Configuration Options

When creating an Aspect instance, you can optionally specify a temporary directory:, _(*17)

$aspect = new Aspect('/path/to/tmp/dir');

If not specified, the system's default temporary directory will be used., _(*18)

This concludes the basic usage of Ray.Aop. For more detailed information and advanced usage, please refer to the full documentation., _(*19)

Own matcher

You can have your own matcher. To create contains matcher, You need to provide a class which have two method. One is matchesClass for class match. The other one is matchesMethod method match. Both return the boolean result of matched., _(*20)

use Ray\Aop\AbstractMatcher;
use Ray\Aop\Matcher;

class IsContainsMatcher extends AbstractMatcher
{
    /**
     * {@inheritdoc}
     */
    public function matchesClass(\ReflectionClass $class, array $arguments) : bool
    {
        [$contains] = $arguments;

        return (strpos($class->name, $contains) !== false);
    }

    /**
     * {@inheritdoc}
     */
    public function matchesMethod(\ReflectionMethod $method, array $arguments) : bool
    {
        [$contains] = $arguments;

        return (strpos($method->name, $contains) !== false);
    }
}

Interceptor Details

In an interceptor, a MethodInvocation object is passed to the invoke method:, _(*21)

class MyInterceptor implements MethodInterceptor
{
    public function invoke(MethodInvocation $invocation)
    {
        // Before method invocation
        $result = $invocation->proceed();
        // After method invocation
        return $result;
    }
}

$invocation->proceed() invokes the next interceptor in the chain. If no more interceptors are present, it calls the target method. This chaining allows multiple interceptors for a single method, executing in the order bound., _(*22)

Example execution flow for interceptors A, B, and C:, _(*23)

Interceptor A (before)
Interceptor B (before)
Interceptor C (before)
Target method
Interceptor C (after)
Interceptor B (after)
Interceptor A (after)

This chaining mechanism allows you to combine multiple cross-cutting concerns (like logging, security, and performance monitoring) for a single method., _(*24)

With the MethodInvocation object, you can:, _(*25)

$invocation->proceed() - Invoke method
$invocation->getMethod() - Get method reflection
$invocation->getThis() - Get object
$invocation->getArguments() - Get parameters
$invocation->getNamedArguments() - Get named parameters An extended ClassRefletion and MethodReflection holds methos to get PHP 8 attribute and doctrine annotation(s) .

/** @var $method \Ray\Aop\ReflectionMethod */
$method = $invocation->getMethod();
/** @var $class \Ray\Aop\ReflectionClass */
$class = $invocation->getMethod()->getDeclaringClass();

$method->getAnnotations() - Get method attributes/annotations
$method->getAnnotation($name) - Get method attribute/annotation
$class->->getAnnotations() - Get class attributes/annotations
$class->->getAnnotation($name) - Get class attributes/annotation

Annotation/Attribute

Ray.Aop can be used either with doctrine/annotation in PHP 7/8 or with an Attributes in PHP8., _(*26)

AOP Alliance

The method interceptor API implemented by Ray.Aop is a part of a public specification called AOP Alliance., _(*27)

Installation

The recommended way to install Ray.Aop is through Composer., _(*28)

# Add Ray.Aop as a dependency
$ composer require ray/aop ^2.0

PHP8 attributes only (recommended)

SevericeLocator::setReader(new AttributeReader);`

Integrated DI framework

See also the DI framework Ray.Di which integrates DI and AOP.

Stability

Ray.Aop follows semantic versioning and ensures backward compatibility. Released in 2015, version 2.0 and its successors have maintained compatibility while evolving with PHP, and we remain committed to this stability., _(*29)

Note: This documentation of the part is taken from Guice/AOP. z1

The Versions

30/07 2018

2.x-dev

2.9999999.9999999.9999999-dev

An aspect oriented framework

library aop

An aspect oriented framework

ray/aop

The README.md

Ray.Aop

Aspect Oriented Framework

Example: Forbidding method calls on weekends

PECL Extension

Installing the PECL extension

Configuration Options

Own matcher

Interceptor Details

Annotation/Attribute

AOP Alliance

Installation

PHP8 attributes only (recommended)

Integrated DI framework

Stability

The Versions

2.x-dev

The Requires

The Development Requires

by Akihito Koriyama

2.7.6

The Requires

The Development Requires

by Akihito Koriyama

2.7.5

The Requires

The Development Requires

by Akihito Koriyama

2.7.4

The Requires

The Development Requires

by Akihito Koriyama

2.7.3

The Requires

The Development Requires

by Akihito Koriyama

dev-multi

The Requires

The Development Requires

by Akihito Koriyama

2.7.2

The Requires

The Development Requires

by Akihito Koriyama

2.7.1

The Requires

The Development Requires

by Akihito Koriyama

2.7.0

The Requires

The Development Requires

by Akihito Koriyama

2.6.0

The Requires

The Development Requires

by Akihito Koriyama

dev-annotation-loader

The Requires

The Development Requires

by Akihito Koriyama

2.5.2

The Requires

The Development Requires

by Akihito Koriyama

dev-revert

The Requires

The Development Requires

by Akihito Koriyama

2.5.1

The Requires

The Development Requires

by Akihito Koriyama

2.5.0

The Requires

The Development Requires

by Akihito Koriyama

2.4.2