:gem: Go! AOP PHP - modern aspect-oriented framework for the new level of software development

Hi all,

We are currently investigating your awesome library for our project, and thank you for very much for this project.

I was trying to find any documentation about use of annotations except the examples. Is there any docs about how to use all types of annotation (except the examples)?

Thanks,

Hi,

Is it possible to somehow add an aspect to a class and all its sub-classes? Say we have parent class A and B as its child. I'd like to add smth like this:

/**
* @Before("execution(public A+->*(*))")
*/

and, if B->method1() is executed, then it is also affected.

I know that there's a way do this with interfaces, but I am looking for this particular solution.

I am using Go AOP version 0.6.0.

Following the tutorial, as it is, for a project I am working on gave 'class not found exception' in:

1. configuring the ApplicationAspectKernel in the front controller,
2. registering aspect in aspect kernel, and
3. declaring pointcut in an aspect for the methods of some class

To solve this, I added include statements:

1. include '../application/ApplicationAspectKernel.php'; for my project's front controller
2. include 'aspect/MonitorAspect.php'; in ApplicationAspectController.php
3. include '../application/controller/CallbackController.php'; in MonitorAspect.php (CallbackController is the class whose methods I want to intercept).

On doing this I get the error PHP Fatal error: Cannot declare class CallbackController, because the name is already in use in /var/www/html/vyom-crm-frontend/application/controller/CallbackController.php on line 0

[Edit]: I removed the third include above. This resolved the above error. Now, the interceptor didn't work with the following pointcut

@Before("execution(public CallbackController->*(*))")

This pointcut works - @Before("execution(public **->*(*))") But I don't want to intercept all methods of all classes. There is a specific method in CallbackController that I want to intercept.

Please help me solve this. Thanks!

Getting the error:

filemtime(): stat failed for php://filter/read=go.source.transforming.loader/resource=/Applications/....

What is the prefix: php://filter/read=go.source.transforming.loader/resource= and why would that be in the path for filemtime ?

Given an annotation:

/**
 * @Annotation
 * @Target("METHOD")
 */
class MyAnnotation extends Annotation
{
    /**
     * @var string
     */
    public $name = null;

    /**
     * @var string
     */
    public $tag = null;
}

Given an aspect:

/**
     *
     * @param MethodInvocation $invocation
     *
     * @Around("@execution(MyAnnotation)")
     */
    public function aroundInvocation(MethodInvocation $invocation)
    {

        /** @var MyAnnotation $annotation */
        $annotation = $invocation->getMethod()->getAnnotation(MyAnnotation::class);
        $name = $annotation->name;
    }

The problem is that a call to $invocation->getMethod()->getAnnotation(MyAnnotation::class); results in a call to FileCacheReader::getAnnotations. Which will get the className like so: $class = $method->getDeclaringClass();

The declaring class in this case is always Class__AopProxied which is not cached. By the way, I'm using Features::PREBUILT_CACHE as I have a read-only file systems.

Error: The directory "/var/www/html/docroot/bootstrap/cache/aspect/_annotations" is not writable. Both, the webserver and the console user need access. You can manage access rights for multiple users with "chmod +a". If your system does not support this, check out the acl package.

Is there any workaround for this issue? Thanks

AppAspectKernel.php:

<?php

use Demo\Aspect\SecurityAspect;
use Go\Core\AspectKernel;
use Go\Core\AspectContainer;

/**
 * Application Aspect Kernel
 */
class AppAspectKernel extends AspectKernel
{
    /**
     * Configure an AspectContainer with advisors, aspects and pointcuts
     *
     * @param AspectContainer $container
     */
    protected function configureAop(AspectContainer $container)
    {
        $container->registerAspect(new SecurityAspect());
    }
}

loading kernel in the web/app.php:

...
require_once __DIR__.'/../app/AppAspectKernel.php';
$applicationAspectKernel = AppAspectKernel::getInstance();
$applicationAspectKernel->init([
    'debug' => true,
    'cacheDir'  => __DIR__ . '/../app/cache/aspect/',
    'appDir' => __DIR__ . '/../',
    'includePaths' => [__DIR__ . '/../src/'],
]);
...

the aspect itself:

<?php

namespace Demo\Aspect;

use Go\Aop\Aspect;
use Go\Aop\Intercept\MethodInvocation;
use Go\Lang\Annotation\Before;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

/**
 * Security aspect
 */
