.gitignore000064400000000217144760123700006540 0ustar00# Exclude vendor files vendor/ # Exclude ide metadatas nbproject/ # Lock file composer.lock # PhpUnit working configuration file phpunit.xml.travis.yml000064400000000140144760123700006654 0ustar00language: php php: - 5.4 - 5.3 before_script: - composer --prefer-source --dev installCHANGELOG.md000064400000000327144760123700006363 0ustar00Changelog ====== 0.1.1 (Jan 20, 2013) * Introduction advice support * Fix bug with composer autoloader prepending * Fix doctrine/common dependency: >=2.0.0, <2.4.0 0.1.0 (Jan 08, 2013) * Initial release of libraryLICENSE000064400000002102144760123700005550 0ustar00Copyright (c) 2011 Lissachenko Alexander Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.README.md000064400000017713144760123700006040 0ustar00README ====== What is Go?! ----------------- Go! is a PHP 5.4 library based on OOP and AOP paradigms. It allows developers to add support of AOP to every PHP application. Go! doesn't require any PECL-extentions, it neither uses any dark magic of Runkit nor evals, the library doesn't use DI-containers. The code with weaved aspects is fully readable and native, it can be easily debugged with XDebug. You can debug either classes or aspects. The main advantage of Go! is that potentially it can be installed in every PHP-application, because you don't have to change the application source code at all. As an example, with the help of 10-20 lines of code we can intercept all the public, protected and static methods in all the classes of application and display the name and the arguments of each method during its execution. [![Build Status](https://secure.travis-ci.org/lisachenko/go-aop-php.png?branch=master)](https://travis-ci.org/lisachenko/go-aop-php) Requirements ------------ Go! library is developed for PHP 5.4.0 and up, but it can partially work with PHP 5.3.0 code. Note that PHP versions before 5.4.0 will not work completely, if you try to use aspects for code that uses Late Static Binding (LSB) feature. Go! library will not work with eAccelerator. Installation ------------ Go! library can be installed with composer or manually with git submodules. Installation is quite easy: 1. Download go-aop-php using composer or git submodule 2. Create an application aspect kernel 3. Configure the aspect kernel in the front controller 4. Adjust the front controller of your application for proxying autoloading requests to the aspect kernel 5. Create an aspect 6. Register the aspect in the aspect kernel ### Step 1: Download go-aop-php using composer or git submodule Add Go! AOP library to your composer.json: ```js { "require": { "lisachenko/go-aop-php": "*" } } ``` Now ask composer to download the library with its dependencies by running the command: ``` bash $ php composer.phar update lisachenko/go-aop-php ``` Composer will install the library to your project's `vendor/lisachenko/go-aop-php` directory. Alternative way for installing the library is to use git submodules: ``` bash git submodule add https://github.com/lisachenko/go-aop-php vendor/alisachenko/go-aop-php ``` Dependencies should be also installed as submodules: ``` bash git submodule add https://github.com/Andrewsville/PHP-Token-Reflection vendor/andrewsville/php-token-reflection git submodule add https://github.com/doctrine/common vendor/doctrine/common ``` ### Step 2: Create an application aspect kernel The aim of this library is to provide easy AOP integration to your application. Your first step then is to create the `AspectKernel` class for your application. This class will manage all aspects of your application in one place. The library provides base class to make it easier to create your own kernel. To create your application kernel extend the abstract class `Go\Core\AspectKernel` ``` php init(array( // Configuration for autoload namespaces 'autoload' => array( 'Go' => realpath(__DIR__ . '/../vendor/lisachenko/go-aop-php/src/'), 'TokenReflection' => realpath(__DIR__ . '/../vendor/andrewsville/php-token-reflection/'), 'Doctrine\\Common' => realpath(__DIR__ . '/../vendor/doctrine/common/lib/') ), // Application root directory 'appDir' => __DIR__ . '/../', // Cache directory should be disabled for now 'cacheDir' => null // Include paths restricts the directories where aspects should be applied, or empty for all source files 'includePaths' => array( __DIR__ . '/../src/' ) )); ``` ### 4. Adjust the front controller of your application for proxying autoloading requests to the aspect kernel At this step we have a configured aspect kernel and can try to switch to it instead of default autoloader: ``` php // front-controller, for Symfony2 application it's web/app_dev.php // Comment default loader of application at the top of file // include __DIR__ .'/../vendor/autoload.php'; // for composer // include __DIR__ .'/../app/autoload.php'; // for old applications ``` ### 5. Create an aspect Aspect is the key element of AOP philosophy. And Go! library just uses simple PHP classes for declaring aspects! Therefore it's possible to use all features of OOP for aspect classes. As an example let's intercept all the methods and display their names: ``` php // Aspect/MonitorAspect.php namespace Aspect; 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 MonitorAspect implements Aspect { /** * Method that will be called before real method * * @param MethodInvocation $invocation Invocation * @Before("execution(public Example->*(*))") */ 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()), "
\n"; } } ``` Easy, isn't it? We declared here that we want to install a hook before the execution of all dynamic public methods in the class Example. This is done with the help of annotation `@Before("execution(public Example->*(*))")` Hooks can be of any types, you will see them later. But we doesn't change any code in the class Example! I can feel you astonishment now ) ### 6. Register the aspect in the aspect kernel To register the aspect just add an instance of it in the `configureAop()` method of the kernel: ``` php // app/ApplicationAspectKernel.php use Aspect/MonitorAspect; //... protected function configureAop(AspectContainer $container) { $container->registerAspect(new MonitorAspect()); } //... ``` Now you are ready to use the power of aspects! Feel free to change anything everywhere. Documentation ------------- Documentation about Go! library can be found at [official site][1]. Currently only Russian language is supported. If you'd like to contribute, please translate any part of the documentation to your language. [1]: http://lisachenko.github.com/go-aop-php/ composer.json000064400000001157144760123700007276 0ustar00{ "name": "lisachenko/go-aop-php", "description": "Library for aspect-oriented programming in PHP.", "type": "library", "keywords": ["library", "aop", "php", "aspect"], "homepage": "http://lisachenko.github.com/go-aop-php/", "license": "MIT", "require": { "php": ">=5.3.0", "andrewsville/php-token-reflection": "~1.3", "doctrine/common": ">=2.0.0, <2.4.0" }, "authors": [ { "name": "Lissachenko Alexander", "homepage": "https://github.com/lisachenko" } ], "autoload": { "psr-0": { "Go": "src/" } } }demos/Annotation/Cacheable.php000064400000000677144760123700012343 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Annotation; use Doctrine\Common\Annotations\Annotation; /** * @Annotation * @Target("METHOD") */ class Cacheable extends Annotation { /** * Time to cache * * @var int */ public $time = 0; } demos/Aspect/DebugAspect.php000064400000007743144760123700012010 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Aspect; 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; use Go\Lang\Annotation\DeclareParents; /** * Debug aspect */ class DebugAspect implements Aspect { /** * Message to show when calling the method * * @var string */ protected $message = ''; /** * @DeclareParents(value="Example", interface="Serializable", defaultImpl="Aspect\Introduce\SerializableImpl") * * @var null */ protected $introduction = null; /** * Aspect constructor * * @param string $message Additional message to show */ public function __construct($message) { $this->message = $message; } /** * Pointcut for example class * * @Pointcut("execution(public Example->public*(*))") */ protected function examplePublicMethods() {} /** * Method that should be called before real method * * @param MethodInvocation $invocation Invocation * @Before(pointcut="examplePublicMethods()") // Short pointcut name (for same class) */ 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()), "
\n"; } /** * Method that should be called after real method * * @param MethodInvocation $invocation Invocation * @After(pointcut="Aspect\DebugAspect->examplePublicMethods()") // Full-qualified pointcut name */ public function afterMethodExecution(MethodInvocation $invocation) { $obj = $invocation->getThis(); echo 'Calling After Interceptor for method: ', is_object($obj) ? get_class($obj) : $obj, $invocation->getMethod()->isStatic() ? '::' : '->', $invocation->getMethod()->getName(), '()', ' with arguments: ', json_encode($invocation->getArguments()), "
\n"; } /** * Cacheable methods * * @param MethodInvocation $invocation Invocation * * @Around("@annotation(Annotation\Cacheable)") */ public function aroundCacheable(MethodInvocation $invocation) { static $memoryCache = array(); $time = microtime(true); $obj = $invocation->getThis(); $class = is_object($obj) ? get_class($obj) : $obj; $key = $class . ':' . $invocation->getMethod()->name; if (!isset($memoryCache[$key])) { $memoryCache[$key] = $invocation->proceed(); } echo "Take ", sprintf("%0.3f", (microtime(true) - $time) * 1e3), "ms to call method
", PHP_EOL; return $memoryCache[$key]; } /** * Method that should be called around property * * @param FieldAccess $property Joinpoint * * @Around("access(* Example->*)") * @return mixed */ public function aroundFieldAccess(FieldAccess $property) { $type = $property->getAccessType() === FieldAccess::READ ? 'read' : 'write'; $value = $property->proceed(); echo "Calling Around Interceptor for field: ", get_class($property->getThis()), "->", $property->getField()->getName(), ", access: $type", ", value: ", json_encode($value), "
\n"; return $value; } } demos/Aspect/Introduce/SerializableImpl.php000064400000001617144760123700015000 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Aspect\Introduce; /** * Example class to test aspects */ trait SerializableImpl { /** * String representation of object * @return string the string representation of the object or null */ public function serialize() { return serialize(get_object_vars($this)); } /** * Constructs the object * @param string $serialized

* The string representation of the object. *

