Roadmap

[WalterWoshid]

Roadmap

• Explicit aspects (adding aspects directly to classes or methods): Implement Explicit Aspects #8

• Create a flowchart (WIP)

• Document how to use xdebug with php-unit tests that use the #[RunTestsInSeparateProcesses] attribute (PhpStorm)

• Add support for Production/Development environments:

  • Production: Cache will not be checked for updates (better performance)
  • Development: Cache will be checked for updates (better debugging experience)

• Test with Dependency Injection for aspects

• Replace full proxy include dir with AOP_CACHE_DIR constant inside the proxy class

• More advice types:

  • AfterThrowing
  • InsteadOf
  • DeclareParents
  • DeclareError

• Adding aspects directly to properties

• Implement Pointcuts

• IDE plugins:

  • PhpStorm
  • VSCode
    • Highlight the code that will be intercepted
    • Show the list of aspects and their configuration

• Complex advices for intercepting code structures and statements

• Cache lifetime

• Add exception handler to AopKernel

• Separate Aspects and their attribute declarations: Roadmap #9 (comment)

• Access declaration as a parameter: Roadmap #9 (comment)

• Ignore already initialized Kernel: How to use with Laravel? #25 (comment)

• Convert this stupid roadmap to issues lol

[jakublabno]

1. Are you planning to change the way apsect are being declared?
   Current solution is not convenient at all, I want to initialize apsects as objects along with their dependencies

 protected array $aspects = [
        DiscountAspect::class,
        PaymentProcessorAspect::class,
    ];   

2. Have you thought about separating aspects and their attributes declarations?

#[Aspect]
class CacheAspect 
{
    #[\Okapi\Aop\Attributes\Around(Cache::class)]
    public function around(\Okapi\Aop\Attributes\Around $invocation)
    {
        //it would be good to have access to method/attribute directly from $invocation
        $invocation->getDeclaration()->ttl;
    }
}

#[Attribute]
readonly class Cache
{
    public function __construct(public int $ttl) {}
}

[WalterWoshid]

Hi @jakublabno,

1. what do you mean exactly by "initialize aspects as objects"? Could you create an example of how that would look like? Even pseudo-code would be enough.

2. I think that could be doable, I will add it to the roadmap.

Instead of accessing methods/attributes directly from $invocation, how about being able to add it as a parameter like this:

#[\Okapi\Aop\Attributes\Around(Cache::class)]
public function around(\Okapi\Aop\Attributes\Around $invocation, Cache $cache)
{
    $invocation->getDeclaration()->ttl;
    // or
    $cache->ttl;
}

Adding it directly to $invocation could create type conflicts and conflicts between methods/attributes, plus the IDE wouldn't know about the methods/attributes.

[jakublabno]

final class AopKernel extends \Okapi\Aop\AopKernel
{
    public function addAspect(Aspect $aspect): self
    {
        //add aspect as object, not only class reference
        
        return $this;
    }
    
    //or second options, allow to inject own dependency container from which aspects will be resolved
    public function setContainer(Container $container): void {}
}

2. Sometimes attributes works together, so I want be able to get reflection of method/class to get different attributes, not only this one, however, additional, second parameter is a good idea for primary attribute.

[WalterWoshid]

Moved to separate issues