class SecurityAspect implements Aspect
{
    /**
     * Method that will be called before real method
     *
     * @param MethodInvocation $invocation Invocation
     * @Before("@execution(Demo\Aspect\Annotation\Securable)")
     */
    public function beforeMethodExecution(MethodInvocation $invocation)
    {
        $controller = $invocation->getThis();
        $user = $controller->getUser();
        $role = $invocation->getMethod()->getAnnotation('Demo\Aspect\Annotation\Securable')->role;
        if (!$user->hasAccessToPage($role)) {
            throw new AccessDeniedException();
        }
    }
}

getting error:

2015/04/03 15:07:59 [error] 11226#0: *6454 FastCGI sent in stderr: "PHP message: PHP Fatal error:  Class 'TokenReflection\Exception\RuntimeException' not found in /var/www/vendor/andrewsville/php-token-reflection/TokenReflection/ReflectionNamespace.php on line 156
PHP message: PHP Stack trace:
PHP message: PHP   1. {main}() /var/www/web/app.php:0
PHP message: PHP   2. Symfony\Component\HttpKernel\Kernel->handle() /var/www/web/app.php:48
PHP message: PHP   3. Symfony\Component\HttpKernel\Kernel->boot() /var/www/app/bootstrap.php.cache:2375
PHP message: PHP   4. Symfony\Component\HttpKernel\Kernel->initializeBundles() /var/www/app/bootstrap.php.cache:2343
PHP message: PHP   5. AppKernel->registerBundles() /var/www/app/bootstrap.php.cache:2513
PHP message: PHP   6. spl_autoload_call() /var/www/app/bootstrap.php.cache:11
PHP message: PHP   7. Symfony\Component\Debug\DebugClassLoader->loadClass() /var/www/app/bootstrap.php.cache:11
PHP message: PHP   8. Go\Instrument\ClassLoading\SourceTransformingLoader->filter() /var/www/app/bootstrap.php.cache:151
PHP message: PHP   9. Go\Instrument\ClassLoading\SourceTransformingLoader->transformCode() /var/www/vendor/lisachenko/go-aop-php/src/Instrument/ClassLoading/SourceTransformingLoader.php:102
PHP message: PHP  10. Go\Instrument\Transformer\CachingTransformer->transform() /var/www/vendor/lisachenko/go-aop-php/src/Instrument/ClassLoading/SourceTransformingLoader.php:146
PHP message: PHP  11. Go\Instrument\Transformer\CachingTransformer->processTransformers() /var/www/vendor/lisachenko/go-aop-php/src/Instrument/Transformer/CachingTransformer.php:117
PHP message: PHP  12. Go\Instrument\Transformer\WeavingTransformer->transform() /var/www/vendor/lisachenko/go-aop-php/src/Instrument/Transformer/CachingTransformer.php:141
PHP message: PHP  13. TokenReflection\ReflectionClass->getParentClassNameList() /var/www/vendor/lisachenko/go-aop-php/src/Instrument/Transformer/WeavingTransformer.php:109

i figured out that it can't find that class only in the closure here https://github.com/lisachenko/go-aop-php/blob/master/src/Core/AspectKernel.php#L243-L260. Outside the closure it is able to find that class. Any ideas? (PHP 5.5.20)

I'm trying to do a integration in a framework I'm bulding (Im using symfony HttpFoundation)

here is what I got so far

<?php

include __DIR__ . '/../vendor/lisachenko/go-aop-php/src/Go/Core/AspectKernel.php';

use Go\Core\AspectKernel;
use Go\Core\AspectContainer;

/**
 * Application Aspect Kernel
 */
class ApplicationAspectKernel extends AspectKernel
{

    /**
     * Configure an AspectContainer with advisors, aspects and pointcuts
     *
     * @param AspectContainer $container
     *
     * @return void
     */
    protected function configureAop(AspectContainer $container)
    {
        $container->registerAspect(new Nucleus\Cache\Caching());
    }
}

ApplicationAspectKernel::getInstance()->init(array(
    'appLoader' => __DIR__ . '/../vendor/autoload.php',
    // Configuration for autoload namespaces
    'autoloadPaths' => array(
        'Go' => __DIR__ . '/../vendor/lisachenko/go-aop-php/src/',
        'TokenReflection' => __DIR__ . '/../vendor/andrewsville/php-token-reflection/',
        'Doctrine\\Common' => __DIR__ . '/../vendor/doctrine/common/lib/',
        'Dissect' => __DIR__ . '/../vendor/jakubledl/dissect/src/'
    ),
    'includePaths' => array(
        __DIR__ . '/../vendor',
        __DIR__ . '/../src'
    )
));