* @return mixed the original value unserialized. */ public function unserialize($serialized) { $data = unserialize($serialized); foreach($data as $key=>$value) { $this->$key = $value; } } } demos/DemoAspectKernel.php000064400000001611144760123700011554 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ use Aspect\DebugAspect; use Go\Core\AspectKernel; use Go\Core\AspectContainer; /** * Demo Aspect Kernel class */ class DemoAspectKernel extends AspectKernel { /** * Returns the path to the application autoloader file, typical autoload.php * * @return string */ protected function getApplicationLoaderPath() { return './autoload.php'; } /** * Configure an AspectContainer with advisors, aspects and pointcuts * * @param AspectContainer $container * * @return void */ protected function configureAop(AspectContainer $container) { $container->registerAspect(new DebugAspect('ASPECT!')); } }demos/Example.php000064400000005263144760123700007771 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ use Annotation\Cacheable; /** * Example class to test aspects */ class Example { /** * Message for example * * @var string */ protected $message = ''; /** * Public message to read/write * * @var string */ public $publicMessage = ''; /** * Constructs example class * * @param string $message Message to show */ public function __construct($message) { $this->message = $message; } /** * Protected method that shows hello */ protected function protectedHello() { echo 'Hello, you have a protected message: ', $this->message, "
", PHP_EOL; } /** * Public method that shows hello */ public function publicHello() { echo 'Hello, you have a public message: ', $this->message, "
", PHP_EOL; } /** * Public method to test interception of protected method */ public function runProtectedHello() { echo 'Calling protected method...', "
", PHP_EOL; $this->protectedHello(); } /** * Protected method to return the value of message * * @return string */ protected function getProtectedMessage() { return $this->message; } /** * Executes a protected method to read the message and show it */ public function showProtectedMessage() { echo 'Getting value from protected method...', "
", PHP_EOL; $message = $this->getProtectedMessage(); echo 'Hello, have you read that message: ', $message, "
", PHP_EOL; } /** * Test function for static method inter * * @param string $message Message to show */ public static function showStaticMessage($message) { echo "Static message is: ", $message, "
", PHP_EOL; echo "Scope is: ", get_called_class(), "
", PHP_EOL; } /** * Test function for recursive calls * * @param integer $level Level of recursion */ public function testRecursion($level) { echo "Recursive call, level is: ", $level, "
", PHP_EOL; if ($level > 0) { $this->testRecursion($level - 1); } } /** * Test cacheable by annotation * * @Cacheable * @param float $timeToSleep Amount of time to sleep * * @return string */ public function cacheMe($timeToSleep) { usleep($timeToSleep * 1e6); return 'Yeah'; } } demos/autoload.php000064400000002011144760123700010172 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ /** * Show all errors in code */ ini_set('display_errors', true); /** * Register PSR-0 autoloader for our code, any components can be used here */ spl_autoload_register(function($originalClassName) { $className = ltrim($originalClassName, '\\'); $fileName = ''; $namespace = ''; if ($lastNsPos = strripos($className, '\\')) { $namespace = substr($className, 0, $lastNsPos); $className = substr($className, $lastNsPos + 1); $fileName = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR; } $fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php'; $resolvedFileName = stream_resolve_include_path($fileName); if ($resolvedFileName) { require_once $resolvedFileName; } return (bool) $resolvedFileName; });demos/cache/.gitignore000064400000000001144760123700010701 0ustar00*demos/cache/.gitkeep000064400000000000144760123700010341 0ustar00demos/index.php000064400000002651144760123700007503 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ use Doctrine\Common\Annotations\AnnotationRegistry; include '../src/Go/Core/AspectKernel.php'; include 'DemoAspectKernel.php'; // Initialize demo aspect container DemoAspectKernel::getInstance()->init(array( // Configuration for autoload namespaces 'autoload' => array( 'Go' => realpath(__DIR__ . '/../src'), 'TokenReflection' => realpath(__DIR__ . '/../vendor/andrewsville/php-token-reflection/'), 'Doctrine\\Common' => realpath(__DIR__ . '/../vendor/doctrine/common/lib/') ), // Default application directory 'appDir' => __DIR__ . '/../demos', // Cache directory for Go! generated classes 'cacheDir' => __DIR__ . '/cache', // Include paths for aspect weaving 'includePaths' => array(), 'debug' => true )); AnnotationRegistry::registerFile('./Annotation/Cacheable.php'); $class = new Example('test'); if ($class instanceof Serializable) { echo "Yeah, Example is serializable!", "
", PHP_EOL; $ref = new ReflectionClass('Example'); var_dump($ref->getTraitNames(), $ref->getInterfaceNames()); } else { echo "Ooops, Example isn't serializable!", "
", PHP_EOL; } $class->publicHello(); for ($i=10; $i--; ) { $class->cacheMe(1); }phpunit.xml.dist000064400000001710144760123700007722 0ustar00 ./tests/Go/ ./src/Go/ performance src/Go/Aop/Advice.php000064400000001100144760123700010317 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Tag interface for Advice. Implementations can be any type of advice, such as Interceptors. * * @author Rod Johnson * @author Lissachenko Alexander */ interface Advice { /** Before advice */ const BEFORE = 'before'; /** Around advice */ const AROUND = 'around'; /** After advice */ const AFTER = 'after'; } src/Go/Aop/AdviceAfter.php000064400000000635144760123700011315 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use Go\Aop\Advice; /** * Tag class for all after advices either for field access or method calling * @author Lissachenko Alexander */ interface AdviceAfter extends Advice { } src/Go/Aop/AdviceAround.php000064400000000637144760123700011506 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use Go\Aop\Advice; /** * Tag class for all around advices either for field access or method calling * @author Lissachenko Alexander */ interface AdviceAround extends Advice { } src/Go/Aop/AdviceBefore.php000064400000000637144760123700011460 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use Go\Aop\Advice; /** * Tag class for all before advices either for field access or method calling * @author Lissachenko Alexander */ interface AdviceBefore extends Advice { } src/Go/Aop/Advisor.php000064400000001660144760123700010546 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Base interface holding AOP advice (action to take at a joinpoint) and a filter determining the * applicability of the advice (such as a pointcut). */ interface Advisor { /** * Return the advice part of this aspect. An advice may be an interceptor, a before advice, a throws advice, etc. * * @return Advice The advice that should apply if the pointcut matches */ public function getAdvice(); /** * Return whether this advice is associated with a particular instance or shared with all instances * of the advised class * * @return bool Whether this advice is associated with a particular target instance */ public function isPerInstance(); } src/Go/Aop/Aspect.php000064400000001141144760123700010350 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Aspect class realization for PHP * * Aspect is a module that encapsulates a concern. An aspect is composed of pointcuts, advice bodies and inter-type * declarations. In some approaches, and aspect may also contain classes and methods. * * @link http://en.wikipedia.org/wiki/Aspect_%28computer_science%29 * @package go * @subpackage aop */ interface Aspect { } src/Go/Aop/AspectException.php000064400000000676144760123700012243 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use RuntimeException; /** * Superclass for all AOP infrastructure exceptions * * @author Rod Johnson * @author Bob Lee * @author Lissachenko Alexander */ class AspectException extends RuntimeException { } src/Go/Aop/ClassFilter.php000064400000000601144760123700011344 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Filter that restricts matching of a pointcut or introduction to a given set of target classes. */ interface ClassFilter extends PointFilter { } src/Go/Aop/Framework/AbstractInvocation.php000064400000002434144760123700014671 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\Intercept\Invocation; /** * Abstract class for all invocations joinpoints * * It is an implementation of Go\Aop\Intercept\Invocation interface * * @see Go\Aop\Intercept\Invocation * @package go */ abstract class AbstractInvocation extends AbstractJoinpoint implements Invocation { /** * Stack frames to work with recursive calls or with cross-calls inside object * * @var array */ protected $stackFrames = array(); /** * Recursion level for invocation * * @var int */ protected $level = 0; /** * Current advice index * * @var int */ protected $current = 0; /** * Arguments for invocation * * @var array */ protected $arguments = array(); /** * Get the arguments as an array object. * It is possible to change element values within this array to change the arguments * * @return array the arguments of the invocation */ public function getArguments() { return $this->arguments; } } src/Go/Aop/Framework/AbstractJoinpoint.php000064400000004402144760123700014526 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\Advice; use Go\Aop\AdviceAfter; use Go\Aop\AdviceBefore; use Go\Aop\AdviceAround; use Go\Aop\Intercept\Joinpoint; /** * Abstract joinpoint for framework * * Join points are points in the execution of the system, such as method calls, * where behavior supplied by aspects is combined. A join point is a point in * the execution of the program, which is used to define the dynamic structure * of a crosscutting concern. * * @link http://en.wikipedia.org/wiki/Aspect-oriented_software_development#Join_point_model * @package go */ abstract class AbstractJoinpoint implements Joinpoint { /** * List of advices * * @var array|Advice[] */ protected $advices = array(); /** * Name of the invocation class * * @var string */ protected $className = ''; /** * Initializes list of advices for current joinpoint * * @param string $className Name of the class * @param array $advices List of advices */ protected function __construct($className, array $advices) { $this->className = $className; $this->advices = static::sortAdvices($advices); } /** * Sorts advices by priority * * @param array|BaseAdvice[] $advices * @return array|BaseAdvice[] Sorted list of advices */ static protected function sortAdvices(array $advices) { $sortedAdvices = $advices; usort($sortedAdvices, function(BaseAdvice $first, BaseAdvice $second) { if ($first instanceof AdviceBefore && !($second instanceof AdviceBefore)) { return -1; } elseif ($first instanceof AdviceAround && !($second instanceof AdviceAround)) { return 1; } elseif ($first instanceof AdviceAfter && !($second instanceof AdviceAfter)) { return $second instanceof AdviceBefore ? 1 : -1; } else { return $first->getAdviceOrder() - $second->getAdviceOrder(); } }); return $sortedAdvices; } } src/Go/Aop/Framework/AbstractMethodInvocation.php000064400000006632144760123700016036 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use ReflectionMethod; use Go\Aop\Intercept\MethodInvocation; use Go\Aop\Intercept\MethodInterceptor; /** * Abstract method invocation implementation * * @see Go\Aop\Intercept\MethodInvocation * @package go */ abstract class AbstractMethodInvocation extends AbstractInvocation implements MethodInvocation { /** * Instance of object for invoking or null * * @var object */ protected $instance = null; /** * Instance of reflection method for class * * @var null|ReflectionMethod */ protected $reflectionMethod = null; /** * Constructor for method invocation * * @param string $className Class name * @param string $methodName Method to invoke * @param $advices array List of advices for this invocation */ public function __construct($className, $methodName, array $advices) { parent::__construct($className, $advices); $this->reflectionMethod = $method = new ReflectionMethod($this->className, $methodName); // Give an access to call protected method if ($method->isProtected()) { $method->setAccessible(true); } } /** * Proceed to the next interceptor in the Chain * * Typically this method is called inside previous closure, as instance of Joinpoint is passed to callback * Do not call this method directly, only inside callback closures. * * This method should be extended to invoke original method * * @return mixed */ abstract public function proceed(); /** * Gets the method being called. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionMethod the method being called. */ public function getMethod() { return $this->reflectionMethod; } /** * Returns the object that holds the current joinpoint's static * part. * *

For instance, the target object for an invocation. * * @return object|null the object (can be null if the accessible object is * static). */ public function getThis() { return $this->instance; } /** * Returns the static part of this joinpoint. * *

The static part is an accessible object on which a chain of * interceptors are installed. * @return object */ public function getStaticPart() { return $this->getMethod(); } /** * Invokes current method invocation with all interceptors * * @return mixed */ final public function __invoke($instance = null, array $arguments = array()) { if ($this->level) { array_push($this->stackFrames, array($this->arguments, $this->instance, $this->current)); } ++$this->level; $this->current = 0; $this->instance = $instance; $this->arguments = $arguments; $result = $this->proceed(); --$this->level; if ($this->level) { list($this->arguments, $this->instance, $this->current) = array_pop($this->stackFrames); } return $result; } } src/Go/Aop/Framework/BaseAdvice.php000064400000007127144760123700013066 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use ReflectionFunction; use ReflectionMethod; use Go\Aop\Advice; use Go\Aop\Aspect; use Go\Core\AspectKernel; /** * Base class for all framework advices implementations * * This class describe an action taken by the AOP framework at a particular * joinpoint. Different types of advice include "around", "before" and "after" * advices. * * Around advice is an advice that surrounds a joinpoint such as a method * invocation. This is the most powerful kind of advice. Around advices will * perform custom behavior before and after the method invocation. They are * responsible for choosing whether to proceed to the joinpoint or to shortcut * executing by returning their own return value or throwing an exception. * After and before advices are simple closures that will be invoked after and * before main invocation. * Framework model an advice as an PHP-closure interceptor, maintaining a * chain of interceptors "around" the joinpoint: * function(Joinpoint $joinPoint) { * echo 'Before action'; * // call chain here with Joinpoint->proceed() method * $result = $joinPoint->proceed(); * echo 'After action'; * return $result; * } * @author Lissachenko Alexander */ abstract class BaseAdvice implements Advice { /** * Constant for undefined order */ const ORDER_NOT_SET = -1; /** * Advice order * * @var int */ protected $order = self::ORDER_NOT_SET; /** * Returns the advice order * * @return int */ public function getAdviceOrder() { return $this->order; } /** * Serialize advice method into array * * @param callable|\Closure $adviceMethod An advice for aspect * * @return array */ public static function serializeAdvice($adviceMethod) { $refAdvice = new ReflectionFunction($adviceMethod); if (IS_MODERN_PHP) { $method = $refAdvice; $aspect = $refAdvice->getClosureThis(); } else { $vars = $refAdvice->getStaticVariables(); $method = $vars['refMethod']; $aspect = $vars['aspect']; } return array( 'method' => $method->name, 'aspect' => get_class($aspect) ); } /** * Unserialize an advice * * @param array $adviceData Information about advice * * @return callable|\Closure */ public static function unserializeAdvice($adviceData) { $aspectName = $adviceData['aspect']; $methodName = $adviceData['method']; $refMethod = new ReflectionMethod($aspectName, $methodName); $aspect = AspectKernel::getInstance()->getContainer()->getAspect($aspectName); return static::fromAspectReflection($aspect, $refMethod); } /** * Returns an advice from aspect method reflection * * @param Aspect $aspect Instance of aspect * @param ReflectionMethod $refMethod Reflection method of aspect * * @return callable|object */ public static function fromAspectReflection(Aspect $aspect, ReflectionMethod $refMethod) { if (IS_MODERN_PHP) { return $refMethod->getClosure($aspect); } else { return function () use ($aspect, $refMethod) { return $refMethod->invokeArgs($aspect, func_get_args()); }; } } } src/Go/Aop/Framework/BaseInterceptor.php000064400000004556144760123700014174 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Serializable; use Go\Aop\Pointcut; use Go\Aop\Framework\BaseAdvice; use Go\Aop\Intercept\Interceptor; /** * @package go */ class BaseInterceptor extends BaseAdvice implements Interceptor, Serializable { /** * Name of the aspect * * @var string */ public $aspectName = ''; /** * Pointcut instance * * @var null|Pointcut */ public $pointcut = null; /** * Advice to call * * In Spring it's ReflectionMethod, but this will be slowly * * @var null|\Closure */ protected $adviceMethod = null; /** * Default constructor for interceptor * * @param callable $adviceMethod Interceptor advice to call * @param integer $order Order of interceptor * @param Pointcut $pointcut Pointcut instance where interceptor should be called */ public function __construct($adviceMethod, $order = self::ORDER_NOT_SET, Pointcut $pointcut = null) { assert('is_callable($adviceMethod) /* Advice method should be callable */'); $this->adviceMethod = $adviceMethod; $this->order = $order; $this->pointcut = $pointcut; } /** * Getter for extracting the advice closure from Interceptor * * @return callable|null */ public function getRawAdvice() { return $this->adviceMethod; } /** * Serializes an interceptor into string representation * * @return string the string representation of the object or null */ public function serialize() { $vars = get_object_vars($this); $vars['adviceMethod'] = static::serializeAdvice($this->adviceMethod); return serialize($vars); } /** * Unserialize an interceptor from the string * * @param string $serialized The string representation of the object. * @return void */ public function unserialize($serialized) { $vars = unserialize($serialized); $vars['adviceMethod'] = static::unserializeAdvice($vars['adviceMethod']); foreach ($vars as $key=>$value) { $this->$key = $value; } } } src/Go/Aop/Framework/ClassFieldAccess.php000064400000011503144760123700014224 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use ReflectionProperty; use Go\Aop\Intercept\FieldAccess; use Go\Aop\Intercept\FieldInterceptor; /** * @package go */ class ClassFieldAccess extends AbstractJoinpoint implements FieldAccess { /** * Mapping of access type with method to invoke for interceptor * * @var array */ private static $interceptorMethodMapping = array( self::READ => 'get', self::WRITE => 'set' ); /** * Name of the field * * @var string */ protected $fieldName = ''; /** * Instance of object for accessing * * @var object */ protected $instance = null; /** * Instance of reflection property * * @var null|\ReflectionProperty */ protected $reflectionProperty = null; /** * New value to set * * @var mixed */ protected $newValue = null; /** * Access type for field access * * @var null|integer */ private $accessType = null; /** * Copy of the original value of property * * @var mixed */ private $value = null; /** * Constructor for field access * * @param string $className Class name * @param string $fieldName Field name * @param $advices array List of advices for this invocation */ public function __construct($className, $fieldName, array $advices) { parent::__construct($className, $advices); $this->fieldName = $fieldName; } /** * Returns the access type. * * @return integer */ public function getAccessType() { return $this->accessType; } /** * Gets the field being accessed. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionProperty the field being accessed. */ public function getField() { if (!$this->reflectionProperty) { $this->reflectionProperty = new ReflectionProperty($this->className, $this->fieldName); // Give an access to protected field if ($this->reflectionProperty->isProtected()) { $this->reflectionProperty->setAccessible(true); } } return $this->reflectionProperty; } /** * Gets the value that must be set to the field. * *

This value can be intercepted and changed by a field * interceptor. * @return mixed */ public function getValueToSet() { return $this->newValue; } /** * Proceed to the next interceptor in the Chain * * Typically this method is called inside previous closure, as instance of Joinpoint is passed to callback * Do not call this method directly, only inside callback closures. * * @return mixed */ final public function proceed() { /** @var $currentInterceptor FieldInterceptor */ $currentInterceptor = current($this->advices); if (!$currentInterceptor) { if ($this->accessType === self::READ) { return $this->value; } else { return $this->getValueToSet(); } } next($this->advices); return $currentInterceptor->{self::$interceptorMethodMapping[$this->accessType]}($this); } /** * Invokes current field access with all interceptors * * @param object $instance Instance of object * @param integer $accessType Type of access: READ or WRITE * @param mixed $originalValue Original value of property * @param mixed $newValue New value to set * * @return mixed */ final public function __invoke($instance, $accessType, $originalValue, $newValue = NAN) { $this->instance = $instance; $this->accessType = $accessType; $this->value = $originalValue; $this->newValue = $newValue; reset($this->advices); return $this->proceed(); } /** * Returns the object that holds the current joinpoint's static * part. * *

For instance, the target object for an invocation. * * @return object|null the object (can be null if the accessible object is * static). */ final public function getThis() { return $this->instance; } /** * Returns the static part of this joinpoint. * *

The static part is an accessible object on which a chain of * interceptors are installed. * @return object */ final public function getStaticPart() { return $this->getField(); } } src/Go/Aop/Framework/ClosureDynamicMethodInvocation.php000064400000004354144760123700017213 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\Intercept\MethodInterceptor; /** * NB: This invocation is only used for dynamic methods to support LSB * * @package go */ class ClosureDynamicMethodInvocation extends AbstractMethodInvocation { /** * Closure to use * * @var \Closure */ private $closureToCall = null; /** * Previous scope of invocation * * @var null */ private $previousInstance = null; /** * Invokes original method and return result from it * * @return mixed */ public function proceed() { if (isset($this->advices[$this->current])) { /** @var $currentInterceptor MethodInterceptor */ $currentInterceptor = $this->advices[$this->current++]; return $currentInterceptor->invoke($this); } // Fill the closure only once if it's empty if (!$this->closureToCall) { $this->closureToCall = $this->reflectionMethod->getClosure($this->instance); } // Rebind the closure if instance was changed since last time if ($this->previousInstance !== $this->instance) { $this->closureToCall = $this->closureToCall->bindTo($this->instance, $this->className); $this->previousInstance = $this->instance; } $closureToCall = $this->closureToCall; $args = $this->arguments; switch(count($args)) { case 0: return $closureToCall(); case 1: return $closureToCall($args[0]); case 2: return $closureToCall($args[0], $args[1]); case 3: return $closureToCall($args[0], $args[1], $args[2]); case 4: return $closureToCall($args[0], $args[1], $args[2], $args[3]); case 5: return $closureToCall($args[0], $args[1], $args[2], $args[3], $args[4]); default: return forward_static_call_array($closureToCall, $args); } } } src/Go/Aop/Framework/ClosureStaticMethodInvocation.php000064400000004157144760123700017057 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\Intercept\MethodInterceptor; /** * NB: This invocation is only used for static methods to support LSB * * @package go */ class ClosureStaticMethodInvocation extends AbstractMethodInvocation { /** * Closure to use * * @var \Closure */ private $closureToCall = null; /** * Previous scope of invocation * * @var null */ private $previousScope = null; /** * {@inheritdoc} */ public function __construct($className, $methodName, array $advices) { parent::__construct($className, $methodName, $advices); $this->closureToCall = $this->getStaticInvoker($this->className, $methodName); } /** * Invokes original method and return result from it * * @return mixed */ public function proceed() { if (isset($this->advices[$this->current])) { /** @var $currentInterceptor MethodInterceptor */ $currentInterceptor = $this->advices[$this->current++]; return $currentInterceptor->invoke($this); } // Rebind the closure if scope (class name) was changed since last time if ($this->previousScope !== $this->instance) { $this->closureToCall = $this->closureToCall->bindTo(null, $this->instance); $this->previousScope = $this->instance; } $closureToCall = $this->closureToCall; return $closureToCall($this->arguments); } /** * Returns static method invoker * * @param string $className Class name to forward request * @param string $method Method name to call * * @return \Closure */ protected static function getStaticInvoker($className, $method) { return function (array $args) use ($className, $method) { return forward_static_call_array(array($className, $method), $args); }; } } src/Go/Aop/Framework/ConstructorAfterInterceptor.php000064400000003000144760123700016610 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Exception; use Go\Aop\AdviceAfter; use Go\Aop\Intercept\ConstructorInvocation; use Go\Aop\Intercept\ConstructorInterceptor; /** * @package go */ class ConstructorAfterInterceptor extends BaseInterceptor implements ConstructorInterceptor, AdviceAfter { /** * Implement this method to perform extra treatments before and * after the construction of a new object. Polite implementations * would certainly like to invoke {@link Joinpoint::proceed()}. * * @param ConstructorInvocation $invocation the construction joinpoint * @throws Exception if exception was thrown in constructor * * @return mixed the newly created object, which is also the result of * the call to {@link Joinpoint::proceed()}, might be replaced by * the interceptor. */ final public function construct(ConstructorInvocation $invocation) { $result = null; try { $result = $invocation->proceed(); } catch (Exception $invocationException) { // this is need for finally emulation in PHP } $adviceMethod = $this->adviceMethod; $adviceMethod($invocation); if (isset($invocationException)) { throw $invocationException; } return $result; } } src/Go/Aop/Framework/ConstructorBeforeInterceptor.php000064400000002222144760123700016756 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\AdviceBefore; use Go\Aop\Intercept\ConstructorInvocation; use Go\Aop\Intercept\ConstructorInterceptor; /** * @package go */ class ConstructorBeforeInterceptor extends BaseInterceptor implements ConstructorInterceptor, AdviceBefore { /** * Implement this method to perform extra treatments before and * after the construction of a new object. Polite implementations * would certainly like to invoke {@link Joinpoint::proceed()}. * * @param ConstructorInvocation $invocation the construction joinpoint * @return mixed the newly created object, which is also the result of * the call to {@link Joinpoint::proceed()}, might be replaced by * the interceptor. */ final public function construct(ConstructorInvocation $invocation) { $adviceMethod = $this->adviceMethod; $adviceMethod($invocation); return $invocation->proceed(); } } src/Go/Aop/Framework/FieldAfterInterceptor.php000064400000003300144760123700015311 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\AdviceAfter; use Go\Aop\Intercept\FieldAccess; use Go\Aop\Intercept\FieldInterceptor; /** * @package go */ class FieldAfterInterceptor extends BaseInterceptor implements FieldInterceptor, AdviceAfter { /** * Do the stuff you want to do before and after the * field is getted. * *

Polite implementations would certainly like to call * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldRead the joinpoint that corresponds to the field read * @return mixed the result of the field read {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function get(FieldAccess $fieldRead) { $value = $fieldRead->proceed(); $adviceMethod = $this->adviceMethod; $adviceMethod($fieldRead); return $value; } /** * Do the stuff you want to do before and after the * field is setted. * *

Polite implementations would certainly like to implement * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldWrite the joinpoint that corresponds to the field write * @return mixed the result of the field set {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function set(FieldAccess $fieldWrite) { $value = $fieldWrite->proceed(); $adviceMethod = $this->adviceMethod; $adviceMethod($fieldWrite); return $value; } } src/Go/Aop/Framework/FieldAroundInterceptor.php000064400000003116144760123700015505 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\AdviceAround; use Go\Aop\Intercept\FieldAccess; use Go\Aop\Intercept\FieldInterceptor; /** * @package go */ class FieldAroundInterceptor extends BaseInterceptor implements FieldInterceptor, AdviceAround { /** * Do the stuff you want to do before and after the * field is getted. * *

Polite implementations would certainly like to call * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldRead the joinpoint that corresponds to the field read * @return mixed the result of the field read {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function get(FieldAccess $fieldRead) { $adviceMethod = $this->adviceMethod; return $adviceMethod($fieldRead); } /** * Do the stuff you want to do before and after the * field is setted. * *

Polite implementations would certainly like to implement * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldWrite the joinpoint that corresponds to the field write * @return mixed the result of the field set {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function set(FieldAccess $fieldWrite) { $adviceMethod = $this->adviceMethod; return $adviceMethod($fieldWrite); } } src/Go/Aop/Framework/FieldBeforeInterceptor.php000064400000003217144760123700015461 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\AdviceBefore; use Go\Aop\Intercept\FieldAccess; use Go\Aop\Intercept\FieldInterceptor; /** * @package go */ class FieldBeforeInterceptor extends BaseInterceptor implements FieldInterceptor, AdviceBefore { /** * Do the stuff you want to do before and after the * field is getted. * *

Polite implementations would certainly like to call * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldRead the joinpoint that corresponds to the field read * @return mixed the result of the field read {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function get(FieldAccess $fieldRead) { $adviceMethod = $this->adviceMethod; $adviceMethod($fieldRead); return $fieldRead->proceed(); } /** * Do the stuff you want to do before and after the * field is setted. * *

Polite implementations would certainly like to implement * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldWrite the joinpoint that corresponds to the field write * @return mixed the result of the field set {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function set(FieldAccess $fieldWrite) { $adviceMethod = $this->adviceMethod; $adviceMethod($fieldWrite); return $fieldWrite->proceed(); } } src/Go/Aop/Framework/MethodAfterInterceptor.php000064400000002237144760123700015516 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Exception; use Go\Aop\AdviceAfter; use Go\Aop\Intercept\MethodInvocation; use Go\Aop\Intercept\MethodInterceptor; /** * @package go */ class MethodAfterInterceptor extends BaseInterceptor implements MethodInterceptor, AdviceAfter { /** * After invoker * * @param $invocation MethodInvocation the method invocation joinpoint * @return mixed the result of the call to {@link Joinpoint::proceed()} * @throws Exception */ final public function invoke(MethodInvocation $invocation) { $result = null; try { $result = $invocation->proceed(); } catch (Exception $invocationException) { // this is need for finally emulation in PHP } $adviceMethod = $this->adviceMethod; $adviceMethod($invocation); if (isset($invocationException)) { throw $invocationException; } return $result; } } src/Go/Aop/Framework/MethodAfterThrowingInterceptor.php000064400000002123144760123700017232 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Exception; use Go\Aop\AdviceAfter; use Go\Aop\Intercept\MethodInvocation; use Go\Aop\Intercept\MethodInterceptor; /** * @package go */ class MethodAfterThrowingInterceptor extends BaseInterceptor implements MethodInterceptor, AdviceAfter { /** * After throwing exception invoker * * @param $invocation MethodInvocation the method invocation joinpoint * @return mixed the result of the call to {@link Joinpoint::proceed()} * @throws Exception */ final public function invoke(MethodInvocation $invocation) { $result = null; try { $result = $invocation->proceed(); } catch (Exception $invocationException) { $adviceMethod = $this->adviceMethod; $adviceMethod($invocation); throw $invocationException; } return $result; } } src/Go/Aop/Framework/MethodAroundInterceptor.php000064400000001551144760123700015703 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Exception; use Go\Aop\AdviceAround; use Go\Aop\Intercept\MethodInvocation; use Go\Aop\Intercept\MethodInterceptor; /** * @package go */ class MethodAroundInterceptor extends BaseInterceptor implements MethodInterceptor, AdviceAround { /** * Around invoker * * @param $invocation MethodInvocation the method invocation joinpoint * @return mixed the result of the call to {@link Joinpoint::proceed()} * @throws Exception */ final public function invoke(MethodInvocation $invocation) { $adviceMethod = $this->adviceMethod; return $adviceMethod($invocation); } } src/Go/Aop/Framework/MethodBeforeInterceptor.php000064400000001541144760123700015654 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\AdviceBefore; use Go\Aop\Intercept\MethodInvocation; use Go\Aop\Intercept\MethodInterceptor; /** * @package go */ class MethodBeforeInterceptor extends BaseInterceptor implements MethodInterceptor, AdviceBefore { /** * Before invoker * * @param MethodInvocation $invocation the method invocation joinpoint * @return mixed the result of the call to {@link Joinpoint::proceed()}, */ final public function invoke(MethodInvocation $invocation) { $adviceMethod = $this->adviceMethod; $adviceMethod($invocation); return $invocation->proceed(); } } src/Go/Aop/Framework/ReflectionConstructorInvocation.php000064400000007137144760123700017473 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use ReflectionClass; use ReflectionMethod; use Go\Aop\Intercept\ConstructorInvocation; use Go\Aop\Intercept\ConstructorInterceptor; /** * Reflection constructor invocation implementation * * @see Go\Aop\Intercept\ConstructorInvocation * @package go */ class ReflectionConstructorInvocation extends AbstractInvocation implements ConstructorInvocation { /** * Reflection class * * @var ReflectionClass */ protected $class = null; /** * Instance of reflection constructor for class * * @var null|ReflectionMethod */ private $constructor = null; /** * Constructor for constructor invocation :) * * @param string $className Class name * @param $advices array List of advices for this invocation */ public function __construct($className, array $advices) { $this->class = new ReflectionClass($className); parent::__construct($className, $advices); } /** * Proceed to the next interceptor in the Chain * * Typically this method is called inside previous closure, as instance of Joinpoint is passed to callback * Do not call this method directly, only inside callback closures. * * @return mixed */ final public function proceed() { if (isset($this->advices[$this->current])) { /** @var $currentInterceptor ConstructorInterceptor */ $currentInterceptor = $this->advices[$this->current]; $this->current++; return $currentInterceptor->construct($this); } return $this->constructOriginal(); } /** * Gets the constructor being called. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionMethod the constructor being called. */ public function getConstructor() { if (!$this->constructor) { $this->constructor = $this->class->getConstructor(); // Give an access to call protected constructor if ($this->constructor->isProtected()) { $this->constructor->setAccessible(true); } } return $this->constructor; } /** * Returns the object that holds the current joinpoint's static * part. * *

For instance, the target object for an invocation. * * @return object|null the object (can be null if the accessible object is * static). */ public function getThis() { return null; } /** * Returns the static part of this joinpoint. * *

The static part is an accessible object on which a chain of * interceptors are installed. * @return object */ public function getStaticPart() { return $this->getConstructor(); } /** * Invokes current constructor invocation with all interceptors * * @return mixed */ final public function __invoke() { // TODO: add support for recursion in constructors $this->current = 0; $this->arguments = func_get_args(); return $this->proceed(); } /** * Invokes original constructor and return result from it * * @return mixed */ protected function constructOriginal() { return $this->class->newInstanceArgs($this->arguments); } } src/Go/Aop/Framework/ReflectionMethodInvocation.php000064400000002012144760123700016351 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\Intercept\MethodInterceptor; /** * @package go */ class ReflectionMethodInvocation extends AbstractMethodInvocation { /** * Invokes original method and return result from it * * @return mixed */ public function proceed() { if (isset($this->advices[$this->current])) { /** @var $currentInterceptor MethodInterceptor */ $currentInterceptor = $this->advices[$this->current++]; return $currentInterceptor->invoke($this); } // Due to bug https://bugs.php.net/bug.php?id=60968 instance shouldn't be a string $instance = ($this->instance !== (object) $this->instance) ? null : $this->instance; return $this->reflectionMethod->invokeArgs($instance, $this->arguments); } } src/Go/Aop/Framework/TraitIntroductionInfo.php000064400000002544144760123700015377 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Framework; use Go\Aop\IntroductionInfo; /** * @package go */ class TraitIntroductionInfo implements IntroductionInfo { /** * Name of the interface to introduce * * @var string */ private $introducedInterface; /** * Name of the class with implementation (trait) * * @var string */ private $implementationClass; /** * Create a DefaultIntroductionAdvisor for the given advice. */ public function __construct($interfaceType, $implementationClass) { $this->introducedInterface = $interfaceType; $this->implementationClass = $implementationClass; } /** * Return the additional interfaces introduced by this Advisor or Advice. * * @return array|string[] the introduced interfaces */ public function getInterfaces() { return array($this->introducedInterface); } /** * Return the list of traits with realization of introduced interfaces * * @return array|string[] the implementations */ public function getTraits() { return array($this->implementationClass); } } src/Go/Aop/Intercept/ConstructorInterceptor.php000064400000002776144760123700015651 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; /** * Intercepts the construction of a new object. * *

The user should implement the {@link construct(ConstructorInvocation)} * method to modify the original behavior. E.g. the following class implements a singleton * interceptor (allows only one unique instance for the intercepted * class): * * 

 * class DebuggingInterceptor implements ConstructorInterceptor {
 *   protected $instance=null;
 *
 *   public function construct(ConstructorInvocation $i) {
 *     if($this->instance==null) {
 *       return $this->instance=$i->proceed();
 *     } else {
 *       throw new \Exception("singleton does not allow multiple instance");
 *     }
 *   }
 * }
 *
*/ interface ConstructorInterceptor extends Interceptor { /** * Implement this method to perform extra treatments before and * after the construction of a new object. Polite implementations * would certainly like to invoke {@link Joinpoint::proceed()}. * * @param ConstructorInvocation $invocation the construction joinpoint * @return mixed the newly created object, which is also the result of * the call to {@link Joinpoint::proceed()}, might be replaced by * the interceptor. */ public function construct(ConstructorInvocation $invocation); } src/Go/Aop/Intercept/ConstructorInvocation.php000064400000001532144760123700015451 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; use ReflectionMethod; /** * Description of an invocation to a constructor, given to an * interceptor upon constructor-call. * *

A constructor invocation is a joinpoint and can be intercepted * by a constructor interceptor. * * @see ConstructorInterceptor */ interface ConstructorInvocation extends Invocation { /** * Gets the constructor being called. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionMethod the constructor being called. */ public function getConstructor(); } src/Go/Aop/Intercept/FieldAccess.php000064400000002443144760123700013241 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; use ReflectionProperty; /** * This interface represents a field access in the program. * *

A field access is a joinpoint and can be intercepted by a field * interceptor. * * @see FieldInterceptor */ interface FieldAccess extends Joinpoint { /** * The read access type (see {@link getAccessType()}). */ const READ = 0; /** * The write access type (see {@link getAccessType()}). */ const WRITE = 1; /** * Gets the field being accessed. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionProperty the field being accessed. */ public function getField(); /** * Gets the value that must be set to the field. * *

This value can be intercepted and changed by a field * interceptor. * * @return mixed */ public function getValueToSet(); /** * Returns the access type. * * @return integer */ public function getAccessType(); } src/Go/Aop/Intercept/FieldInterceptor.php000064400000004176144760123700014343 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; /** * Intercepts field access on a target object. * *

The user should implement the {@link set(FieldAccess)} and * {@link get(FieldAccess)} methods to modify the original * behavior. E.g. the following class implements a tracing interceptor * (traces the accesses to the intercepted field(s)): * * 

 * class TracingInterceptor implements FieldInterceptor {
 *
 *   public function set(FieldAccess $fa) {
 *     print("field ".$fa->getField()." is set with value ".
 *                        $fa->getValueToSet());
 *     $ret=$fa->proceed();
 *     print("field ".$fa->getField()." was set to value ".$ret);
 *     return $ret;
 *   }
 *
 *   public function get(FieldAccess $fa) {
 *     print("field ".$fa->getField()." is about to be read");
 *     $ret=$fa->proceed();
 *     print("field ".$fa->getField()." was read; value is ".$ret);
 *     return $ret;
 *   }
 * }
 *
*/ interface FieldInterceptor extends Interceptor { /** * Do the stuff you want to do before and after the * field is getted. * *

Polite implementations would certainly like to call * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldRead the joinpoint that corresponds to the field read * * @return mixed the result of the field read {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function get(FieldAccess $fieldRead); /** * Do the stuff you want to do before and after the * field is setted. * *

Polite implementations would certainly like to implement * {@link Joinpoint::proceed()}. * * @param FieldAccess $fieldWrite the joinpoint that corresponds to the field write * * @return mixed the result of the field set {@link Joinpoint::proceed()}, might be intercepted by the * interceptor. */ public function set(FieldAccess $fieldWrite); }src/Go/Aop/Intercept/Interceptor.php000064400000003267144760123700013377 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; use Go\Aop\Advice; /** * This interface represents a generic interceptor. * *

A generic interceptor can intercept runtime events that occur * within a base program. Those events are materialized by (reified * in) joinpoints. Runtime joinpoints can be invocations, field * access, exceptions... * *

This interface is not used directly. Use the the sub-interfaces * to intercept specific events. For instance, the following class * implements some specific interceptors in order to implement a * debugger: * * 

 * class DebuggingInterceptor implements MethodInterceptor,
 *     ConstructorInterceptor, FieldInterceptor {
 *
 *   public function invoke(MethodInvocation $i) {
 *       $this->debug($i->getMethod(), $i->getThis(), $i->getArgs());
 *       return $i->proceed();
 *   }
 *
 *   public function construct(ConstructorInvocation $i) {
 *       $this->debug($i->getConstructor(), $i->getThis(), $i->getArgs());
 *       return $i->proceed();
 *   }
 *
 *   public function get(FieldAccess $fa) {
 *       $this->debug($fa->getField(), $fa->getThis(), null);
 *       return $fa->proceed();
 *   }
 *
 *   public function set(FieldAccess $fa) {
 *       $this->debug($fa->getField(), $fa->getThis(), $fa->getValueToSet());
 *       return $fa->proceed();
 *   }
 *
 *   protected function debug($accessibleObject, $object, $value) {
 *       ...
 *   }
 * }
 *
* * @see Joinpoint */ interface Interceptor extends Advice { }src/Go/Aop/Intercept/Invocation.php000064400000001343144760123700013203 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; /** * This interface represents an invocation in the program * *

An invocation is a joinpoint and can be intercepted by an * interceptor * * @author Rod Johnson * @author Lissachenko Alexander */ interface Invocation extends Joinpoint { /** * Get the arguments as an array object. * It is possible to change element values within this array to change the arguments * * @return array the arguments of the invocation */ public function getArguments(); }src/Go/Aop/Intercept/Joinpoint.php000064400000003512144760123700013043 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; /** * This interface represents a generic runtime joinpoint (in the AOP * terminology). * *

A runtime joinpoint is an event that occurs on a static * joinpoint (i.e. a location in a the program). For instance, an * invocation is the runtime joinpoint on a method (static joinpoint). * The static part of a given joinpoint can be generically retrieved * using the {@link getStaticPart()} method. * *

In the context of an interception framework, a runtime joinpoint * is then the reification of an access to an accessible object (a * method, a constructor, a field), i.e. the static part of the * joinpoint. It is passed to the interceptors that are installed on * the static joinpoint. * * @see Interceptor */ interface Joinpoint { /** * Proceeds to the next interceptor in the chain. * *

The implementation and the semantics of this method depends * on the actual joinpoint type (see the children interfaces). * * @return mixed see the children interfaces' proceed definition. */ public function proceed(); /** * Returns the object that holds the current joinpoint's static * part. * *

For instance, the target object for an invocation. * * @return object|null the object (can be null if the accessible object is * static). */ public function getThis(); /** * Returns the static part of this joinpoint. * *

The static part is an accessible object on which a chain of * interceptors are installed. * @return object */ public function getStaticPart(); } src/Go/Aop/Intercept/MethodInterceptor.php000064400000002736144760123700014540 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; /** * Intercepts calls on an interface on its way to the target. These * are nested "on top" of the target. * *

The user should implement the {@link invoke(MethodInvocation)} * method to modify the original behavior. E.g. the following class * implements a tracing interceptor (traces all the calls on the * intercepted method(s)): * * 

 * class TracingInterceptor implements MethodInterceptor {
 *   public function invoke(MethodInvocation $i) {
 *     print("method ".$i->getMethod()." is called on ".
 *                        $i->getThis()." with args ".$i->getArguments());
 *     $ret=$i->proceed();
 *     print("method ".$i->getMethod()." returns ".$ret);
 *     return $ret;
 *   }
 * }
 *
*/ interface MethodInterceptor extends Interceptor { /** * Implement this method to perform extra treatments before and * after the invocation. Polite implementations would certainly * like to invoke {@link Joinpoint::proceed()}. * * @param MethodInvocation $invocation the method invocation joinpoint * @return mixed the result of the call to {@link Joinpoint::proceed()}, * might be intercepted by the interceptor. */ public function invoke(MethodInvocation $invocation); }src/Go/Aop/Intercept/MethodInvocation.php000064400000001676144760123700014355 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Intercept; use ReflectionMethod; /** * Description of an invocation to a method, given to an interceptor * upon method-call. * *

A method invocation is a joinpoint and can be intercepted by a method * interceptor. * * @see MethodInterceptor */ interface MethodInvocation extends Invocation { /** * Gets the method being called. * *

This method is a friendly implementation of the * {@link Joinpoint::getStaticPart()} method (same result). * * @return ReflectionMethod the method being called. */ public function getMethod(); /** * Invokes current method invocation with all interceptors * * @return mixed */ public function __invoke(); } src/Go/Aop/IntroductionAdvisor.php000064400000002364144760123700013152 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Superinterface for advisors that perform one or more AOP introductions. * * This interface cannot be implemented directly; subinterfaces must provide the advice type * implementing the introduction. * * Introduction is the implementation of additional interfaces (not implemented by a target) via AOP advice. */ interface IntroductionAdvisor extends Advisor { /** * Return the filter determining which target classes this introduction should apply to. * * This represents the class part of a pointcut. Note that method matching doesn't make sense to introductions. * * @return ClassFilter The class filter */ public function getClassFilter(); /** * Can the advised interfaces be implemented by the introduction advice? * * Invoked before adding an IntroductionAdvisor. * * @return void * @throws \InvalidArgumentException if the advised interfaces can't be implemented by the introduction advice */ public function validateInterfaces(); } src/Go/Aop/IntroductionInfo.php000064400000001740144760123700012433 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Interface supplying the information necessary to describe an introduction of trait. * * If an Advice implements this, it may be used as an introduction without an IntroductionAdvisor. * In this case, the advice is self-describing, providing not only the necessary behavior, * but describing the interfaces it introduces. */ interface IntroductionInfo extends Advice { /** * Return the additional interfaces introduced by this Advisor or Advice. * * @return array|string[] the introduced interfaces */ public function getInterfaces(); /** * Return the list of traits with realization of introduced interfaces * * @return array|string[] the implementations */ public function getTraits(); } src/Go/Aop/MethodMatcher.php000064400000003367144760123700011671 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Part of a Pointcut: Checks whether the target method is eligible for advice. * * A MethodMatcher may be evaluated statically or at runtime (dynamically). * Static matching involves method and (possibly) method attributes. Dynamic matching also makes arguments for * a particular call available, and any effects of running previous advice applying to the joinpoint. * * If an implementation returns false from its isRuntime() method, evaluation can be performed statically, * and the result will be the same for all invocations of this method, whatever their arguments. * This means that if the isRuntime() method returns false, the 3-arg matches() method will never be invoked. * * If an implementation returns true from its 2-arg matches() method and its isRuntime() method returns true, * the 3-arg matches() method will be invoked immediately before each potential execution of the related advice, * to decide whether the advice should run. All previous advice, such as earlier interceptors in an interceptor chain, * will have run, so any state changes they have produced in parameters will be available at the time of evaluation. */ interface MethodMatcher extends PointFilter { /** * Is this MethodMatcher dynamic or static * * Can be invoked when an AOP proxy is created, and need not be invoked again before each method invocation * * @return bool whether or not a runtime match via the 3-arg matches() method is required if static matching passed */ public function isRuntime(); } src/Go/Aop/PointFilter.php000064400000001077144760123700011400 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Filter that restricts matching of a pointcut or introduction to a given set of reflection points. */ interface PointFilter { /** * Performs matching of point of code * * @param mixed $point Specific part of code, can be any Reflection class * * @return bool */ public function matches($point); } src/Go/Aop/Pointcut.php000064400000001634144760123700010745 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Pointcut realization for PHP * * Pointcuts are defined as a predicate over the syntax-tree of the program, and define an interface that constrains * which elements of the base program are exposed by the pointcut. A pointcut picks out certain join points and values * at those points * * @package go * @subpackage aop */ interface Pointcut { /** * Return the ClassFilter for this pointcut. * * @return ClassFilter */ public function getClassFilter(); /** * Return the PointFilter for this pointcut. * * This can be method filter, property filter. * * @return PointFilter */ public function getPointFilter(); } src/Go/Aop/PointcutAdvisor.php000064400000001146144760123700012273 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Super-interface for all Advisors that are driven by a pointcut. * * This covers nearly all advisors except introduction advisors, for which method-level matching doesn't apply. */ interface PointcutAdvisor extends Advisor { /** * Get the Pointcut that drives this advisor. * * @return Pointcut The pointcut */ public function getPointcut(); } src/Go/Aop/PropertyMatcher.php000064400000000560144760123700012265 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Filter that restricts matching of a pointcut to a given set of properties */ interface PropertyMatcher extends PointFilter { } src/Go/Aop/Proxy.php000064400000000600144760123700010251 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Marker interface implemented by all AOP proxies. * * Used to detect whether or not objects are Go-generated proxies. */ interface Proxy { } src/Go/Aop/Support/AbstractChildCreator.php000064400000022431144760123700014641 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflection; use ReflectionClass; use ReflectionParameter; use ReflectionMethod; use TokenReflection\ReflectionClass as ParsedReflectionClass; use TokenReflection\ReflectionParameter as ParsedReflectionParameter; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; class AbstractChildCreator { /** * Indent for source code * * @var int */ protected $indent = 4; /** * Parent class reflection * * @var null|ReflectionClass|ParsedReflectionClass */ protected $class = null; /** * Name for the current class * * @var string */ protected $name = ''; /** * Parent class name, can be changed manually * * @var string */ protected $parentClassName = null; /** * Source code for methods * * @var array Name of method => source code for it */ protected $methodsCode = array(); /** * List of additional interfaces to implement * * @var array */ protected $interfaces = array(); /** * List of additional traits for using * * @var array */ protected $traits = array(); /** * Source code for properties * * @var array Name of property => source code for it */ protected $propertiesCode = array(); /** * List of advices that are used for generation of child * * @var array */ protected $advices = array(); /** * Constructs abstract child class from Reflection * * @param ReflectionClass|ParsedReflectionClass $parentClass Reflection * @param string $thisName Name of the child class * @param array $advices List of advices * * @throws \InvalidArgumentException for invalid classes */ public function __construct($parentClass, $thisName, array $advices = array()) { if (!$parentClass instanceof ReflectionClass && !$parentClass instanceof ParsedReflectionClass) { throw new \InvalidArgumentException("Invalid argument for class"); } $this->advices = $advices; $this->class = $parentClass; $this->name = $thisName; $this->parentClassName = $parentClass->getShortName(); } /** * Updates parent name for child * * @param string $newParentName New class name * * @return AbstractChildCreator */ public function setParentName($newParentName) { $this->parentClassName = $newParentName; return $this; } /** * Override parent method with new body * * @param string $methodName Method name to override * @param string $body New body for method * * @return AbstractChildCreator */ public function override($methodName, $body) { $this->methodsCode[$methodName] = $this->getOverriddenMethod($this->class->getMethod($methodName), $body); return $this; } /** * Creates a method * * @param int $methodFlags See ReflectionMethod modifiers * @param string $methodName Name of the method * @param string $body Body of method * @param string $parameters Definition of parameters * * @return AbstractChildCreator */ public function setMethod($methodFlags, $methodName, $body, $parameters) { $this->methodsCode[$methodName] = sprintf("%s%s function %s(%s)\n{\n%s\n}\n", "/**\n * Method was created automatically, do not change it manually\n */\n", join(' ', Reflection::getModifierNames($methodFlags)), $methodName, $parameters, $this->indent($body) ); return $this; } /** * Add an interface for child * * @param string|ReflectionClass|ParsedReflectionClass $interface */ public function addInterface($interface) { $interfaceName = $interface; if ($interface instanceof ReflectionClass || $interface instanceof ParsedReflectionClass) { if (!$interface->isInterface()) { throw new \InvalidArgumentException("Interface expected to add"); } $interfaceName = $interface->name; } $this->interfaces[] = $interfaceName; } /** * Add a trait for child * * @param string|ReflectionClass|ParsedReflectionClass $trait */ public function addTrait($trait) { $traitName = $trait; if ($trait instanceof ReflectionClass || $trait instanceof ParsedReflectionClass) { if (!$trait->isTrait()) { throw new \InvalidArgumentException("Trait expected to add"); } $traitName = $trait->name; } $this->traits[] = $traitName; } /** * Creates a property * * @param int $propFlags See ReflectionProperty modifiers * @param string $propName Name of the property * @param null|string $defaultText Default value, should be string text! * * @return AbstractChildCreator */ public function setProperty($propFlags, $propName, $defaultText = null) { $this->propertiesCode[$propName] = sprintf("%s%s $%s%s;\n", "/**\n *Property was created automatically, do not change it manually\n */\n", join(' ', Reflection::getModifierNames($propFlags)), $propName, is_string($defaultText) ? " = $defaultText" : '' ); return $this; } /** * Returns text representation of class * * @return string */ public function __toString() { ksort($this->methodsCode); ksort($this->propertiesCode); $prefix = join(' ', Reflection::getModifierNames($this->class->getModifiers())); $code = sprintf("%s\n%sclass %s extends %s%s\n{\n%s\n\n%s\n%s\n}", $this->class->getDocComment(), $prefix ? "$prefix " : '', $this->name, $this->parentClassName, $this->interfaces ? ' implements ' . join(', ', $this->interfaces) : '', $this->traits ? $this->indent('use ' . join(', ', $this->traits) .';') : '', $this->indent(join("\n", $this->propertiesCode)), $this->indent(join("\n", $this->methodsCode)) ); return $code; } /** * Creates a method code from Reflection * * @param ReflectionMethod|ParsedReflectionMethod $method Reflection for method * @param string $body Body of method * @param int $indent Spaces to indent * * @return string */ protected function getOverriddenMethod($method, $body) { $code = sprintf("%s%s function %s%s(%s)\n{\n%s\n}\n", preg_replace('/ {4}|\t/', '', $method->getDocComment()) ."\n", join(' ', Reflection::getModifierNames($method->getModifiers())), $method->returnsReference() ? '&' : '', $method->name, join(', ', $this->getParameters($method->getParameters())), $this->indent($body) ); return $code; } /** * Indent block of code * * @param string $text Non-indented text * @param integer $spaces Number of spaces for indentation * @return string Indented text */ protected function indent($text) { $pad = str_pad('', $this->indent, ' '); $lines = array_map(function ($line) use ($pad) { return $pad . $line; }, explode("\n", $text)); return join("\n", $lines); } /** * Returns list of string representation of parameters * * @param array|ReflectionParameter[]|ParsedReflectionParameter[] $parameters List of parameters * * @return array */ protected function getParameters(array $parameters) { $parameterDefinitions = array(); foreach ($parameters as $parameter) { $parameterDefinitions[] = $this->getParameterCode($parameter); } return $parameterDefinitions; } /** * Return string representation of parameter * * @param ReflectionParameter|ParsedReflectionParameter $parameter Reflection parameter * * @return string */ protected function getParameterCode($parameter) { $type = ''; if ($parameter->isArray()) { $type = 'array'; } elseif ($parameter->getClass()) { $type = '\\' . $parameter->getClass()->name; } $defaultValue = null; $isDefaultValueAvailable = $parameter->isDefaultValueAvailable(); if ($isDefaultValueAvailable) { if ($parameter instanceof ParsedReflectionParameter) { $defaultValue = $parameter->getDefaultValueDefinition(); } else { $defaultValue = var_export($parameter->getDefaultValue()); } } elseif ($parameter->allowsNull()) { $defaultValue = 'null'; } $code = sprintf('%s%s$%s%s', $type ? "$type " : '', $parameter->isPassedByReference() ? '&' : '', $parameter->name, $isDefaultValueAvailable ? (" = " . $defaultValue) : '' ); return $code; } } src/Go/Aop/Support/AbstractGenericPointcutAdvisor.php000064400000003030144760123700016722 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Go\Aop\Advice; use Go\Aop\PointcutAdvisor; /** * Abstract generic PointcutAdvisor that allows for any Advice to be configured. */ abstract class AbstractGenericPointcutAdvisor implements PointcutAdvisor { /** * @var null|Advice */ private $advice = null; /** * Return whether this advice is associated with a particular instance or shared with all instances * of the advised class * * NB: This method was moved from AbstractPointcutAdvisor to simplify hierarchy * * @return bool Whether this advice is associated with a particular target instance */ public function isPerInstance() { return true; } /** * Specify the advice that this advisor should apply. * * @param Advice $advice Advice to apply */ public function setAdvice(Advice $advice) { $this->advice = $advice; } /** * Returns an advice to apply * * @return Advice|null */ public function getAdvice() { return $this->advice; } /** * Return string representation of object * * @return string */ public function __toString() { $adviceClass = get_class($this->getAdvice()); return get_called_class() . ": advice [{$adviceClass}]"; } } src/Go/Aop/Support/AnnotationMethodPointcut.php000064400000003554144760123700015620 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionMethod; use Go\Instrument\RawAnnotationReader; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; /** * Annotation method pointcut checks method annotation */ class AnnotationMethodPointcut extends StaticMethodMatcherPointcut { /** * Annotation class to match * * @var string */ protected $annotationName = ''; /** * Annotation reader * * @var null|RawAnnotationReader */ protected $annotationReader = null; /** * Annotation method matcher constructor * * @param RawAnnotationReader $reader Annotation reader * @param string $annotationName Name of the annotation class to match */ public function __construct(RawAnnotationReader $reader, $annotationName) { $this->annotationName = $annotationName; $this->annotationReader = $reader; } /** * Performs matching of point of code * * @param $method ReflectionMethod|ParsedReflectionMethod Specific part of code, can be any Reflection class * * @return bool */ public function matches($method) { /** @var $method ReflectionMethod|ParsedReflectionMethod */ if (!$method instanceof ReflectionMethod && !$method instanceof ParsedReflectionMethod) { return false; } if ($method instanceof ParsedReflectionMethod) { $imports = $method->getNamespaceAliases(); $this->annotationReader->setImports($imports); } $annotation = $this->annotationReader->getMethodAnnotation($method, $this->annotationName); return (bool) $annotation; } } src/Go/Aop/Support/AopChildFactory.php000064400000027015144760123700013630 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionClass; use ReflectionMethod; use ReflectionParameter; use ReflectionProperty as Property; use UnexpectedValueException; use Go\Core\AspectContainer; use Go\Core\AspectKernel; use Go\Aop\Advice; use Go\Aop\IntroductionInfo; use Go\Aop\Intercept\Joinpoint; use Go\Aop\Framework\ClassFieldAccess; use Go\Aop\Framework\ReflectionMethodInvocation; use Go\Aop\Framework\ClosureStaticMethodInvocation; use Go\Aop\Framework\ClosureDynamicMethodInvocation; use TokenReflection\ReflectionClass as ParsedReflectionClass; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; use TokenReflection\ReflectionParameter as ParsedReflectionParameter; use TokenReflection\ReflectionProperty as ParsedReflectionProperty; /** * AOP Factory that is used to generate child code from joinpoints */ class AopChildFactory extends AbstractChildCreator { /** * Flag to determine if we need to add a code for property interceptors * * @var bool */ private $isFieldsIntercepted = false; /** * List of intercepted properties names * * @var array */ private $interceptedProperties = array(); /** * Generates an child code by parent class reflection and joinpoints for it * * @param ReflectionClass|ParsedReflectionClass $parent Parent class reflection * @param array|Advice[] $advices List of advices for * * @return AopChildFactory */ public static function generate($parent, array $advices) { $aopChild = new static($parent, $parent->getShortName(), $advices); if (!empty($advices)) { $aopChild->addJoinpointsProperty($aopChild); foreach ($advices as $name => $value) { list ($type, $pointName) = explode(':', $name, 2); switch ($type) { case AspectContainer::METHOD_PREFIX: case AspectContainer::STATIC_METHOD_PREFIX: $aopChild->overrideMethod($parent->getMethod($pointName)); break; case AspectContainer::PROPERTY_PREFIX: $aopChild->interceptProperty($parent->getProperty($pointName)); break; case AspectContainer::INTRODUCTION_TRAIT_PREFIX: /** @var $value IntroductionInfo */ foreach ($value->getInterfaces() as $interface) { $aopChild->addInterface($interface); } foreach ($value->getTraits() as $trait) { $aopChild->addTrait($trait); } break; default: throw new \InvalidArgumentException("Unsupported point `$type`"); } } } return $aopChild; } /** * Inject advices into given class * * NB This method will be used as a callback during source code evaluation to inject joinpoints * * @param string $aopChildClass Aop child proxy class * * @return void */ public static function injectJoinpoints($aopChildClass, array $advices = array()) { if (!$advices) { $container = AspectKernel::getInstance()->getContainer(); $advices = $container->getAdvicesForClass($aopChildClass); } $aopChildClass = new ReflectionClass($aopChildClass); $joinPoints = static::wrapWithJoinPoints($advices, $aopChildClass->getParentClass()->name); /** @var $prop Property */ $prop = $aopChildClass->getProperty('__joinPoints'); $prop->setAccessible(true); $prop->setValue($joinPoints); } /** * Wrap advices with joinpoint object * * @param array|Advice[] $classAdvices Advices for specific class * @param string $className Name of the original class to use * * @return array|Joinpoint[] returns list of joinpoint ready to use */ protected static function wrapWithJoinPoints($classAdvices, $className) { $joinpoints = array(); foreach ($classAdvices as $name => $advices) { list ($joinPointType, $joinPointName) = explode(':', $name); switch ($joinPointType) { case AspectContainer::METHOD_PREFIX: if (IS_MODERN_PHP) { $joinpoint = new ClosureDynamicMethodInvocation($className, $joinPointName, $advices); } else { $joinpoint = new ReflectionMethodInvocation($className, $joinPointName, $advices); } break; case AspectContainer::STATIC_METHOD_PREFIX: if (IS_MODERN_PHP) { $joinpoint = new ClosureStaticMethodInvocation($className, $joinPointName, $advices); } else { $joinpoint = new ReflectionMethodInvocation($className, $joinPointName, $advices); } break; case AspectContainer::PROPERTY_PREFIX: $joinpoint = new ClassFieldAccess($className, $joinPointName, $advices); break; case AspectContainer::INTRODUCTION_TRAIT_PREFIX: continue; default: throw new UnexpectedValueException("Invalid joinpoint `{$joinPointType}` type. Not yet supported."); } $joinpoints[$name] = $joinpoint; } return $joinpoints; } /** * Adds a definition for joinpoints private property in the class * * @return void */ protected function addJoinpointsProperty() { $this->setProperty( Property::IS_PRIVATE | Property::IS_STATIC, '__joinPoints', 'array()' ); } /** * Override parent method with joinpoint invocation * * @param ReflectionMethod|ParsedReflectionMethod $method Method reflection */ protected function overrideMethod($method) { // temporary disable override of final methods if (!$method->isFinal() && !$method->isAbstract()) { $this->override($method->name, $this->getJoinpointInvocationBody($method)); } } /** * Creates definition for method body * * @param ReflectionMethod|ParsedReflectionMethod $method Method reflection * * @return string new method body */ protected function getJoinpointInvocationBody($method) { $isStatic = $method->isStatic(); $scope = $isStatic ? 'get_called_class()' : '$this'; $prefix = $isStatic ? AspectContainer::STATIC_METHOD_PREFIX : AspectContainer::METHOD_PREFIX; $args = join(', ', array_map(function ($param) { /** @var $param ReflectionParameter|ParsedReflectionParameter */ $byReference = $param->isPassedByReference() ? '&' : ''; return $byReference . '$' . $param->name; }, $method->getParameters())); $args = $scope . ($args ? ", array($args)" : ''); $body = "return self::\$__joinPoints['{$prefix}:{$method->name}']->__invoke($args);"; return $body; } /** * Makes property intercepted * * @param Property|ParsedReflectionProperty $property Reflection of property to intercept */ protected function interceptProperty($property) { $this->interceptedProperties[] = is_object($property) ? $property->name : $property; $this->isFieldsIntercepted = true; } public function __toString() { $ctor = $this->class->getConstructor(); if ($this->isFieldsIntercepted && (!$ctor || !$ctor->isPrivate())) { $this->addFieldInterceptorsCode($ctor); } $self = get_called_class(); $serialized = serialize($this->advices); return parent::__toString() // Inject advices on call . PHP_EOL . '\\' . $self . "::injectJoinpoints('" . $this->class->name . "', unserialize('{$serialized}'));"; } /** * Add code for intercepting properties * * @param null|ReflectionMethod|ParsedReflectionMethod $constructor Constructor reflection or null */ protected function addFieldInterceptorsCode($constructor = null) { $this->setProperty(Property::IS_PRIVATE, '__properties', 'array()'); $this->setMethod(ReflectionMethod::IS_PUBLIC, '__get', $this->getMagicGetterBody(), '$name'); $this->setMethod(ReflectionMethod::IS_PUBLIC, '__set', $this->getMagicSetterBody(), '$name, $value'); $this->isFieldsIntercepted = true; if ($constructor) { $this->override('__construct', $this->getConstructorBody($constructor, true)); } else { $this->setMethod( ReflectionMethod::IS_PUBLIC, '__construct', $this->getConstructorBody($constructor, false), '' ); } } /** * Returns a code for magic getter to perform interception * * @return string */ private function getMagicGetterBody() { return <<<'GETTER' if (array_key_exists($name, $this->__properties)) { return self::$__joinPoints["prop:$name"]->__invoke( $this, \Go\Aop\Intercept\FieldAccess::READ, $this->__properties[$name] ); } elseif (method_exists(get_parent_class(), __FUNCTION__)) { return parent::__get($name); } else { trigger_error("Trying to access undeclared property {$name}"); return null; } GETTER; } /** * Returns a code for magic setter to perform interception * * @return string */ private function getMagicSetterBody() { return <<<'SETTER' if (array_key_exists($name, $this->__properties)) { $this->__properties[$name] = self::$__joinPoints["prop:$name"]->__invoke( $this, \Go\Aop\Intercept\FieldAccess::WRITE, $this->__properties[$name], $value ); } elseif (method_exists(get_parent_class(), __FUNCTION__)) { parent::__set($name, $value); } else { $this->$name = $value; } SETTER; } /** * Returns constructor code * * @param ParsedReflectionMethod|ReflectionMethod|null $constructor Constructor reflection * @param bool $isCallParent Is there is a need to call parent code * * @return string */ private function getConstructorBody($constructor, $isCallParent) { $assocProperties = array(); $listProperties = array(); foreach ($this->interceptedProperties as $propertyName) { $assocProperties[] = "'$propertyName' => \$this->$propertyName"; $listProperties[] = "\$this->$propertyName"; } $assocProperties = $this->indent(join(',' . PHP_EOL, $assocProperties)); $listProperties = $this->indent(join(',' . PHP_EOL, $listProperties)); if (isset($this->methodsCode['__construct'])) { $parentCall = $this->getJoinpointInvocationBody($constructor); } elseif ($isCallParent) { $parentCall = "call_user_func_array(array('parent', __FUNCTION__), func_get_args());"; } else { $parentCall = ''; } return <<__properties = array( $assocProperties ); unset( $listProperties ); $parentCall CTOR; } } src/Go/Aop/Support/DeclareParentsAdvisor.php000064400000006706144760123700015045 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use InvalidArgumentException; use ReflectionClass; use Go\Aop\Advice; use Go\Aop\ClassFilter; use Go\Aop\IntroductionInfo; use Go\Aop\IntroductionAdvisor; /** * Introduction advisor delegating to the given object. */ class DeclareParentsAdvisor implements IntroductionAdvisor { /** * @var null|IntroductionInfo */ private $advice = null; /** * Type pattern the introduction is restricted to * * @var ClassFilter */ private $classFilter; /** * Create a DefaultIntroductionAdvisor for the given advice. */ public function __construct(ClassFilter $classFilter, IntroductionInfo $info) { $this->classFilter = $classFilter; $this->advice = $info; } /** * Can the advised interfaces be implemented by the introduction advice? * * Invoked before adding an IntroductionAdvisor. * * @return void * @throws \InvalidArgumentException if the advised interfaces can't be implemented by the introduction advice */ public function validateInterfaces() { $refInterface = new ReflectionClass(reset($this->advice->getInterfaces())); $refImplementation = new ReflectionClass(reset($this->advice->getTraits())); if (!$refInterface->isInterface()) { throw new \InvalidArgumentException("Only interface can be introduced"); } if (!$refImplementation->isTrait()) { throw new \InvalidArgumentException("Only trait can be used as implementation"); } foreach($refInterface->getMethods() as $interfaceMethod) { if (!$refImplementation->hasMethod($interfaceMethod->name)) { throw new \DomainException("Implementation requires method {$interfaceMethod->name}"); } } } /** * Returns an advice to apply * * @return Advice|IntroductionInfo|null */ public function getAdvice() { return $this->advice; } /** * Return whether this advice is associated with a particular instance or shared with all instances * of the advised class * * @return bool Whether this advice is associated with a particular target instance */ public function isPerInstance() { return false; } /** * Return the filter determining which target classes this introduction should apply to. * * This represents the class part of a pointcut. Note that method matching doesn't make sense to introductions. * * @return ClassFilter The class filter */ public function getClassFilter() { return $this->classFilter; } /** * Set the class filter for advisor * * @param ClassFilter $classFilter Filter for classes */ public function setClassFilter(ClassFilter $classFilter) { $this->classFilter = $classFilter; } /** * Return string representation of object * * @return string */ public function __toString() { $adviceClass = get_class($this->advice); $interfaceClasses = join(',', $this->advice->getInterfaces()); return get_called_class() . ": advice [{$adviceClass}]; interfaces [{$interfaceClasses}] "; } } src/Go/Aop/Support/DefaultIntroductionAdvisor.php000064400000011026144760123700016126 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use InvalidArgumentException; use ReflectionClass; use Go\Aop\Advice; use Go\Aop\ClassFilter; use Go\Aop\IntroductionInfo; use Go\Aop\IntroductionAdvisor; use TokenReflection\ReflectionClass as ParsedReflectionClass; /** * Convenient Pointcut-driven Advisor implementation. * * This is the most commonly used Advisor implementation. It can be used with any pointcut and advice type, * except for introductions. There is normally no need to subclass this class, or to implement custom Advisors. */ class DefaultIntroductionAdvisor implements IntroductionAdvisor, ClassFilter { /** * @var null|Advice */ private $advice = null; /** * List of introduced interfaces * * @var array|string[] */ private $interfaces = array(); /** * Create a DefaultIntroductionAdvisor for the given advice. * * @param Advice $advice The Advice to apply * @param IntroductionInfo|null $introductionInfo IntroductionInfo that describes the interface to introduce */ public function __construct(Advice $advice, IntroductionInfo $introductionInfo = null) { $this->advice = $advice; if ($introductionInfo !== null) { $interfaces = $introductionInfo->getInterfaces(); foreach ($interfaces as $interface) { $this->addInterface($interface); } } } /** * Add the specified interface to the list of interfaces to introduce. * * @param string|ReflectionClass|ParsedReflectionClass $interface The interface to introduce * * @throws \InvalidArgumentException If interface is invalid */ public function addInterface($interface) { assert('!empty($interface); /* Interface must not be empty */'); if ($interface instanceof ReflectionClass || $interface instanceof ParsedReflectionClass) { if ($interface->isInterface()) { $errorMessage = "Specified class [" . $interface->name . "] must be an interface"; throw new InvalidArgumentException($errorMessage); } } $interfaceName = is_object($interface) ? $interface->name : $interface; $this->interfaces[] = $interfaceName; } /** * Return the additional interfaces introduced by this Advisor or Advice. * * @return array|string[] the introduced interfaces */ public function getInterfaces() { return $this->interfaces; } /** * Can the advised interfaces be implemented by the introduction advice? * * Invoked before adding an IntroductionAdvisor. * * @return void * @throws \InvalidArgumentException if the advised interfaces can't be implemented by the introduction advice */ public function validateInterfaces() { // TODO: Advice contains link to the trait, so need to check that all methods from interfaces are present in the trait } /** * Returns an advice to apply * * @return Advice|null */ public function getAdvice() { return $this->advice; } /** * Return whether this advice is associated with a particular instance or shared with all instances * of the advised class * * @return bool Whether this advice is associated with a particular target instance */ public function isPerInstance() { return true; } /** * Return the filter determining which target classes this introduction should apply to. * * This represents the class part of a pointcut. Note that method matching doesn't make sense to introductions. * * @return ClassFilter The class filter */ public function getClassFilter() { return $this; } /** * Performs matching of point of code * * @param mixed $point Specific part of code, can be any Reflection class * * @return bool */ public function matches($point) { return true; } /** * Return string representation of object * * @return string */ public function __toString() { $adviceClass = get_class($this->getAdvice()); $interfaceClasses = join(', ', $this->interfaces); return get_called_class() . ": advice [{$adviceClass}]; interfaces [{$interfaceClasses}] "; } } src/Go/Aop/Support/DefaultPointcutAdvisor.php000064400000003634144760123700015260 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Go\Aop\Advice; use Go\Aop\Pointcut; use Go\Aop\TruePointcut; /** * Convenient Pointcut-driven Advisor implementation. * * This is the most commonly used Advisor implementation. It can be used with any pointcut and advice type, * except for introductions. There is normally no need to subclass this class, or to implement custom Advisors. */ class DefaultPointcutAdvisor extends AbstractGenericPointcutAdvisor { /** * Pointcut instance * * @var Pointcut */ private $pointcut; /** * Create a DefaultPointcutAdvisor, specifying Pointcut and Advice. * * @param Pointcut $pointcut The Pointcut targeting the Advice * @param Advice $advice The Advice to run when Pointcut matches */ public function __construct(Pointcut $pointcut, Advice $advice) { $this->pointcut = $pointcut; $this->setAdvice($advice); } /** * Get the Pointcut that drives this advisor. * * @return Pointcut The pointcut */ public function getPointcut() { return $this->pointcut ?: TruePointcut::getInstance(); } /** * Specify the pointcut targeting the advice. * * @param Pointcut $pointcut The Pointcut targeting the Advice */ public function setPointcut(Pointcut $pointcut) { $this->pointcut = $pointcut; } /** * Return string representation of object * * @return string */ public function __toString() { $pointcutClass = get_class($this->getPointcut()); $adviceClass = get_class($this->getAdvice()); return get_called_class() . ": pointcut [{$pointcutClass}]; advice [{$adviceClass}]"; } } src/Go/Aop/Support/DynamicMethodMatcher.php000064400000001541144760123700014642 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflector; use ReflectionMethod; use Go\Aop\MethodMatcher; /** * Convenient abstract superclass for dynamic method matchers, which do care about arguments at runtime. */ abstract class DynamicMethodMatcher implements MethodMatcher { /** * Is this MethodMatcher dynamic or static * * Can be invoked when an AOP proxy is created, and need not be invoked again before each method invocation * * @return bool whether or not a runtime match via the 3-arg matches() method is required if static matching passed */ public final function isRuntime() { return true; } } src/Go/Aop/Support/DynamicMethodMatcherPointcut.php000064400000002751144760123700016374 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Go\Aop\MethodMatcher; use Go\Aop\Pointcut; use Go\Aop\ClassFilter; use Go\Aop\PointFilter; use Go\Aop\TrueClassFilter; /** * Convenient superclass when we want to force subclasses to implement MethodMatcher interface, * but subclasses will want to be pointcuts. * * The getClassFilter() method can be overriden to customize ClassFilter behaviour as well. */ abstract class DynamicMethodMatcherPointcut extends DynamicMethodMatcher implements Pointcut { /** * Filter for class * * @var null|ClassFilter */ private $classFilter = null; /** * Set the ClassFilter to use for this pointcut. * * @param ClassFilter $classFilter */ public function setClassFilter(ClassFilter $classFilter) { $this->classFilter = $classFilter; } /** * Return the ClassFilter for this pointcut. * * @return ClassFilter */ public function getClassFilter() { if (!$this->classFilter) { $this->classFilter = TrueClassFilter::getInstance(); } return $this->classFilter; } /** * Return the PointFilter for this pointcut. * * @return PointFilter */ public function getPointFilter() { return $this; } } src/Go/Aop/Support/InheritanceClassFilter.php000064400000002345144760123700015201 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionClass; use Go\Aop\ClassFilter; use TokenReflection\ReflectionClass as ParsedReflectionClass; /** * Inheritance class matcher that match single class name or any subclass */ class InheritanceClassFilter implements ClassFilter { /** * Instance class name to match * * @var string */ protected $parentClass = ''; /** * Inheritance class matcher constructor * * @param string $parentClassName Name of the parent class or interface to match */ public function __construct($parentClassName) { $this->parentClass = $parentClassName; } /** * {@inheritdoc} */ public function matches($class) { /** @var $point ReflectionClass|ParsedReflectionClass */ if (!$class instanceof ReflectionClass && !$class instanceof ParsedReflectionClass) { return false; } return $class->isSubclassOf($this->parentClass) || $class->implementsInterface($this->parentClass); } } src/Go/Aop/Support/NameMatchMethodPointcut.php000064400000006514144760123700015342 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflector; use ReflectionClass; use ReflectionMethod; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; use Go\Aop\MethodMatcher; use Go\Aop\Pointcut; use Go\Aop\ClassFilter; use Go\Aop\PointFilter; /** * Pointcut class for simple method name matches, as alternative to regexp patterns. * * Does not handle overloaded methods: all methods *with a given name will be eligible. */ class NameMatchMethodPointcut extends StaticMethodMatcherPointcut { /** * List of mapped names * * @var array|string[] */ private $mappedNames = array(); /** * Convenience method when we have only a single method name to match. * * Use either this method or setMappedNames, not both. * * @param string $mappedName Name of the additional method that will match */ public function setMappedName($mappedName) { $this->setMappedNames(array($mappedName)); } /** * Set the method names defining methods to match. * * Matching will be the union of all these; if any match, the pointcut matches. * * @param array|string[] $mappedNames List of methods that will match */ public function setMappedNames(array $mappedNames) { assert('!empty($mappedNames); /* mappedNames can not be empty */'); $this->mappedNames = array_map('trim', $mappedNames); } /** * Add another eligible method name, in addition to those already named. * * Like the set methods, this method is for use when configuring proxies, before a proxy is used. * * @param string $name Name of the additional method that will match * * @return NameMatchMethodPointcut */ public function addMethodName($name) { assert('!empty($name); /* name can not be empty */'); $this->mappedNames[] = trim($name); return $this; } /** * {@inheritdoc} */ public function matches($method, $targetClass = null, array $args = null) { /** @var $method ReflectionMethod|ParsedReflectionMethod */ if (!$method instanceof ReflectionMethod && !$method instanceof ParsedReflectionMethod) { return false; } $methodName = $method->name; foreach ($this->mappedNames as $mappedName) { if ($mappedName === $methodName || $this->isMatch($methodName, $mappedName)) { return true; } } return false; } /** * Return if the given method name matches the mapped name. * * The default implementation checks for "xxx*", "*xxx" and "*xxx*" matches, as well as direct equality. * Can be overridden in subclasses. * * @param string $methodName The method name of the class * @param string $mappedName The name in the descriptor * * @return bool If the names match */ protected function isMatch($methodName, $mappedName) { $regexp = strtr(preg_quote($mappedName, '/'), array( '\\*' => '.*?', '\\?' => '.' )); return (bool) preg_match("/^{$regexp}$/i", $methodName); } } src/Go/Aop/Support/RegexpMethodPointcut.php000064400000010352144760123700014732 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflector; use ReflectionClass; use ReflectionMethod; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; use TokenReflection\ReflectionClass as ParsedReflectionClass; use Go\Aop\MethodMatcher; use Go\Aop\Pointcut; use Go\Aop\ClassFilter; use Go\Aop\PointFilter; /** * Convenient abstract superclass for static method matchers, which don't care about arguments at runtime. * * The "classFilter" property can be set to customize ClassFilter behavior. */ class RegexpMethodPointcut extends StaticMethodMatcherPointcut { /** * Regular expressions to match * * @var array|string[] */ private $patterns = array(); /** * Regular expressions not to match * * @var array */ private $excludedPatterns = array(); /** * Convenience method when we have only a single pattern. * * Use either this method or setPatterns(), not both. * * @param string $pattern Regular expressions to match */ public function setPattern($pattern) { $this->setPatterns(array($pattern)); } /** * Set the regular expressions defining methods to match. * * Matching will be the union of all these; if any match, the pointcut matches. * * @param array|string[] $patterns List of patterns */ public function setPatterns(array $patterns) { assert('!empty($patterns); /* patterns can not be empty */'); $this->patterns = array_map('trim', $patterns); } /** * Return the regular expressions for method matching. * * @return array|string[] List of patterns */ public function getPatterns() { return $this->patterns; } /** * Convenience method when we have only a single exclusion pattern. * * @param string $pattern Pattern to exclude */ public function setExcludedPattern($pattern) { $this->setExcludedPatterns(array($pattern)); } /** * Set the regular expressions defining methods to match for exclusion. * * @param array|string[] $patterns List of patterns */ public function setExcludedPatterns(array $patterns) { assert('!empty($patterns); /* patterns can not be empty */'); $this->excludedPatterns = array_map('trim', $patterns); } /** * Returns the regular expressions for exclusion matching. * * @return array|string[] List of patterns */ public function getExcludedPatterns() { return $this->excludedPatterns; } /** * Perform checking whether the given method matches. * * If this returns false or if the isRuntime() method returns false, no runtime check * (i.e. no. matches(ReflectionMethod, ReflectionClass, $args) call) will be made. * * @param ReflectionMethod|ParsedReflectionMethod $method The candidate method * @param ReflectionClass|ParsedReflectionClass $targetClass The target class * (may be null, in which case the candidate class must be taken to be the method's declaring class) * @param array $args Arguments to the method * (may be null, for statical matching) * * @return bool whether or not this method matches */ public function matches($method, $targetClass = null, array $args = null) { if (!$method instanceof ReflectionMethod && !$method instanceof ParsedReflectionMethod) { return false; } /** @var $methodClass ReflectionClass */ $methodClass = $targetClass ?: $method->getDeclaringClass(); $methodHash = $methodClass->name . "->" . $method->name; foreach ($this->patterns as $pattern) { if (preg_match("/^{$pattern}$/i", $methodHash)) { foreach ($this->excludedPatterns as $excludePattern) { if (preg_match("/^{$excludePattern}$/i", $methodHash)) { return false; } } return true; } } return false; } } src/Go/Aop/Support/RootClassFilter.php000064400000002340144760123700013666 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflector; use ReflectionClass; use TokenReflection\ReflectionClass as ParsedReflectionClass; use Go\Aop\ClassFilter; /** * Simple ClassFilter implementation that passes classes (and optionally subclasses) */ class RootClassFilter implements ClassFilter { /** * Class name * * @var string */ protected $className = null; /** * Class constructor * * @param string $className */ public function __construct($className) { $this->className = $className; } /** * Performs matching of class * * @param ReflectionClass|ParsedReflectionClass $class Class instance * * @return bool */ public function matches($class) { if (!$class instanceof ReflectionClass && !$class instanceof ParsedReflectionClass) { return false; } $isCurrentClass = $class->name == $this->className; return $isCurrentClass || $class->isSubclassOf($this->className); } } src/Go/Aop/Support/SignatureMethodPointcut.php000064400000004367144760123700015452 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionMethod; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; /** * Signature method pointcut checks method signature (modifiers and name) to match it */ class SignatureMethodPointcut extends StaticMethodMatcherPointcut { /** * Method name to match, can contain wildcards *,? * * @var string */ protected $methodName = ''; /** * Modifier mask for method * * @var string */ protected $modifier; /** * Bit mask: * * const IS_STATIC = 1 * const IS_ABSTRACT = 2 * const IS_FINAL = 4 * const IS_PUBLIC = 256 * const IS_PROTECTED = 512 * const IS_PRIVATE = 1024 * * @var integer|null */ protected static $bitMask = 0x0701; // STATIC + PUBLIC + PROTECTED + PRIVATE /** * Signature method matcher constructor * * @param string $methodName Name of the method to match or glob pattern * @param integer $modifier Method modifier (mask of reflection constant modifiers) */ public function __construct($methodName, $modifier) { $this->methodName = $methodName; $this->regexp = strtr(preg_quote($this->methodName, '/'), array( '\\*' => '.*?', '\\?' => '.' )); $this->modifier = $modifier; } /** * Performs matching of point of code * * @param mixed $method Specific part of code, can be any Reflection class * * @return bool */ public function matches($method) { /** @var $method ReflectionMethod|ParsedReflectionMethod */ if (!$method instanceof ReflectionMethod && !$method instanceof ParsedReflectionMethod) { return false; } $modifiers = $method->getModifiers(); if (!($modifiers & $this->modifier) || ((self::$bitMask - $this->modifier) & $modifiers)) { return false; } return ($method->name === $this->methodName) || (bool) preg_match("/^{$this->regexp}$/i", $method->name); } } src/Go/Aop/Support/SignaturePropertyPointcut.php000064400000006164144760123700016053 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Reflector; use ReflectionClass; use ReflectionProperty; use TokenReflection\ReflectionProperty as ParsedReflectionProperty; use Go\Aop\PropertyMatcher; use Go\Aop\Pointcut; use Go\Aop\ClassFilter; use Go\Aop\PointFilter; use Go\Aop\TrueClassFilter; /** * Signature property pointcut checks the property signature (modifiers and name) to match it */ class SignaturePropertyPointcut implements Pointcut, PropertyMatcher { /** * Filter for class * * @var null|ClassFilter */ private $classFilter = null; /** * Property name to match, can contain wildcards *,? * * @var string */ protected $propertyName = ''; /** * Modifier mask for property * * @var string */ protected $modifier; /** * Bit mask: * * const IS_STATIC = 1; * const IS_PUBLIC = 256; * const IS_PROTECTED = 512; * const IS_PRIVATE = 1024; * * @var integer|null */ protected static $bitMask = 0x0701; /** * Signature property matcher constructor * * @param string $propertyName Name of the property to match or glob pattern * @param integer $modifier Method modifier (mask of reflection constant modifiers) */ public function __construct($propertyName, $modifier) { $this->propertyName = $propertyName; $this->regexp = strtr(preg_quote($this->propertyName, '/'), array( '\\*' => '.*?', '\\?' => '.' )); $this->modifier = $modifier; } /** * Return the PointFilter for this pointcut. * * @return PointFilter */ public function getPointFilter() { return $this; } /** * Set the ClassFilter to use for this pointcut. * * @param ClassFilter $classFilter */ public function setClassFilter(ClassFilter $classFilter) { $this->classFilter = $classFilter; } /** * Return the ClassFilter for this pointcut. * * @return ClassFilter */ public function getClassFilter() { if (!$this->classFilter) { $this->classFilter = TrueClassFilter::getInstance(); } return $this->classFilter; } /** * Performs matching of point of code * * @param mixed $property * * @return bool */ public function matches($property) { /** @var $property ReflectionProperty|ParsedReflectionProperty */ if (!$property instanceof ReflectionProperty && !$property instanceof ParsedReflectionProperty) { return false; } $modifiers = $property->getModifiers(); if (!($modifiers & $this->modifier) || ((self::$bitMask - $this->modifier) & $modifiers)) { return false; } return ($property->name === $this->propertyName) || (bool) preg_match("/^{$this->regexp}$/i", $property->name); } } src/Go/Aop/Support/SimpleClassFilter.php000064400000002662144760123700014203 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionClass; use Go\Aop\ClassFilter; use TokenReflection\ReflectionClass as ParsedReflectionClass; /** * Simple class matcher that match only single class name * * Class name can contain wildcards '*', '**' and '?' */ class SimpleClassFilter implements ClassFilter { /** * Class name to match, can contain wildcards *,? * * @var string */ protected $className = ''; /** * Class name matcher constructor * * @param string $className Name of the class to match or glob pattern */ public function __construct($className) { $this->className = $className; $this->regexp = strtr(preg_quote($this->className, '/'), array( '\\*' => '[^\\\\]+', '\\*\\*' => '.+', '\\?' => '.' )); } /** * {@inheritdoc} */ public function matches($class) { /** @var $point ReflectionClass|ParsedReflectionClass */ if (!$class instanceof ReflectionClass && !$class instanceof ParsedReflectionClass) { return false; } return ($class->name === $this->className) || (bool) preg_match("/^{$this->regexp}$/i", $class->name); } } src/Go/Aop/Support/StaticMethodMatcher.php000064400000001475144760123700014513 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Go\Aop\MethodMatcher; /** * Convenient abstract superclass for static method matchers, which don't care about arguments at runtime. */ abstract class StaticMethodMatcher implements MethodMatcher { /** * Is this MethodMatcher dynamic or static * * Can be invoked when an AOP proxy is created, and need not be invoked again before each method invocation * * @return bool whether or not a runtime match via the 3-arg matches() method is required if static matching passed */ public final function isRuntime() { return false; } } src/Go/Aop/Support/StaticMethodMatcherPointcut.php000064400000002665144760123700016243 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use Go\Aop\MethodMatcher; use Go\Aop\Pointcut; use Go\Aop\ClassFilter; use Go\Aop\PointFilter; use Go\Aop\TrueClassFilter; /** * Convenient abstract superclass for static method matchers, which don't care about arguments at runtime. * * The "classFilter" property can be set to customize ClassFilter behavior. */ abstract class StaticMethodMatcherPointcut extends StaticMethodMatcher implements Pointcut { /** * Filter for class * * @var null|ClassFilter */ private $classFilter = null; /** * Set the ClassFilter to use for this pointcut. * * @param ClassFilter $classFilter */ public function setClassFilter(ClassFilter $classFilter) { $this->classFilter = $classFilter; } /** * Return the ClassFilter for this pointcut. * * @return ClassFilter */ public function getClassFilter() { if (!$this->classFilter) { $this->classFilter = TrueClassFilter::getInstance(); } return $this->classFilter; } /** * Return the PointFilter for this pointcut. * * @return PointFilter */ public function getPointFilter() { return $this; } } src/Go/Aop/Support/WithinMethodPointcut.php000064400000003140144760123700014737 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop\Support; use ReflectionMethod; use Go\Aop\Support\SimpleClassFilter; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; /** * Within method pointcut matches all methods in specific class or namespace */ class WithinMethodPointcut extends StaticMethodMatcherPointcut { /** * Within method matcher constructor * * @param string $className Name of the class or namespace pattern to match * @param integer $modifier Method modifier (mask of reflection constant modifiers) */ public function __construct($className, $withChildren = false) { if (!$withChildren) { $this->setClassFilter(new SimpleClassFilter($className)); } elseif (strpos($className, '*') === false) { $this->setClassFilter(new InheritanceClassFilter($className)); } else { throw new \InvalidArgumentException("Can not use children selector with class mask"); } } /** * Performs matching of point of code * * @param mixed $method Specific part of code, can be any Reflection class * * @return bool */ public function matches($method) { /** @var $method ReflectionMethod|ParsedReflectionMethod */ if (!$method instanceof ReflectionMethod && !$method instanceof ParsedReflectionMethod) { return false; } return true; } } src/Go/Aop/TrueClassFilter.php000064400000002150144760123700012205 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use Reflector; use ReflectionClass; use TokenReflection\ReflectionClass as ParsedReflectionClass; use Go\Aop\ClassFilter; /** * Canonical ClassFilter instance that matches all classes. */ class TrueClassFilter implements ClassFilter { /** * Private class constructor */ private function __construct() { } /** * Singleton pattern * * @return TrueClassFilter */ public static function getInstance() { static $instance = null; if (!$instance) { $instance = new self(); } return $instance; } /** * Performs matching of class * * @param ReflectionClass|ParsedReflectionClass $class Class instance * * @return bool */ public function matches($class) { // Is check for a ReflectionClass class is needed here? return true; } } src/Go/Aop/TruePointFilter.php000064400000001666144760123700012244 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Canonical PointFilter instance that matches all points. */ class TruePointFilter implements PointFilter { /** * Private class constructor */ private function __construct() { } /** * Singleton pattern * * @return TruePointFilter */ public static function getInstance() { static $instance = null; if (!$instance) { $instance = new self(); } return $instance; } /** * Performs matching of point of code * * @param mixed $point Specific part of code, can be any Reflection class * * @return bool */ public function matches($point) { return true; } } src/Go/Aop/TruePointcut.php000064400000002326144760123700011604 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; use Go\Aop\TrueClassFilter; use Go\Aop\TruePointFilter; /** * Canonical Pointcut instance that always matches. * * @package go * @subpackage aop */ class TruePointcut implements Pointcut { /** * Private class constructor */ private function __construct() { } /** * Singleton pattern * * @return TruePointcut */ public static function getInstance() { static $instance = null; if (!$instance) { $instance = new self(); } return $instance; } /** * Return the ClassFilter for this pointcut. * * @return ClassFilter */ public function getClassFilter() { return TrueClassFilter::getInstance(); } /** * Return the PointFilter for this pointcut. * * This can be method filter, property filter. * * @return PointFilter */ public function getPointFilter() { return TruePointFilter::getInstance(); } } src/Go/Core/AspectContainer.php000064400000023130144760123700012366 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use ReflectionClass; use ReflectionMethod; use ReflectionProperty; use Go\Aop; use TokenReflection\ReflectionClass as ParsedReflectionClass; /** * Aspect container contains list of all pointcuts and advisors */ class AspectContainer { /** * Prefix for properties interceptor */ const PROPERTY_PREFIX = "prop"; /** * Prefix for method interceptor */ const METHOD_PREFIX = "method"; /** * Prefix for static method interceptor */ const STATIC_METHOD_PREFIX = "static"; /** * Trait introduction prefix */ const INTRODUCTION_TRAIT_PREFIX = "introduction"; /** * Suffix, that will be added to all proxied class names */ const AOP_PROXIED_SUFFIX = '__AopProxied'; /** * List of named pointcuts in the container * * @var array|Aop\Pointcut[] */ protected $pointcuts = array(); /** * List of named and indexed advisors in the container * * @var array|Aop\Advisor[] */ protected $advisors = array(); /** * List of services in the container * * @var array|object[] */ protected $services = array(); /** * List of registered aspects * * @var array */ protected $aspects = array(); /** * List of resources for application * * @var array */ protected $resources = array(); /** * Cached timestamp for resources * * @var integer */ protected $maxTimestamp = 0; /** * Set a service into the container * * @param string $id Key for service * @param object $service Service to store */ public function set($id, $service) { $this->services[$id] = $service; } /** * Return a service from the container * * @param string $id Service key * * @return object * @throws \OutOfBoundsException if service was not found */ public function get($id) { if (is_numeric($id) || !isset($this->services[$id])) { throw new \OutOfBoundsException("Unknown service {$id}"); } return $this->services[$id]; } /** * Returns a pointcut by identifier * * @param string $id Pointcut identifier * * @return Aop\Pointcut * * @throws \OutOfBoundsException if pointcut key is invalid */ public function getPointcut($id) { if (is_numeric($id) || !isset($this->pointcuts[$id])) { throw new \OutOfBoundsException("Unknown pointcut {$id}"); } return $this->pointcuts[$id]; } /** * Store the pointcut in the container * * @param Aop\Pointcut $pointcut Instance * @param string $id Key for pointcut */ public function registerPointcut(Aop\Pointcut $pointcut, $id = null) { if ($id) { $this->pointcuts[$id] = $pointcut; } else { $this->pointcuts[] = $pointcut; } } /** * Returns an advisor by identifier * * @param string $id Advisor identifier * * @return Aop\Advisor * * @throws \OutOfBoundsException if advisor key is invalid */ public function getAdvisor($id) { if (is_numeric($id) || !isset($this->advisors[$id])) { throw new \OutOfBoundsException("Unknown advisor {$id}"); } return $this->advisors[$id]; } /** * Store the advisor in the container * * @param Aop\Advisor $advisor Instance * @param string $id Key for advisor */ public function registerAdvisor(Aop\Advisor $advisor, $id = null) { if ($id) { $this->advisors[$id] = $advisor; } else { $this->advisors[] = $advisor; } } /** * Returns an aspect by id or class name * * @param string $aspectName Aspect name * * @throws \OutOfBoundsException If aspect is unknown * * @return Aop\Aspect */ public function getAspect($aspectName) { if (!isset($this->aspects[$aspectName])) { throw new \OutOfBoundsException("Unknown aspect {$aspectName}"); } return $this->aspects[$aspectName]; } /** * Register an aspect in the container * * @param Aop\Aspect $aspect Instance of concrete aspect * @param string $id Key for aspect * * @throws \LogicException if aspect was already registered */ public function registerAspect(Aop\Aspect $aspect) { $aspectName = get_class($aspect); if (!empty($this->aspects[$aspectName])) { throw new \LogicException("Only one instance of single aspect can be registered at once"); } /** @var $loader AspectLoader */ $loader = $this->get('aspect.loader'); $loader->load($aspect); $this->aspects[$aspectName] = $aspect; } /** * Add an resource for container * * TODO: use symfony/config component for creating the cache * * Resources is used to check the freshness of cache */ public function addResource($resource) { $this->resources[] = $resource; $this->maxTimestamp = 0; } /** * Checks the freshness of container * * @param integer $timestamp * * @return bool Whether or not container is fresh */ public function isFresh($timestamp) { if (!$this->maxTimestamp && $this->resources) { $this->maxTimestamp = max(array_map('filemtime', $this->resources)); } return $this->maxTimestamp < $timestamp; } /** * Return list of advices for class * * @param string|ReflectionClass|ParsedReflectionClass $class Class to advise * * @return array|Aop\Advice[] List of advices for class */ public function getAdvicesForClass($class) { $classAdvices = array(); if (!$class instanceof ReflectionClass && !$class instanceof ParsedReflectionClass) { $class = new ReflectionClass($class); } $parentClass = $class->getParentClass(); if ($parentClass && preg_match('/' . self::AOP_PROXIED_SUFFIX . '$/', $parentClass->name)) { $originalClass = $parentClass; } else { $originalClass = $class; } foreach ($this->advisors as $advisor) { if ($advisor instanceof Aop\PointcutAdvisor) { $pointcut = $advisor->getPointcut(); if ($pointcut->getClassFilter()->matches($class)) { $pointFilter = $pointcut->getPointFilter(); $classAdvices = array_merge_recursive( $classAdvices, $this->getAdvicesFromAdvisor($originalClass, $advisor, $pointFilter) ); } } if ($advisor instanceof Aop\IntroductionAdvisor) { if ($advisor->getClassFilter()->matches($class)) { $classAdvices = array_merge_recursive( $classAdvices, $this->getIntroductionFromAdvisor($originalClass, $advisor) ); } } } return $classAdvices; } /** * Returns list of advices from advisor and point filter * * @param ReflectionClass|ParsedReflectionClass|string $class Class to inject advices * @param Aop\PointcutAdvisor $advisor Advisor for class * @param Aop\PointFilter $filter Filter for points * * @return array */ private function getAdvicesFromAdvisor($class, Aop\PointcutAdvisor $advisor, Aop\PointFilter $filter) { $classAdvices = array(); // Check methods in class only for MethodMatcher filters if ($filter instanceof Aop\MethodMatcher) { $mask = ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_PROTECTED; foreach ($class->getMethods($mask) as $method) { /** @var $method ReflectionMethod| */ if ($method->getDeclaringClass()->name == $class->name && $filter->matches($method)) { $prefix = $method->isStatic() ? self::STATIC_METHOD_PREFIX : self::METHOD_PREFIX; $classAdvices[$prefix . ':'. $method->name][] = $advisor->getAdvice(); } } } // Check properties in class only for PropertyMatcher filters if ($filter instanceof Aop\PropertyMatcher) { $mask = ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED; foreach ($class->getProperties($mask) as $property) { /** @var $property ReflectionProperty */ if ($filter->matches($property)) { $classAdvices[self::PROPERTY_PREFIX.':'.$property->name][] = $advisor->getAdvice(); } } } return $classAdvices; } /** * Returns list of introduction advices from advisor * * @param ReflectionClass|ParsedReflectionClass|string $class Class to inject advices * @param Aop\IntroductionAdvisor $advisor Advisor for class * * @return array */ private function getIntroductionFromAdvisor($class, $advisor) { /** @var $advice Aop\IntroductionInfo */ $advice = $advisor->getAdvice(); return array( self::INTRODUCTION_TRAIT_PREFIX.':'.join(':', $advice->getInterfaces()) => $advice ); } } src/Go/Core/AspectKernel.php000064400000020116144760123700011665 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use Go\Instrument\RawAnnotationReader; use Go\Instrument\ClassLoading\UniversalClassLoader; use Go\Instrument\ClassLoading\SourceTransformingLoader; use Go\Instrument\Transformer\SourceTransformer; use Go\Instrument\Transformer\AopProxyTransformer; use Go\Instrument\Transformer\CachingTransformer; use Go\Instrument\Transformer\FilterInjectorTransformer; use Go\Instrument\Transformer\MagicConstantTransformer; use Doctrine\Common\Annotations\AnnotationReader; use Doctrine\Common\Annotations\AnnotationRegistry; use TokenReflection; /** * Whether or not we have a modern PHP */ define('IS_MODERN_PHP', version_compare(PHP_VERSION, '5.4.0') >= 0); /** * Abstract aspect kernel is used to prepare an application to work with aspects. * * Realization of this class should return the path for application loader, so when the kernel has finished its work, * it will pass the control to the application loader. */ abstract class AspectKernel { /** * Kernel options * * @var array */ protected $options = array(); /** * Single instance of kernel * * @var null|static */ protected static $instance = null; /** * Aspect container instance * * @var null|AspectContainer */ protected $container = null; /** * Protected constructor is used to prevent direct creation, but allows customization if needed */ protected function __construct() {} /** * Returns the single instance of kernel * * @return AspectKernel */ public static function getInstance() { if (!self::$instance) { self::$instance = new static(); } return self::$instance; } /** * Init the kernel and make adjustments * * @param array $options Associative array of options for kernel */ public function init(array $options = array()) { $this->options = array_replace_recursive($this->getDefaultOptions(), $options); $this->initLibraryLoader(); /** @var $container AspectContainer */ $container = $this->container = new $this->options['containerClass']; $container->set('kernel', $this); $sourceLoaderFilter = new SourceTransformingLoader(); $sourceLoaderFilter->register(); foreach ($this->registerTransformers($sourceLoaderFilter) as $sourceTransformer) { $sourceLoaderFilter->addTransformer($sourceTransformer); } // Load application configurator $sourceLoaderFilter->load($this->options['appLoader']); // Register all services in the container $aspectLoader = new AspectLoader($container); $container->set('aspect.loader', $aspectLoader); // TODO: use cached annotation reader $container->set('aspect.annotation.reader', new AnnotationReader()); $container->set('aspect.annotation.raw.reader', new RawAnnotationReader()); // Register general aspect loader extension $aspectLoader->registerLoaderExtension(new GeneralAspectLoaderExtension()); $aspectLoader->registerLoaderExtension(new IntroductionAspectExtension()); // Register kernel resources in the container $this->addKernelResourcesToContainer($container); // Register all AOP configuration in the container $this->configureAop($container); } /** * Returns an aspect container * * @return null|AspectContainer */ public function getContainer() { return $this->container; } /** * Returns default options for kernel * * @return array */ protected function getDefaultOptions() { return array_replace_recursive( $this->options, array( // Configuration for autoload namespaces 'autoload' => array( 'Go' => realpath(__DIR__ . '/../../'), 'TokenReflection' => realpath(__DIR__ . '/../../../vendor/andrewsville/php-token-reflection/'), 'Doctrine\\Common' => realpath(__DIR__ . '/../../../vendor/doctrine/common/lib/') ), //Debug mode 'debug' => false, // Default application directory 'appDir' => __DIR__ . '/../../../', // Cache directory for Go! generated classes 'cacheDir' => __DIR__ . '/../../../cache/', // Include paths for aspect weaving 'includePaths' => array(), // Name of the class for container 'containerClass' => $this->getContainerClassName(), // Application autoloader 'appLoader' => $this->getApplicationLoaderPath(), ) ); } /** * Returns the path to the application autoloader file, typical autoload.php * * @return string */ abstract protected function getApplicationLoaderPath(); /** * Configure an AspectContainer with advisors, aspects and pointcuts * * @param AspectContainer $container * * @return void */ abstract protected function configureAop(AspectContainer $container); /** * Return the name for the container class * * Override this method to extend container with custom container * * NB. If you use a custom class, then you should include it source before starting the kernel or it won't be * found during loading of the kernel. * * @return string */ protected function getContainerClassName() { return __NAMESPACE__ . '\\AspectContainer'; } /** * Returns list of source transformers, that will be applied to the PHP source * * @param SourceTransformingLoader $sourceLoader Instance of source loader for information * * @return array|SourceTransformer[] */ protected function registerTransformers(SourceTransformingLoader $sourceLoader) { $sourceTransformers = array( new FilterInjectorTransformer( $this->options, $sourceLoader->getId() ), new MagicConstantTransformer( $this->options ), new AopProxyTransformer( $this->options, new TokenReflection\Broker( new TokenReflection\Broker\Backend\Memory() ) ) ); return array( new CachingTransformer( $this->options, $sourceTransformers ) ); } /** * Init library autoloader. * * We cannot use any standard autoloaders in the application level because we will rewrite them on fly. * This will also reduce the time for library loading and prevent cyclic errors when source is loaded. */ protected function initLibraryLoader() { /** * Separate class loader for core should be used to load classes, * so UniversalClassLoader is moved to the custom namespace */ require_once __DIR__ . '/../Instrument/ClassLoading/UniversalClassLoader.php'; $loader = new UniversalClassLoader(); $loader->registerNamespaces($this->options['autoload']); $loader->register(); // Configure library loader for doctrine annotation loader AnnotationRegistry::registerLoader(function($class) use ($loader) { $loader->loadClass($class); return class_exists($class, false); }); } /** * Add resources for kernel * * @param AspectContainer $container */ protected function addKernelResourcesToContainer(AspectContainer $container) { $trace = debug_backtrace(); $refClass = new \ReflectionObject($this); $container->addResource($trace[1]['file']); $container->addResource($refClass->getFileName()); } } src/Go/Core/AspectLoader.php000064400000011511144760123700011652 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use Go\Aop\Aspect; /** * Loader of aspects into the container */ class AspectLoader { /** * Aspect container instance * * @var null|AspectContainer */ protected $container = null; /** * List of aspect loaders * * @var array */ protected $loaders = array(); /** * Loader constructor */ public function __construct(AspectContainer $container) { $this->container = $container; } /** * Register an aspect loader extension * * This method allows to extend the logic of aspect loading by registering an extension for loader. * * @param AspectLoaderExtension $loader Loader to register */ public function registerLoaderExtension(AspectLoaderExtension $loader) { $targets = (array) $loader->getTarget(); foreach ($targets as $target) { $this->loaders[$target][] = $loader; } } /** * Loads an aspect into the container with the help of aspect loaders * * @param \Go\Aop\Aspect $aspect */ final public function load(Aspect $aspect) { $refAspect = new \ReflectionClass($aspect); // Register dependency resource for aspect $this->container->addResource($refAspect->getFileName()); if (!empty($this->loaders[AspectLoaderExtension::TARGET_CLASS])) { $this->loadFrom($aspect, $refAspect, $this->loaders[AspectLoaderExtension::TARGET_CLASS]); } if (!empty($this->loaders[AspectLoaderExtension::TARGET_METHOD])) { $refMethods = $refAspect->getMethods(); foreach ($refMethods as $refMethod) { $this->loadFrom($aspect, $refMethod, $this->loaders[AspectLoaderExtension::TARGET_METHOD]); } } if (!empty($this->loaders[AspectLoaderExtension::TARGET_PROPERTY])) { $refProperties = $refAspect->getProperties(); foreach ($refProperties as $refProperty) { $this->loadFrom($aspect, $refProperty, $this->loaders[AspectLoaderExtension::TARGET_PROPERTY]); } } } /** * Load definitions from specific aspect part into the aspect container * * @param Aspect $aspect Aspect instance * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $refPoint Reflection instance * @param array|AspectLoaderExtension[] $loaders List of loaders that can produce advisors from aspect class * * @throws \InvalidArgumentException If kind of loader isn't supported */ protected function loadFrom(Aspect $aspect, $refPoint, array $loaders) { $annotations = $this->getAnnotations($refPoint); foreach ($loaders as $loader) { $loaderKind = $loader->getKind(); switch ($loaderKind) { case AspectLoaderExtension::KIND_REFLECTION: if ($loader->supports($aspect, $refPoint)) { $loader->load($this->container, $aspect, $refPoint); } break; case AspectLoaderExtension::KIND_ANNOTATION: foreach ($annotations as $annotation) { if ($loader->supports($aspect, $refPoint, $annotation)) { $loader->load($this->container, $aspect, $refPoint, $annotation); } } break; default: throw new \InvalidArgumentException("Unsupported loader kind {$loaderKind}"); } } } /** * Return list of annotations for reflection point * * @param \ReflectionClass|\ReflectionMethod|\ReflectionProperty $refPoint Reflection instance * * @return array list of annotations * @throws \InvalidArgumentException if $refPoint is unsupported */ protected function getAnnotations($refPoint) { /** @var $annotationReader \Doctrine\Common\Annotations\Reader */ $annotationReader = $this->container->get('aspect.annotation.reader'); switch (true) { case ($refPoint instanceof \ReflectionClass): return $annotationReader->getClassAnnotations($refPoint); case ($refPoint instanceof \ReflectionMethod): return $annotationReader->getMethodAnnotations($refPoint); case ($refPoint instanceof \ReflectionProperty): return $annotationReader->getPropertyAnnotations($refPoint); default: throw new \InvalidArgumentException("Unsupported reflection point " . get_class($refPoint)); } } } src/Go/Core/AspectLoaderExtension.php000064400000004611144760123700013552 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use Go\Aop\Aspect; /** * Extension interface that defines an API for aspect loaders */ interface AspectLoaderExtension { /** * Loader works with class-level definition of aspect */ const TARGET_CLASS = 'class'; /** * Loader works with method definitions of aspect */ const TARGET_METHOD = 'method'; /** * Loader works with property definitions of aspect */ const TARGET_PROPERTY = 'property'; /** * Loader works only with reflections of aspect class, method or property */ const KIND_REFLECTION = 'reflection'; /** * Loader works with each annotation defined for aspect class, method or property. */ const KIND_ANNOTATION = 'annotation'; /** * Return kind of loader, can be one of KIND_REFLECTION or KIND_ANNOTATION * * For loader that works with annotations additional metaInformation will be passed * * @return string */ public function getKind(); /** * Returns one or more target for loader, see TARGET_XXX constants * * @return string|array */ public function getTarget(); /** * Checks if loader is able to handle specific point of aspect * * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method * * @return boolean true if extension is able to create an advisor from reflection and metaInformation */ public function supports(Aspect $aspect, $reflection, $metaInformation = null); /** * Loads definition from specific point of aspect into the container * * @param AspectContainer $container Instance of container * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method */ public function load(AspectContainer $container, Aspect $aspect, $reflection, $metaInformation = null); } src/Go/Core/GeneralAspectLoaderExtension.php000064400000026371144760123700015057 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use ReflectionMethod; use ReflectionProperty; use Go\Aop\Aspect; use Go\Aop\Framework; use Go\Aop\MethodMatcher; use Go\Aop\PropertyMatcher; use Go\Aop\Support; use Go\Aop\Support\DefaultPointcutAdvisor; use Go\Lang\Annotation; /** * General aspect loader add common support for general advices, declared as annotations */ class GeneralAspectLoaderExtension implements AspectLoaderExtension { /** * Mappings of string values to method modifiers * * @todo: Move to the pointcut parser * @var array */ protected static $methodModifiers = array( 'public' => ReflectionMethod::IS_PUBLIC, 'protected' => ReflectionMethod::IS_PROTECTED, '::' => ReflectionMethod::IS_STATIC, '*' => 768 /* PUBLIC | PROTECTED */, '->' => 0, ); /** * Mappings of string values to property modifiers * * @todo: Move to the pointcut parser * @var array */ protected static $propertyModifiers = array( 'public' => ReflectionProperty::IS_PUBLIC, 'protected' => ReflectionProperty::IS_PROTECTED, '*' => 768 /* PUBLIC | PROTECTED */, ); /** * General aspect loader works with annotations from aspect * * For extension that works with annotations additional metaInformation will be passed * * @return string */ public function getKind() { return self::KIND_ANNOTATION; } /** * General aspect loader works only with methods of aspect * * @return string|array */ public function getTarget() { return self::TARGET_METHOD; } /** * Checks if loader is able to handle specific point of aspect * * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method * * @return boolean true if extension is able to create an advisor from reflection and metaInformation */ public function supports(Aspect $aspect, $reflection, $metaInformation = null) { return $metaInformation instanceof Annotation\Interceptor || $metaInformation instanceof Annotation\Pointcut; } /** * Loads definition from specific point of aspect into the container * * @param AspectContainer $container Instance of container * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method */ public function load(AspectContainer $container, Aspect $aspect, $reflection, $metaInformation = null) { // TODO: use general pointcut parser here instead of hardcoded regular expressions $pointcut = $this->parsePointcut($container, $reflection, $metaInformation); $methodId = sprintf("%s->%s()", $reflection->class, $reflection->name); $adviceCallback = Framework\BaseAdvice::fromAspectReflection($aspect, $reflection); switch (true) { // Register a pointcut by its name case ($metaInformation instanceof Annotation\Pointcut): $container->registerPointcut($pointcut, $methodId); break; case ($pointcut instanceof MethodMatcher): $advice = $this->getMethodInterceptor($metaInformation, $adviceCallback); $container->registerAdvisor(new DefaultPointcutAdvisor($pointcut, $advice), $methodId); break; case ($pointcut instanceof PropertyMatcher): $advice = $this->getPropertyInterceptor($metaInformation, $adviceCallback); $container->registerAdvisor(new DefaultPointcutAdvisor($pointcut, $advice), $methodId); break; default: throw new \UnexpectedValueException("Unsupported pointcut class: " . get_class($pointcut)); } } /** * @param $metaInformation * @param $adviceCallback * @return \Go\Aop\Intercept\MethodInterceptor * @throws \UnexpectedValueException */ protected function getMethodInterceptor($metaInformation, $adviceCallback) { switch (true) { case ($metaInformation instanceof Annotation\Before): return new Framework\MethodBeforeInterceptor($adviceCallback, $metaInformation->order); case ($metaInformation instanceof Annotation\After): return new Framework\MethodAfterInterceptor($adviceCallback, $metaInformation->order); case ($metaInformation instanceof Annotation\Around): return new Framework\MethodAroundInterceptor($adviceCallback, $metaInformation->order); case ($metaInformation instanceof Annotation\AfterThrowing): return new Framework\MethodAfterThrowingInterceptor($adviceCallback, $metaInformation->order); default: throw new \UnexpectedValueException("Unsupported method meta class: " . get_class($metaInformation)); } } /** * @param $metaInformation * @param $adviceCallback * @return \Go\Aop\Intercept\FieldAccess * @throws \UnexpectedValueException */ protected function getPropertyInterceptor($metaInformation, $adviceCallback) { switch (true) { case ($metaInformation instanceof Annotation\Before): return new Framework\FieldBeforeInterceptor($adviceCallback, $metaInformation->order); case ($metaInformation instanceof Annotation\After): return new Framework\FieldAfterInterceptor($adviceCallback, $metaInformation->order); case ($metaInformation instanceof Annotation\Around): return new Framework\FieldAroundInterceptor($adviceCallback, $metaInformation->order); default: throw new \UnexpectedValueException("Unsupported method meta class: " . get_class($metaInformation)); } } /** * Temporary method for parsing pointcuts * * @todo Replace this method with pointcut parser * * @param AspectContainer $container Container * @param Annotation\BaseAnnotation|Annotation\BaseInterceptor $metaInformation * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * * @throws \UnexpectedValueException If pointcut can not be parsed * @return \Go\Aop\Pointcut */ private function parsePointcut(AspectContainer $container, $reflection, $metaInformation) { if (isset($metaInformation->pointcut)) { return $this->loadPointcutFromContainer($container, $reflection, $metaInformation); } // execution(public Example\Aspect\*->method*()) // execution(protected Test\Class*::someStatic*Method()) static $executionReg = '/ ^execution\( (?Ppublic|protected|\*)\s+ (?P[\w\\\*]+) (?P->|::) (?P[\w\*]+) \(\*?\) \)$/x'; if (preg_match($executionReg, $metaInformation->value, $matches)) { $modifier = self::$methodModifiers[$matches['modifier']]; $modifier |= self::$methodModifiers[$matches['type']]; $pointcut = new Support\SignatureMethodPointcut($matches['method'], $modifier); if ($matches['class'] !== '*') { $classFilter = new Support\SimpleClassFilter($matches['class']); $pointcut->setClassFilter($classFilter); } return $pointcut; } // @annotation(First\Second\Annotation\Class) static $annotationReg = '/ ^@annotation\( (?P[\w\\\*]+) \)$/x'; if (preg_match($annotationReg, $metaInformation->value, $matches)) { // TODO: use single annotation reader $reader = $container->get('aspect.annotation.raw.reader'); $pointcut = new Support\AnnotationMethodPointcut($reader, $matches['annotation']); return $pointcut; } // within(Go\Aspects\Blog\Package\*) : This will match all the methods in all classes of Go\Aspects\Blog\Package. // within(Go\Aspects\Blog\Package\**) : This will match all the methods in all classes of Go\Aspects\Blog\Package and its sub packages. The only difference is the extra dot(.) after package. // within(Go\Aspects\Blog\Package\DemoClass) : This will match all the methods in the DemoClass. // within(DemoInterface+) : This will match all the methods which are in classes which implement DemoInterface. static $withinReg = '/ ^within\( (?P[\w\\\*]+) (?P\+?) \)$/x'; if (preg_match($withinReg, $metaInformation->value, $matches)) { $pointcut = new Support\WithinMethodPointcut($matches['class'], (bool) $matches['children']); return $pointcut; } // access(public Example\Aspect\*->property*) // access(protected Test\Class*->someProtected*Property) static $propertyReg = '/ ^access\( (?Ppublic|protected|\*)\s+ (?P[\w\\\*]+) -> (?P[\w\*]+) \)$/x'; if (preg_match($propertyReg, $metaInformation->value, $matches)) { $modifier = self::$propertyModifiers[$matches['modifier']]; $pointcut = new Support\SignaturePropertyPointcut($matches['property'], $modifier); if ($matches['class'] !== '*') { $classFilter = new Support\SimpleClassFilter($matches['class']); $pointcut->setClassFilter($classFilter); } return $pointcut; } throw new \UnexpectedValueException("Unsupported pointcut: {$metaInformation->value}"); } /** * Loads a pointcut from container by name * * @param Annotation\BaseAnnotation|Annotation\BaseInterceptor $metaInformation * @param $container * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * * @return mixed Pointcut * @throws \UnexpectedValueException If both value and pointcut name is set */ private function loadPointcutFromContainer(AspectContainer $container, $reflection, $metaInformation) { if ($metaInformation->value) { throw new \UnexpectedValueException("Can not use both `value` and `pointcut` properties"); } try { // FQDN return $container->getPointcut($metaInformation->pointcut); } catch (\OutOfBoundsException $e) { // By method name for class $pointcutId = sprintf("%s->%s", $reflection->class, $metaInformation->pointcut); return $container->getPointcut($pointcutId); } } }src/Go/Core/IntroductionAspectExtension.php000064400000010114144760123700015020 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Core; use ReflectionMethod; use ReflectionProperty; use Go\Aop\Aspect; use Go\Aop\ClassFilter; use Go\Aop\Framework; use Go\Aop\Support; use Go\Lang\Annotation; /** * Introduction aspect extension */ class IntroductionAspectExtension implements AspectLoaderExtension { /** * General aspect loader works with annotations from aspect * * For extension that works with annotations additional metaInformation will be passed * * @return string */ public function getKind() { return self::KIND_ANNOTATION; } /** * General aspect loader works only with methods of aspect * * @return string|array */ public function getTarget() { return self::TARGET_PROPERTY; } /** * Checks if loader is able to handle specific point of aspect * * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param mixed|null $metaInformation Additional meta-information, e.g. annotation for method * * @return boolean true if extension is able to create an advisor from reflection and metaInformation */ public function supports(Aspect $aspect, $reflection, $metaInformation = null) { return $metaInformation instanceof Annotation\DeclareParents; } /** * Loads definition from specific point of aspect into the container * * @param AspectContainer $container Instance of container * @param Aspect $aspect Instance of aspect * @param mixed|\ReflectionClass|\ReflectionMethod|\ReflectionProperty $reflection Reflection of point * @param Annotation\DeclareParents|null $metaInformation Additional meta-information */ public function load(AspectContainer $container, Aspect $aspect, $reflection, $metaInformation = null) { // TODO: use general class parser here instead of hardcoded regular expressions $classFilter = $this->parseClassFilter($metaInformation); $interface = $metaInformation->interface; $implement = $metaInformation->defaultImpl; $advice = new Framework\TraitIntroductionInfo($interface, $implement); $advisor = new Support\DeclareParentsAdvisor($classFilter, $advice); $propertyId = sprintf("%s->%s", $reflection->class, $reflection->name); $container->registerAdvisor($advisor, $propertyId); } /** * Temporary method for parsing class filters * * @todo Replace this method with pointcut parser * * @param Annotation\BaseAnnotation $metaInformation * * @throws \UnexpectedValueException If class filter can not be parsed * @throws \InvalidArgumentException * @return ClassFilter */ private function parseClassFilter($metaInformation) { // Go\Aspects\Blog\Package\** : This will match all classes of Go\Aspects\Blog\Package and its sub packages. // Go\Aspects\Blog\Package\DemoClass : This will match DemoClass. // DemoInterface+ : This will match all classes which implement DemoInterface. static $classReg = '/ ^ (?P[\w\\\*]+) (?P\+?) $/x'; if (preg_match($classReg, $metaInformation->value, $matches)) { $className = $matches['class']; if (!$matches['children']) { $classFilter = new Support\SimpleClassFilter($className); } elseif (strpos($className, '*') === false) { $classFilter = new Support\InheritanceClassFilter($className); } else { throw new \InvalidArgumentException("Can not use children selector with class mask"); } return $classFilter; } throw new \UnexpectedValueException("Unsupported class filter: {$metaInformation->value}"); } }src/Go/Instrument/ClassLoading/LoadTimeWeaver.php000064400000001203144760123700015774 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\ClassLoading; use Go\Instrument\Transformer\SourceTransformer; /** * @package go * @subpackage instrument */ interface LoadTimeWeaver { /** * Adds a SourceTransformer to be applied by this LoadTimeWeaver. * * @param $transformer SourceTransformer Transformer for source code * * @return void */ public function addTransformer(SourceTransformer $transformer); } src/Go/Instrument/ClassLoading/SourceTransformingLoader.php000064400000007721144760123700020120 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\ClassLoading; use php_user_filter as PhpStreamFilter; use Go\Instrument\Transformer\StreamMetaData; use Go\Instrument\Transformer\SourceTransformer; use Go\Instrument\Transformer\FilterInjectorTransformer; /** * Php class loader filter for processing php code */ class SourceTransformingLoader extends PhpStreamFilter implements LoadTimeWeaver { /** * Php filter definition */ const PHP_FILTER_READ = 'php://filter/read='; /** * Default PHP filter name for registration */ const FILTER_IDENTIFIER = 'go.source.transforming.loader'; /** * String buffer * * @var string */ protected $data = ''; /** * Filter bucket resource * * @var null|resource */ protected $bucket = null; /** * List of transformers * * @var array|SourceTransformer[] */ protected static $transformers = array(); /** * Identifier of filter * * @var string */ protected static $filterId; /** * Register current loader as stream filter in PHP * * @param string $filterId Identifier for the filter * @throws \RuntimeException If registration was failed */ public function register($filterId = self::FILTER_IDENTIFIER) { if (!empty(self::$filterId)) { throw new \RuntimeException('Stream filter already registered'); } $result = stream_filter_register($filterId, __CLASS__); if (!$result) { throw new \RuntimeException('Stream filter was not registered'); } self::$filterId = $filterId; } /** * Returns the name of registered filter * * @throws \RuntimeException if filter was not registered * @return string */ public function getId() { if (empty(self::$filterId)) { throw new \RuntimeException('Stream filter was not registered'); } return self::$filterId; } /** * {@inheritdoc} */ public function filter($in, $out, &$consumed, $closing) { while ($bucket = stream_bucket_make_writeable($in)) { $this->data .= $bucket->data; $this->bucket = $bucket; $consumed = 0; } if ($closing) { $consumed += strlen($this->data); // $this->stream contains pointer to the source $metadata = new StreamMetaData($this->stream); $metadata->source = $this->data; $this->transformCode($metadata); $this->bucket->data = $metadata->source; $this->bucket->datalen = strlen($this->bucket->data); if (!empty($this->bucket->data)) { stream_bucket_append($out, $this->bucket); } return PSFS_PASS_ON; } return PSFS_FEED_ME; } /** * Adds a SourceTransformer to be applied by this LoadTimeWeaver. * * @param $transformer SourceTransformer Transformer for source code * * @return void */ public function addTransformer(SourceTransformer $transformer) { self::$transformers[] = $transformer; } /** * Load source file with transformation * * @param string $source Original source name * * @return mixed */ public function load($source) { return include FilterInjectorTransformer::rewrite($source); } /** * Transforms source code by passing it through all transformers * * @param StreamMetaData|null $metadata Metadata from stream * @return void */ protected function transformCode(StreamMetaData $metadata) { foreach (self::$transformers as $transformer) { $transformer->transform($metadata); } } } src/Go/Instrument/ClassLoading/UniversalClassLoader.php000064400000021435144760123700017222 0ustar00 * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. * * NB: Namespace is changed to Go\Instrument\ClassLoading to use separate code for original loader * This class shouldn't be used for loading of another classes! */ namespace Go\Instrument\ClassLoading; /** * UniversalClassLoader implements a "universal" autoloader for PHP 5.3. * * It is able to load classes that use either: * * * The technical interoperability standards for PHP 5.3 namespaces and * class names (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md); * * * The PEAR naming convention for classes (http://pear.php.net/). * * Classes from a sub-namespace or a sub-hierarchy of PEAR classes can be * looked for in a list of locations to ease the vendoring of a sub-set of * classes for large projects. * * Example usage: * * $loader = new UniversalClassLoader(); * * // register classes with namespaces * $loader->registerNamespaces(array( * 'Symfony\Component' => __DIR__.'/component', * 'Symfony' => __DIR__.'/framework', * 'Sensio' => array(__DIR__.'/src', __DIR__.'/vendor'), * )); * * // register a library using the PEAR naming convention * $loader->registerPrefixes(array( * 'Swift_' => __DIR__.'/Swift', * )); * * * // to enable searching the include path (e.g. for PEAR packages) * $loader->useIncludePath(true); * * // activate the autoloader * $loader->register(); * * In this example, if you try to use a class in the Symfony\Component * namespace or one of its children (Symfony\Component\Console for instance), * the autoloader will first look for the class under the component/ * directory, and it will then fallback to the framework/ directory if not * found before giving up. * * @author Fabien Potencier * * @api */ class UniversalClassLoader { private $namespaces = array(); private $prefixes = array(); private $namespaceFallbacks = array(); private $prefixFallbacks = array(); private $useIncludePath = false; /** * Turns on searching the include for class files. Allows easy loading * of installed PEAR packages * * @param Boolean $useIncludePath */ public function useIncludePath($useIncludePath) { $this->useIncludePath = $useIncludePath; } /** * Can be used to check if the autoloader uses the include path to check * for classes. * * @return Boolean */ public function getUseIncludePath() { return $this->useIncludePath; } /** * Gets the configured namespaces. * * @return array A hash with namespaces as keys and directories as values */ public function getNamespaces() { return $this->namespaces; } /** * Gets the configured class prefixes. * * @return array A hash with class prefixes as keys and directories as values */ public function getPrefixes() { return $this->prefixes; } /** * Gets the directory(ies) to use as a fallback for namespaces. * * @return array An array of directories */ public function getNamespaceFallbacks() { return $this->namespaceFallbacks; } /** * Gets the directory(ies) to use as a fallback for class prefixes. * * @return array An array of directories */ public function getPrefixFallbacks() { return $this->prefixFallbacks; } /** * Registers the directory to use as a fallback for namespaces. * * @param array $dirs An array of directories * * @api */ public function registerNamespaceFallbacks(array $dirs) { $this->namespaceFallbacks = $dirs; } /** * Registers a directory to use as a fallback for namespaces. * * @param string $dir A directory */ public function registerNamespaceFallback($dir) { $this->namespaceFallbacks[] = $dir; } /** * Registers directories to use as a fallback for class prefixes. * * @param array $dirs An array of directories * * @api */ public function registerPrefixFallbacks(array $dirs) { $this->prefixFallbacks = $dirs; } /** * Registers a directory to use as a fallback for class prefixes. * * @param string $dir A directory */ public function registerPrefixFallback($dir) { $this->prefixFallbacks[] = $dir; } /** * Registers an array of namespaces * * @param array $namespaces An array of namespaces (namespaces as keys and locations as values) * * @api */ public function registerNamespaces(array $namespaces) { foreach ($namespaces as $namespace => $locations) { $this->namespaces[$namespace] = (array) $locations; } } /** * Registers a namespace. * * @param string $namespace The namespace * @param array|string $paths The location(s) of the namespace * * @api */ public function registerNamespace($namespace, $paths) { $this->namespaces[$namespace] = (array) $paths; } /** * Registers an array of classes using the PEAR naming convention. * * @param array $classes An array of classes (prefixes as keys and locations as values) * * @api */ public function registerPrefixes(array $classes) { foreach ($classes as $prefix => $locations) { $this->prefixes[$prefix] = (array) $locations; } } /** * Registers a set of classes using the PEAR naming convention. * * @param string $prefix The classes prefix * @param array|string $paths The location(s) of the classes * * @api */ public function registerPrefix($prefix, $paths) { $this->prefixes[$prefix] = (array) $paths; } /** * Registers this instance as an autoloader. * * @param Boolean $prepend Whether to prepend the autoloader or not * * @api */ public function register($prepend = false) { spl_autoload_register(array($this, 'loadClass'), true, $prepend); } /** * Loads the given class or interface. * * @param string $class The name of the class */ public function loadClass($class) { if ($file = $this->findOriginalFile($class)) { require $file; } } /** * Finds the path to the file where the class is defined. * * @param string $class The name of the class * * @return string|null The path, if found */ public function findOriginalFile($class) { if ('\\' == $class[0]) { $class = substr($class, 1); } if (false !== $pos = strrpos($class, '\\')) { // namespaced class name $namespace = substr($class, 0, $pos); $className = substr($class, $pos + 1); $normalizedClass = str_replace('\\', DIRECTORY_SEPARATOR, $namespace).DIRECTORY_SEPARATOR.str_replace('_', DIRECTORY_SEPARATOR, $className).'.php'; foreach ($this->namespaces as $ns => $dirs) { if (0 !== strpos($namespace, $ns)) { continue; } foreach ($dirs as $dir) { $file = $dir.DIRECTORY_SEPARATOR.$normalizedClass; if (is_file($file)) { return $file; } } } foreach ($this->namespaceFallbacks as $dir) { $file = $dir.DIRECTORY_SEPARATOR.$normalizedClass; if (is_file($file)) { return $file; } } } else { // PEAR-like class name $normalizedClass = str_replace('_', DIRECTORY_SEPARATOR, $class).'.php'; foreach ($this->prefixes as $prefix => $dirs) { if (0 !== strpos($class, $prefix)) { continue; } foreach ($dirs as $dir) { $file = $dir.DIRECTORY_SEPARATOR.$normalizedClass; if (is_file($file)) { return $file; } } } foreach ($this->prefixFallbacks as $dir) { $file = $dir.DIRECTORY_SEPARATOR.$normalizedClass; if (is_file($file)) { return $file; } } } if ($this->useIncludePath && $file = stream_resolve_include_path($normalizedClass)) { return $file; } } } src/Go/Instrument/RawAnnotationReader.php000064400000012143144760123700014475 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument; use ReflectionClass; use ReflectionMethod; use ReflectionProperty; use TokenReflection\ReflectionClass as ParsedReflectionClass; use TokenReflection\ReflectionMethod as ParsedReflectionMethod; use TokenReflection\ReflectionProperty as ParsedReflectionProperty; use Doctrine\Common\Annotations\DocParser; use Doctrine\Common\Annotations\Annotation\Target; /** * Simple Raw Annotation Reader. * * This annotation reader is intended to be used in projects where you have * full-control over all annotations that are available. * * @since 2.2 * @author Johannes M. Schmitt * @author Fabio B. Silva */ class RawAnnotationReader { /** * @var DocParser */ private $parser; /** * Constructor. * * Initializes a new SimpleAnnotationReader. */ public function __construct() { $this->parser = new DocParser(); $this->parser->setIgnoreNotImportedAnnotations(true); } /** * Set imports for annotations * * @param array $imports */ public function setImports(array $imports) { $convertedImports = array(); foreach ($imports as $aliasName=>$fullName) { $convertedImports[strtolower($aliasName)] = $fullName; } $this->parser->setImports($convertedImports); } /** * Adds a namespace in which we will look for annotations. * * @param string $namespace */ public function addNamespace($namespace) { $this->parser->addNamespace($namespace); } /** * Gets the annotations applied to a class. * * @param ReflectionClass|ParsedReflectionClass $class The ReflectionClass of the class from which * the class annotations should be read. * @return array An array of Annotations. */ public function getClassAnnotations($class) { $this->parser->setTarget(Target::TARGET_CLASS); return $this->parser->parse($class->getDocComment(), 'class '.$class->getName()); } /** * Gets the annotations applied to a method. * * @param ReflectionMethod|ParsedReflectionMethod $method The ReflectionMethod of the method from which * the annotations should be read. * @return array An array of Annotations. */ public function getMethodAnnotations($method) { $this->parser->setTarget(Target::TARGET_METHOD); return $this->parser->parse($method->getDocComment(), 'method '.$method->getDeclaringClass()->name.'::'.$method->getName().'()'); } /** * Gets the annotations applied to a property. * * @param ReflectionProperty|ParsedReflectionProperty $property The ReflectionProperty of the property * from which the annotations should be read. * @return array An array of Annotations. */ public function getPropertyAnnotations($property) { $this->parser->setTarget(Target::TARGET_PROPERTY); return $this->parser->parse($property->getDocComment(), 'property '.$property->getDeclaringClass()->name.'::$'.$property->getName()); } /** * Gets a class annotation. * * @param ReflectionClass|ParsedReflectionClass $class The ReflectionClass of the class from which * the class annotations should be read. * @param string $annotationName The name of the annotation. * @return The Annotation or NULL, if the requested annotation does not exist. */ public function getClassAnnotation($class, $annotationName) { foreach ($this->getClassAnnotations($class) as $annot) { if ($annot instanceof $annotationName) { return $annot; } } return null; } /** * Gets a method annotation. * * @param ReflectionMethod|ParsedReflectionMethod $method * @param string $annotationName The name of the annotation. * @return The Annotation or NULL, if the requested annotation does not exist. */ public function getMethodAnnotation($method, $annotationName) { foreach ($this->getMethodAnnotations($method) as $annot) { if ($annot instanceof $annotationName) { return $annot; } } return null; } /** * Gets a property annotation. * * @param ReflectionProperty|ParsedReflectionProperty $property * @param string $annotationName The name of the annotation. * @return The Annotation or NULL, if the requested annotation does not exist. */ public function getPropertyAnnotation($property, $annotationName) { foreach ($this->getPropertyAnnotations($property) as $annot) { if ($annot instanceof $annotationName) { return $annot; } } return null; } }src/Go/Instrument/Transformer/AopProxyTransformer.php000064400000011145144760123700017075 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; use Go\Core\AspectContainer; use Go\Core\AspectKernel; use Go\Aop\Support\AopChildFactory; use TokenReflection\Broker; use TokenReflection\ReflectionClass; use TokenReflection\ReflectionFileNamespace; /** * @package go */ class AopProxyTransformer implements SourceTransformer { /** * Reflection broker instance * * @var Broker */ protected $broker; /** * List of include paths to process * * @var array */ protected $includePaths = array(); /** * List of exclude paths to process * * @var array */ protected $excludePaths = array(); /** * Constructs AOP Proxy transformer * * @param Broker $broker Instance of reflection broker to use */ public function __construct(array $options, Broker $broker) { $this->broker = $broker; $this->includePaths = array_map('realpath', $options['includePaths']); $this->excludePaths = array_map('realpath', $options['autoload']); } /** * This method may transform the supplied source and return a new replacement for it * * @param StreamMetaData $metadata Metadata for source * @return void */ public function transform(StreamMetaData $metadata) { $fileName = realpath($metadata->getResourceUri()); if ($this->includePaths) { $found = false; foreach ($this->includePaths as $includePath) { if (strpos($fileName, $includePath) === 0) { $found = true; break; } } if (!$found) { return; } } foreach ($this->excludePaths as $excludePath) { if (strpos($fileName, $excludePath) === 0) { return; } } $parsedSource = $this->broker->processString($metadata->source, $fileName, true); /** @var $namespaces ReflectionFileNamespace[] */ $namespaces = $parsedSource->getNamespaces(); assert('count($namespaces) < 2; /* Only one namespace per file is supported */'); foreach ($namespaces as $namespace) { /** @var $classes ReflectionClass[] */ $classes = $namespace->getClasses(); foreach ($classes as $class) { // Skip interfaces if ($class->isInterface()) { continue; } // Look for aspects if ($class->hasAnnotation('Aspect') || in_array('Go\Aop\Aspect', $class->getInterfaceNames())) { // Here we will create an aspect advisor and register aspect // AspectContainer::register($class); continue; } $container = AspectKernel::getInstance()->getContainer(); $advices = $container->getAdvicesForClass($class); if ($advices) { // Prepare new parent name $newParentName = $class->getShortName() . AspectContainer::AOP_PROXIED_SUFFIX; // Replace original class name with new $metadata->source = $this->adjustOriginalClass($class, $metadata->source, $newParentName); // Prepare child Aop proxy $child = AopChildFactory::generate($class, $advices); // Set new parent name instead of original $child->setParentName($newParentName); // Add child to source $metadata->source .= $child; } } } } /** * Adjust definition of original class source to enable extending * * @param ReflectionClass $class Instance of class reflection * @param string $source Source code * @param string $newParentName New name for the parent class * * @return string Replaced code for class */ private function adjustOriginalClass($class, $source, $newParentName) { $source = preg_replace( '/class\s+(' . $class->getShortName() . ')/iS', "class $newParentName", $source ); if ($class->isFinal()) { // Remove final from class, child will be final instead $source = str_replace('final class', 'class', $source); } return $source; } } src/Go/Instrument/Transformer/CachingTransformer.php000064400000005371144760123700016654 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; use Go\Core\AspectKernel; /** * Take transformed source from the cache * * @package go * @subpackage instrument */ class CachingTransformer implements SourceTransformer { /** * Root path of application * * @var string */ protected $rootPath = ''; /** * Cache directory * * @var string */ protected $cachePath = ''; /** * @var array|SourceTransformer[] */ protected $transformers = array(); /** * Class constructor * * @param array $options Configuration options from kernel * @param array $transformers Source transformers */ public function __construct(array $options, array $transformers) { if ($options['cacheDir']) { $this->cachePath = realpath($options['cacheDir']); } $this->rootPath = realpath($options['appDir']); $this->transformers = $transformers; } /** * This method may transform the supplied source and return a new replacement for it * * @param StreamMetaData $metadata Metadata for source * @return void */ public function transform(StreamMetaData $metadata) { // Do not create a cache if (!$this->cachePath) { $this->processTransformers($metadata); return; } $originalUri = $metadata->getResourceUri(); $cacheUri = stream_resolve_include_path($originalUri); $cacheUri = str_replace($this->rootPath, $this->cachePath, $cacheUri); // TODO: decide how to inject container in more friendly way $container = AspectKernel::getInstance()->getContainer(); $lastModified = filemtime($originalUri); $cacheModified = file_exists($cacheUri) ? filemtime($cacheUri) : 0; // TODO: add more accurate cache invalidation, like in Symfony2 if ($cacheModified < $lastModified || !$container->isFresh($cacheModified)) { @mkdir(dirname($cacheUri), 0770, true); $this->processTransformers($metadata); file_put_contents($cacheUri, $metadata->source); return; } $metadata->source = file_get_contents($cacheUri); } /** * Iterates over transformers * * @param StreamMetaData $metadata Metadata for source code * @return void */ private function processTransformers(StreamMetaData $metadata) { foreach ($this->transformers as $transformer) { $transformer->transform($metadata); } } } src/Go/Instrument/Transformer/FilterInjectorTransformer.php000064400000010540144760123700020235 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; /** * Injects source filter for require and include operations * * @package go * @subpackage instrument */ class FilterInjectorTransformer implements SourceTransformer { /** * Php filter definition */ const PHP_FILTER_READ = 'php://filter/read='; /** * Root path of application * * This path will be replaced with rewriteToPath * * @var string */ protected static $rootPath; /** * Path to rewrite for absolute address * * @var string */ protected static $rewriteToPath = null; /** * Name of the filter to inject * * @var string */ protected static $filterName; /** * Flag of configuration * * @var bool */ protected static $configured = false; /** * Debug mode * * @var bool */ protected static $debug = false; /** * Class constructor * * @param array $options Configuration options from kernel * @param string $filterName Name of the filter to inject */ public function __construct(array $options, $filterName) { self::configure($options, $filterName); } /** * Static configurator for filter * * @param array $options Kernel options * @param string $filterName Name of the filter to inject * * @throws \RuntimeException if filter was configured early */ protected static function configure(array $options, $filterName) { if (self::$configured) { throw new \RuntimeException("Filter injector can be configured only once."); } $rewriteToPath = $options['cacheDir']; if ($rewriteToPath) { self::$rewriteToPath = realpath($rewriteToPath); } self::$rootPath = realpath($options['appDir']); self::$filterName = $filterName; self::$debug = $options['debug']; self::$configured = true; } /** * Replace source path with correct one * * This operation can check for cache, can rewrite paths, add additional filters and much more * * @param string $resource Initial resource to include * @return string Transformed path to the resource */ public static function rewrite($resource) { // If cache is disabled, then use on-fly method if (!self::$rewriteToPath || self::$debug) { return self::PHP_FILTER_READ . self::$filterName . "/resource=" . $resource; } $newResource = stream_resolve_include_path($resource); $newResource = str_replace(self::$rootPath, self::$rewriteToPath, $newResource); // Trigger creation of cache, this will create a cache file with $newResource name if (!file_exists($newResource)) { file_get_contents(self::PHP_FILTER_READ . self::$filterName . "/resource=" . $resource); } return $newResource; } /** * Wrap all includes into rewrite filter * * @param StreamMetaData $metadata Metadata for source * @return void */ public function transform(StreamMetaData $metadata) { if ((strpos($metadata->source, 'include')===false) && (strpos($metadata->source, 'require')===false)) { return; } static $lookFor = array( T_INCLUDE => true, T_INCLUDE_ONCE => true, T_REQUIRE => true, T_REQUIRE_ONCE => true ); $tokenStream = token_get_all($metadata->source); $transformedSource = ''; $isWaitingEnd = false; foreach ($tokenStream as $token) { if ($isWaitingEnd && ($token === ';' || $token === ',')) { $isWaitingEnd = false; $transformedSource .= ')'; } list ($token, $value) = (array) $token + array(1 => $token); $transformedSource .= $value; if (!$isWaitingEnd && isset($lookFor[$token])) { $isWaitingEnd = true; $transformedSource .= ' \\' . __CLASS__ . '::rewrite('; } } $metadata->source = $transformedSource; } } src/Go/Instrument/Transformer/MagicConstantTransformer.php000064400000006440144760123700020050 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; /** * Replace magic directory and file constants in the source code * * @package go * @subpackage instrument */ class MagicConstantTransformer implements SourceTransformer { /** * Root path of application * * @var string */ protected static $rootPath = ''; /** * Path to rewrite to (cache directory) * * @var string */ protected static $rewriteToPath = ''; /** * Class constructor * * @param array $options Configuration options from kernel */ public function __construct(array $options) { self::$rootPath = realpath($options['appDir']); $rewriteToPath = $options['cacheDir']; if ($rewriteToPath) { self::$rewriteToPath = realpath($rewriteToPath); } } /** * This method may transform the supplied source and return a new replacement for it * * @param StreamMetaData $metadata Metadata for source * @return void */ public function transform(StreamMetaData $metadata) { // Make the job only when we use cache directory if (!self::$rewriteToPath) { return; } $hasReflectionFilename = strpos($metadata->source, 'getFileName') !== false; $hasMagicConstants = (strpos($metadata->source, '__DIR__') !== false) || (strpos($metadata->source, '__FILE__') !== false); if (!$hasMagicConstants && !$hasReflectionFilename) { return; } // Resolve magic constants if ($hasMagicConstants) { $this->replaceMagicConstants($metadata); } if ($hasReflectionFilename) { // TODO: need to make more reliable solution $metadata->source = preg_replace( '/\$([\w\$\-\>\:\(\)]*?getFileName\(\))/S', '\\' . __CLASS__ . '::resolveFileName(\$\1)', $metadata->source ); } } /** * Resolves file name from the cache directory to the real application root dir * * @param string $fileName Absolute file name * * @return string Resolved file name */ public static function resolveFileName($fileName) { return str_replace(self::$rewriteToPath, self::$rootPath, $fileName); } /** * Replace only magic constants in the code * * @param StreamMetaData $metadata */ private function replaceMagicConstants(StreamMetaData $metadata) { $originalUri = $metadata->getResourceUri(); $replacement = array( T_FILE => $originalUri, T_DIR => dirname($originalUri) ); $tokenStream = token_get_all($metadata->source); $transformedSource = ''; foreach ($tokenStream as $token) { list ($token, $value) = (array) $token + array(1 => $token); if (isset($replacement[$token])) { $value = "'" . $replacement[$token] . "'"; } $transformedSource .= $value; } $metadata->source = $transformedSource; } } src/Go/Instrument/Transformer/SourceTransformer.php000064400000001106144760123700016550 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; /** * @package go * @subpackage instrument */ interface SourceTransformer { /** * This method may transform the supplied source and return a new replacement for it * * @param StreamMetaData $metadata Metadata for source * @return void */ public function transform(StreamMetaData $metadata); } src/Go/Instrument/Transformer/StreamMetaData.php000064400000004514144760123700015727 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Instrument\Transformer; use ArrayObject; use InvalidArgumentException; /** * Stream metadata object * * @property bool timed_out TRUE if the stream timed out while waiting for data on the last call to fread() or fgets(). * @property bool blocked TRUE if the stream is in blocking IO mode * @property bool eof TRUE if the stream has reached end-of-file. * @property int unread_bytes the number of bytes currently contained in the PHP's own internal buffer. * @property string stream_type a label describing the underlying implementation of the stream. * @property string wrapper_type a label describing the protocol wrapper implementation layered over the stream. * @property mixed wrapper_data wrapper specific data attached to this stream. * @property array filters array containing the names of any filters that have been stacked onto this stream. * @property string mode the type of access required for this stream * @property bool seekable whether the current stream can be seeked. * @property string uri the URI/filename associated with this stream. * @property source source of the stream. */ class StreamMetaData extends ArrayObject { /** * Creates metadata object from stream * * @param resource $stream Instance of stream * * @throws \InvalidArgumentException for invalid stream */ public function __construct($stream, $source = null) { if (!is_resource($stream)) { throw new InvalidArgumentException("Stream should be valid resource"); } $metadata = stream_get_meta_data($stream); if($source) { $metadata['source'] = $source; } parent::__construct($metadata, ArrayObject::ARRAY_AS_PROPS); } /** * Return original resource URI from filter URI * * @return string * @throws \InvalidArgumentException if resource was not found in URI */ public function getResourceUri() { if (!preg_match('/resource=(.+)$/i', $this->uri, $matches)) { throw new InvalidArgumentException("Original resource not found in URI"); } return $matches[1]; } } src/Go/Lang/Annotation/After.php000064400000000570144760123700012453 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * After advice annotation * * @Annotation * @Target({ "METHOD", "PROPERTY" }) */ class After extends BaseInterceptor { } src/Go/Lang/Annotation/AfterThrowing.php000064400000000571144760123700014176 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * After throwing advice annotation * * @Annotation * @Target("METHOD") */ class AfterThrowing extends BaseInterceptor { } src/Go/Lang/Annotation/Around.php000064400000000572144760123700012644 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Around advice annotation * * @Annotation * @Target({ "METHOD", "PROPERTY" }) */ class Around extends BaseInterceptor { } src/Go/Lang/Annotation/Aspect.php000064400000000562144760123700012632 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Annotation marker class for aspect * * @Annotation * @Target("CLASS") */ class Aspect extends BaseAnnotation { } src/Go/Lang/Annotation/BaseAnnotation.php000064400000002602144760123700014315 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * @Annotation */ abstract class BaseAnnotation { /** * Value property. Common among all derived classes. * * @var string */ public $value; /** * Constructor * * @param array $data Key-value for properties to be defined in this class */ public final function __construct(array $data) { foreach ($data as $key => $value) { $this->$key = $value; } } /** * Error handler for unknown property accessor in Annotation class. * * @param string $name Unknown property name */ public function __get($name) { throw new \BadMethodCallException( sprintf("Unknown property '%s' on annotation '%s'.", $name, get_class($this)) ); } /** * Error handler for unknown property mutator in Annotation class. * * @param string $name Unknown property name * @param mixed $value Property value */ public function __set($name, $value) { throw new \BadMethodCallException( sprintf("Unknown property '%s' on annotation '%s'.", $name, get_class($this)) ); } } src/Go/Lang/Annotation/BaseInterceptor.php000064400000001076144760123700014505 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Default interceptor class with common attributes */ class BaseInterceptor extends BaseAnnotation implements Interceptor { /** * Order for advice * * @var integer */ public $order = 0; /** * Name of the pointcut to use * * @var string */ public $pointcut = null; } src/Go/Lang/Annotation/Before.php000064400000000572144760123700012616 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Before advice annotation * * @Annotation * @Target({ "METHOD", "PROPERTY" }) */ class Before extends BaseInterceptor { } src/Go/Lang/Annotation/DeclareParents.php000064400000001434144760123700014306 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Declare parents annotation * * @Annotation * @Target("PROPERTY") * * @Attributes({ * @Attribute("value", type = "string", required=true), * @Attribute("interface", type = "string", required=true), * @Attribute("defaultImpl", type = "string", required=true) * }) */ class DeclareParents extends BaseAnnotation { /** * Default implementation (trait name) * * @var string */ public $defaultImpl = ''; /** * Interface name to add * * @var string */ public $interface = ''; } src/Go/Lang/Annotation/Interceptor.php000064400000000471144760123700013710 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Interceptor annotation marker */ interface Interceptor { } src/Go/Lang/Annotation/Pointcut.php000064400000000671144760123700013221 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Lang\Annotation; /** * Pointcut annotation * * @Annotation * @Target("METHOD") * * @Attributes({ * @Attribute("value", type = "string", required=true) * }) */ class Pointcut extends BaseAnnotation { } tests/Go/Aop/Framework/ClosureDynamicMethodInvocationTest.php000064400000006573144760123700020433 0ustar00markTestSkipped("Closure Method Invocation works only on PHP 5.4 and greater"); } } /** * Tests dynamic method invocations * * @dataProvider dynamicMethodsBatch */ public function testDynamicMethodInvocation($methodName, $expectedResult) { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ClosureDynamicMethodInvocation(self::FIRST_CLASS_NAME, $methodName, array()); $result = $invocation($child); $this->assertEquals($expectedResult, $result); } public function testValueChangedByReference() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ClosureDynamicMethodInvocation(self::FIRST_CLASS_NAME, 'passByReference', array()); $value = 'test'; $result = $invocation($child, array(&$value)); $this->assertEquals(null, $result); $this->assertEquals(null, $value); } public function testRecursionWorks() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('recursion')); $invocation = new ClosureDynamicMethodInvocation(self::FIRST_CLASS_NAME, 'recursion', array()); $child->expects($this->exactly(5))->method('recursion')->will($this->returnCallback( function ($value, $level) use ($child, $invocation) { return $invocation($child, array($value, $level)); } )); $this->assertEquals(5, $child->recursion(5,0)); $this->assertEquals(20, $child->recursion(5,3)); } public function testAdviceIsCalledForInvocation() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $value = 'test'; $advice = new MethodBeforeInterceptor(function ($object) use (&$value) { $value = 'ok'; }); $invocation = new ClosureDynamicMethodInvocation(self::FIRST_CLASS_NAME, 'publicMethod', array($advice)); $result = $invocation($child, array()); $this->assertEquals('ok', $value); $this->assertEquals(T_PUBLIC, $result); } public function dynamicMethodsBatch() { return array( array('publicMethod', T_PUBLIC), array('protectedMethod', T_PROTECTED), // array('privateMethod', T_PRIVATE), This will throw an ReflectionException, need to add use case for that ); } public function staticSelfMethodsBatch() { return array( array('staticSelfPublic', T_PUBLIC), array('staticSelfProtected', T_PROTECTED), // array('staticSelfPrivate', T_PRIVATE), // This will give a Fatal Error for scope ); } public function staticLsbMethodsBatch() { return array( array('staticLsbPublic'), array('staticLsbProtected'), ); } } tests/Go/Aop/Framework/ClosureStaticMethodInvocationTest.php000064400000011230144760123700020260 0ustar00markTestSkipped("Closure Method Invocation works only on PHP 5.4 and greater"); } } /** * Tests static method invocations with self * * @dataProvider staticSelfMethodsBatch */ public function testStaticSelfMethodInvocation($methodName, $expectedResult) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array('none')); $invocation = new ClosureStaticMethodInvocation($childClass, $methodName, array()); $result = $invocation($childClass); $this->assertEquals($expectedResult, $result); } /** * Tests static method invocations with self not overridden with parent * * @dataProvider staticSelfMethodsBatch */ public function testStaticSelfNotOverridden($methodName, $expectedResult) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array($methodName)); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, $methodName, array()); $result = $invocation($childClass); $this->assertEquals($expectedResult, $result); } /** * Tests static method invocations with Late Static Binding * * @dataProvider staticLsbMethodsBatch */ public function testStaticLsbIsWorking($methodName) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array($methodName)); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, $methodName, array()); $result = $invocation($childClass); $this->assertEquals($childClass, $result); } public function testValueChangedByReference() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, 'staticPassByReference', array()); $value = 'test'; $result = $invocation($child, array(&$value)); $this->assertEquals(null, $result); $this->assertEquals(null, $value); } public function testRecursionWorks() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('staticLsbRecursion')); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, 'staticLsbRecursion', array()); $child->staticExpects($this->exactly(5))->method('staticLsbRecursion')->will($this->returnCallback( function ($value, $level) use ($child, $invocation) { return $invocation($child, array($value, $level)); } )); $childClass = get_class($child); $this->assertEquals(5, $childClass::staticLsbRecursion(5,0)); $this->assertEquals(20, $childClass::staticLsbRecursion(5,3)); } public function testAdviceIsCalledForInvocation() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $value = 'test'; $advice = new MethodBeforeInterceptor(function () use (&$value) { $value = 'ok'; }); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, 'staticSelfPublic', array($advice)); $result = $invocation($child, array()); $this->assertEquals('ok', $value); $this->assertEquals(T_PUBLIC, $result); } public function testInvocationWithDynamicArguments() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ClosureStaticMethodInvocation(self::FIRST_CLASS_NAME, 'staticVariableArgsTest', array()); $args = array(); $expected = ''; for ($i=0; $i<10; $i++) { $args[] = $i; $expected .= $i; $result = $invocation($child, $args); $this->assertEquals($expected, $result); } } public function staticSelfMethodsBatch() { return array( array('staticSelfPublic', T_PUBLIC), array('staticSelfProtected', T_PROTECTED), array('staticSelfPublicAccessPrivate', T_PRIVATE), ); } public function staticLsbMethodsBatch() { return array( array('staticLsbPublic'), array('staticLsbProtected'), ); } } tests/Go/Aop/Framework/ReflectionMethodInvocationTest.php000064400000011305144760123700017571 0ustar00getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ReflectionMethodInvocation(self::FIRST_CLASS_NAME, $methodName, array()); $result = $invocation($child); $this->assertEquals($expectedResult, $result); } /** * Tests static method invocations with self * * @dataProvider staticSelfMethodsBatch */ public function testStaticSelfMethodInvocation($methodName, $expectedResult) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array('none')); $invocation = new ReflectionMethodInvocation($childClass, $methodName, array()); $result = $invocation($childClass); $this->assertEquals($expectedResult, $result); } /** * Tests static method invocations with self not overridden with parent * * @dataProvider staticSelfMethodsBatch */ public function testStaticSelfNotOverridden($methodName, $expectedResult) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array($methodName)); $invocation = new ReflectionMethodInvocation(self::FIRST_CLASS_NAME, $methodName, array()); $result = $invocation($childClass); $this->assertEquals($expectedResult, $result); } /** * Tests static method invocations with Late Static Binding * * @dataProvider staticLsbMethodsBatch */ public function testStaticLsbIsWorking($methodName) { $childClass = $this->getMockClass(self::FIRST_CLASS_NAME, array($methodName)); $invocation = new ReflectionMethodInvocation($childClass, $methodName, array()); // LSB is not working, so it returns parent class name :( So just check that this doesn't break anything $result = $invocation($childClass); $this->markTestSkipped("Late Static Binding is not working with Reflection"); } public function testValueChangedByReference() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $invocation = new ReflectionMethodInvocation(self::FIRST_CLASS_NAME, 'passByReference', array()); $value = 'test'; $result = $invocation($child, array(&$value)); $this->assertEquals(null, $result); $this->assertEquals(null, $value); } public function testRecursionWorks() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('recursion')); $invocation = new ReflectionMethodInvocation(self::FIRST_CLASS_NAME, 'recursion', array()); $child->expects($this->exactly(5))->method('recursion')->will($this->returnCallback( function ($value, $level) use ($child, $invocation) { return $invocation($child, array($value, $level)); } )); $this->assertEquals(5, $child->recursion(5,0)); $this->assertEquals(20, $child->recursion(5,3)); } public function testAdviceIsCalledForInvocation() { $child = $this->getMock(self::FIRST_CLASS_NAME, array('none')); $value = 'test'; $advice = new MethodBeforeInterceptor(function ($object) use (&$value) { $value = 'ok'; }); $invocation = new ReflectionMethodInvocation(self::FIRST_CLASS_NAME, 'publicMethod', array($advice)); $result = $invocation($child, array()); $this->assertEquals('ok', $value); $this->assertEquals(T_PUBLIC, $result); } public function dynamicMethodsBatch() { return array( array('publicMethod', T_PUBLIC), array('protectedMethod', T_PROTECTED), // array('privateMethod', T_PRIVATE), This will throw an ReflectionException, need to add use case for that ); } public function staticSelfMethodsBatch() { return array( array('staticSelfPublic', T_PUBLIC), array('staticSelfProtected', T_PROTECTED), // array('staticSelfPrivate', T_PRIVATE), // This will give a Fatal Error for scope ); } public function staticLsbMethodsBatch() { return array( array('staticLsbPublic'), array('staticLsbProtected'), ); } } tests/Go/Aop/TrueClassFilterTest.php000064400000001755144760123700013432 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ namespace Go\Aop; /** * Generated by PHPUnit_SkeletonGenerator 1.2.0 on 2012-11-28 at 15:42:10. */ class TrueClassFilterTest extends \PHPUnit_Framework_TestCase { /** * @var TrueClassFilter */ protected $object; /** * Sets up the fixture, for example, opens a network connection. * This method is called before a test is executed. */ protected function setUp() { $this->object = TrueClassFilter::getInstance(); } /** * Test that true matcher always matches the class */ public function testMatches() { // Works correctly with ReflectionClass $class = new \ReflectionClass('stdClass'); $this->assertTrue($this->object->matches($class)); } } tests/Go/Instrument/Transformer/FilterInjectorTransformerTest.php000064400000005521144760123700021453 0ustar00 null, 'appDir' => '', 'debug' => false, ), 'unit.test'); } /** * {@inheritDoc} */ public function setUp() { $stream = fopen('php://input', 'r'); $this->metadata = new StreamMetaData($stream); fclose($stream); } public function testCanTransformeWithoutInclusion() { $this->metadata->source = ''; $output = $this->metadata->source; self::$transformer->transform($this->metadata); $this->assertEquals($this->metadata->source, $output); } public function testCanTransformeInclude() { $this->metadata->source = ''; self::$transformer->transform($this->metadata); $output = ''; $this->assertEquals($this->metadata->source, $output); } public function testCanTransformeIncludeOnce() { $this->metadata->source = ''; self::$transformer->transform($this->metadata); $output = ''; $this->assertEquals($this->metadata->source, $output); } public function testCanTransformeRequire() { $this->metadata->source = ''; self::$transformer->transform($this->metadata); $output = ''; $this->assertEquals($this->metadata->source, $output); } public function testCanTransformeRequireOnce() { $this->metadata->source = ''; self::$transformer->transform($this->metadata); $output = ''; $this->assertEquals($this->metadata->source, $output); } public function testCanRewriteWithFilter() { $this->metadata->source = FilterInjectorTransformer::rewrite('/path/to/my/class.php'); $output = FilterInjectorTransformer::PHP_FILTER_READ . 'unit.test/resource=/path/to/my/class.php'; $this->assertEquals($this->metadata->source, $output); } } tests/Go/Instrument/Transformer/MagicConstantTransformerTest.php000064400000005117144760123700021263 0ustar00transformer = new MagicConstantTransformer(array( 'cacheDir' => __DIR__, 'appDir' => dirname(__DIR__), )); $stream = fopen('php://filter/string.tolower/resource=' . __FILE__, 'r'); $this->metadata = new StreamMetaData($stream); fclose($stream); } public function testTransformerReturnsWithoutMagicConsts() { $this->metadata->source = ''; $expected = $this->metadata->source; $this->transformer->transform($this->metadata); $this->assertSame($expected, $this->metadata->source); } public function testTransformerCanResolveDirMagicConst() { $this->metadata->source = ''; $expected = ''; $this->transformer->transform($this->metadata); $this->assertEquals($expected, $this->metadata->source); } public function testTransformerCanResolveFileMagicConst() { $this->metadata->source = ''; $expected = ''; $this->transformer->transform($this->metadata); $this->assertEquals($expected, $this->metadata->source); } public function testTransformerDoesNotReplaceStringWithConst() { $expected = ''; $this->metadata->source = $expected; $this->transformer->transform($this->metadata); $this->assertEquals($expected, $this->metadata->source); } public function testTransformerWrapsReflectionFileName() { $this->metadata->source = 'getFileName(); ?>'; $this->transformer->transform($this->metadata); $this->assertStringEndsWith('::resolveFileName($class->getFileName()); ?>', $this->metadata->source); } public function testTransformerResolvesFileName() { /** @var $class MagicConstantTransformer */ $class = get_class($this->transformer); $this->assertStringStartsWith(dirname(__DIR__), $class::resolveFileName(__FILE__)); } } tests/Go/Instrument/Transformer/_files/Foo.php000064400000000047144760123700015427 0ustar00 properties private function privateMethod() { return $this->private; } protected function protectedMethod() { return $this->protected; } public function publicMethod() { return $this->public; } // Static methods that access self:: properties private static function staticSelfPrivate() { return self::$staticPrivate; } protected static function staticSelfProtected() { return self::$staticProtected; } public static function staticSelfPublic() { return self::$staticPublic; } public static function staticSelfPublicAccessPrivate() { return self::$staticPrivate; } // Static methods that access static:: properties with LSB protected static function staticLsbProtected() { return get_called_class(); } public static function staticLsbPublic() { return get_called_class(); } // Pass by reference public function passByReference(&$valueByReference) { $valueByReference = null; return $valueByReference; } // Pass by reference public static function staticPassByReference(&$valueByReference) { $valueByReference = null; return $valueByReference; } // Recursion test public function recursion($value, $level = 0) { if ($level > 0) { $value += $this->recursion($value, $level-1); } return $value; } // Recursion test public static function staticLsbRecursion($value, $level = 0) { if ($level > 0) { $value += static::staticLsbRecursion($value, $level-1); } return $value; } /** * Method for checking invocation with any number of arguments * * NB: Real proxy use the method definition to prepare invocation proxy, so variable number of arguments * will not work at all! * * @return string */ public function variableArgsTest() { return join('', func_get_args()); } /** * Method for checking invocation with any number of arguments * * NB: Real proxy use the method definition to prepare invocation proxy, so variable number of arguments * will not work at all! * * @return string */ public static function staticVariableArgsTest() { return join('', func_get_args()); } } tests/bootstrap.php000064400000002647144760123700010451 0ustar00 * @license http://www.opensource.org/licenses/mit-license.php The MIT License */ ini_set('display_errors', 1); if (defined("AUTOLOAD_PATH")) { if (is_file(realpath(AUTOLOAD_PATH))) { include_once AUTOLOAD_PATH; } else { throw new InvalidArgumentException("Cannot load custom autoload file located at ".AUTOLOAD_PATH); } } else { // default autoload for library classes spl_autoload_register(function($class) { if (0 === strpos($class, 'Go\\')) { $path = __DIR__ . '/../src/' . implode('/', (explode('\\', $class))).'.php'; if (!file_exists($path)) { return false; } require $path; if (!class_exists($class) && !interface_exists($class)) { return false; } return true; } else if (0 === strpos($class, 'TokenReflection\\')) { $path = __DIR__ . '/../vendor/andrewsville/php-token-reflection/' . implode('/', (explode('\\', $class))).'.php'; if (!file_exists($path)) { return false; } require $path; if (!class_exists($class) && !interface_exists($class)) { return false; } return true; } return false; }); }