$request = Symfony\Component\HttpFoundation\Request::createFromGlobals();

And a Aspect for testing

<?php 

namespace Nucleus\Cache;

use Go\Aop\Aspect;
use Go\Aop\Intercept\FieldAccess;
use Go\Aop\Intercept\MethodInvocation;
use Go\Lang\Annotation\After;
use Go\Lang\Annotation\Before;
use Go\Lang\Annotation\Around;
use Go\Lang\Annotation\Pointcut;

/**
 * Monitor aspect
 */
class Caching implements Aspect
{

    /**
     * Method that will be called before real method
     *
     * @param MethodInvocation $invocation Invocation
     * @Before("execution(public *->*(*))")
     */
    public function beforeMethodExecution(MethodInvocation $invocation)
    {
        $obj = $invocation->getThis();
        echo 'Calling Before Interceptor for method: ',
             is_object($obj) ? get_class($obj) : $obj,
             $invocation->getMethod()->isStatic() ? '::' : '->',
             $invocation->getMethod()->getName(),
             '()',
             ' with arguments: ',
             json_encode($invocation->getArguments()),
             "<br>\n";
    }
}

nothing is happening...

I check that the filter is properly registered using the stream_get_filters function;

array (size=13)
  0 => string 'convert.iconv.*' (length=15)
  1 => string 'string.rot13' (length=12)
  2 => string 'string.toupper' (length=14)
  3 => string 'string.tolower' (length=14)
  4 => string 'string.strip_tags' (length=17)
  5 => string 'convert.*' (length=9)
  6 => string 'consumed' (length=8)
  7 => string 'dechunk' (length=7)
  8 => string 'zlib.*' (length=6)
  9 => string 'bzip2.*' (length=7)
  10 => string 'mcrypt.*' (length=8)
  11 => string 'mdecrypt.*' (length=10)
  12 => string 'go.source.transforming.loader' (length=29)

And the path return by FilterInjectorTransformer::rewrite

php://filter/read=go.source.transforming.loader/resource=D:\nucleus\nucleus\web/../vendor/autoload.php

The filter function of SourceTransformingLoader is never call, probably whe it doesn't work...

Is there something I don't do correctly ? Or maybe a comflict with other filter and it never reach th filter that is registered ?

I'm using propel 1 in a project and I get a issue with the generated file.

At the end of the file propel call a static method on the current declared class. Since the class with the good name is appended to the class it cannot be found.

Here is a exemple of before and after:

//Before
class BaseFilePeer
{
}

BaseFilePeer::buildTableMap();


//After
class BaseFilePeer__AopProxied
{
}

BaseFilePeer::buildTableMap();

abstract class BaseFilePeer extends BaseItemPeer__AopProxied implements \Go\Aop\Proxy
{
}

I've tried modifying the WeavingTransformer to append the child class just after the first class but the ReflectionElement just give access to the last line of the class and not the 'char' position in the file (it's probably why you don't support 2 namespaces in files).

Do you have any suggestion because this is a big issue for my project...

This PR changes the logic of transformers, they can use AST now and operate directly on token stream using token positions from AST to filter interesting places.

Hi,

I have the following expression:

/**
 * @Before("execution(public **\controllers\*Controller->handle_*(*)) && !within(**\base\controllers\*Controller) && !within(**\common\controllers\LoginController)")
 */

It seems that only the first within is considered and the latter isnt working. Is that expected behavior?

It's a slight inconvenience that an AOP framework imposes an implementation on me by forcing my properties to be at least protected.

I'd like to initialise values of annotated properties:

class FindByAspect implements Aspect
{
    /**
     * @Before("@access(Zalas\Annotation\FindBy)")
     */
    public function beforeFieldAccess(FieldAccess $fieldAccess): void
    {
        if (null === $fieldAccess->getValue() && FieldAccess::READ === $fieldAccess->getAccessType()) {
            $field = $fieldAccess->getField()->name;
            $setter = \Closure::bind(function ($object, $value) use ($field) {
                $object->$field = $value;
            }, null, $fieldAccess->getThis());
            $setter($fieldAccess->getThis(), $this->getValue($fieldAccess));
        }
    }

    // ...
}

class Foo
{
    /**
     * @FindBy(xpath="//div")
     */
    private $bar;

    public function getBar(): string
    {
        return $this->bar;
    }
}

The above code works only if the property is protected or public.

Updates the requirements on doctrine/annotations to permit the latest version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

I have added PHP 8 Support by replacing the @Annotation with the new #[Attribute] syntax

I have refactored goaop/parser-reflection to also support PHP 8. I might have refactored too much of it, but all the tests are running :)

The tests from the framework must be edited, but most of them work as well. I also ran some custom tests on the Laravel framework and it seemed to work

Tasks:

• [x] Publish new version of jakubledl/dissect and register it in the composer - current version is a little bit outdated, but still works.
• [ ] Implement in the goaop/parser-reflection support for PHP8. Mostly for existing functional, need to add support for parsing attributes from the AST data and try not to call original reflection instances to avoid autoloading. Support for PHP8 enums is missing, but I guess this can be added later separately. This new version should be published as a new major with bump of minimum PHP version to >=8.0
• [ ] Bump dependencies here, in the goaop/framework to include new version of goaop/parser-reflection, dissect libraries. Also, bump PHP minimum version to use PHP>=8.0.
• [ ] Remove doctrine annotations reader and related parts, as attributes are finally in the core of PHP. There are some parts with caching of annotations that should be removed too.

Library generates non-nullable return type for nullable return methods #482 Library version 3.0.0

For below method proxy is generating non-null return

/**
     * @AopAnnotation()
     * @return null|int
     */
    public function getSomeRandomValueAllowOnNull(): ?int
    {
        return random_int(0, 666);
    }

result:

/**
     * @AopAnnotation()
     * @return null|int
     */
    public function getSomeRandomValueAllowOnNull() : int
    {
        return self::$__joinPoints['method:getSomeRandomValueAllowOnNull']->__invoke($this);
    }

Library version 3.0.0

For below method proxy is generating non-null return

/**
     * @AopAnnotation()
     * @return null|int
     */
    public function getSomeRandomValueAllowOnNull(): ?int
    {
        return random_int(0, 666);
    }

result:

/**
     * @AopAnnotation()
     * @return null|int
     */
    public function getSomeRandomValueAllowOnNull() : int
    {
        return self::$__joinPoints['method:getSomeRandomValueAllowOnNull']->__invoke($this);
    }

Hi recently I updated the library from v2.3.5 to v3.0.0, while taking note of the breaking changes in the ChangeLog, I came to experience an error that doesn't seem to trace to any of the breaking changes mentioned. Here's the exact error which comes up: PHP message: PHP Fatal error: Uncaught Error: Typed property Go\Aop\Framework\AbstractInterceptor::$adviceOrder must not be accessed before initialization in /var/www/html/app/vendor/goaop/framework/src/Aop/Framework/AbstractInterceptor.php:119 Stack trace: #0 /var/www/html/app/vendor/goaop/framework/src/Aop/Framework/AbstractJoinpoint.php(95): Go\Aop\Framework\AbstractInterceptor->getAdviceOrder() #1 [internal function]: Go\Aop\Framework\AbstractJoinpoint::Go\Aop\Framework\{closure}() #2 /var/www/html/app/vendor/goaop/framework/src/Aop/Framework/AbstractJoinpoint.php(100): uasort() #3 /var/www/html/app/vendor/goaop/framework/src/Aop/Framework/AbstractJoinpoint.php(116): Go\Aop\Framework\AbstractJoinpoint::sortAdvices() #4 /var/www/html/app/vendor/goaop/framework/src/Instrument/Transformer/WeavingTransformer.php(142): Go\Aop\Framework\AbstractJoinpoint::flatAndSortAdvices() #5 /var/www/html/app/vendor/goaop/framework/src/Instrument/Transformer/WeavingTransformer.php(106): Go\Instrument\Transforme

Any clue if there is another breaking change that needs to be looked out for?

Hey @lisachenko,

I am just checking to confirm that this library alive and kicking.

I just saw that you deprecated https://github.com/goaop/parser-reflection, but this library still depends on it. This issue https://github.com/goaop/framework/issues/476 which has been open for half year has not gotten any traction even though it probably concerns a lot of people. This PR also addresses this issue (kinda): https://github.com/goaop/framework/pull/477

I do not want to sound unappreciative about your awesome work for the open source community in this very critical and difficult area of PHP. On the other hand I have to consider the implications of using a library this complicated without having the proper support of the maintainers.

Could you please elaborate on the current status of the library and maybe its future? Maybe you could get a co-maintainer on board?

Thank you for your efforts :) I hope to hear from you soon.