Go\Aop\Support\PointcutBuilder

Complexity

Total Complexity

8

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	before()	0	5	1
A	after()	0	5	1
A	afterThrowing()	0	5	1
A	around()	0	5	1
A	declareError()	0	5	1
A	registerAdviceInContainer()	0	7	1
A	getPointcutId()	0	6	1

<?php
/*
 * Go! AOP framework
 *
 * @copyright Copyright 2014, Lisachenko Alexander <lisachenko.it@gmail.com>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Go\Aop\Support;

use Closure;
use Go\Aop\Advice;
use Go\Aop\Framework\AfterInterceptor;
use Go\Aop\Framework\AfterThrowingInterceptor;
use Go\Aop\Framework\AroundInterceptor;
use Go\Aop\Framework\BeforeInterceptor;
use Go\Aop\Framework\DeclareErrorInterceptor;
use Go\Core\AspectContainer;

/**
 * Pointcut builder provides simple DSL for declaring pointcuts in plain PHP code
 */
class PointcutBuilder
{
    /**
     * @var AspectContainer
     */
    protected $container;

    /**
     * Default constructor for the builder
     *
     * @param AspectContainer $container Instance of container
     */
    public function __construct(AspectContainer $container)
    {
        $this->container = $container;
    }

    /**
     * Declares the "Before" hook for specific pointcut expression
     *
     * @param string $pointcutExpression Pointcut, e.g. "within(**)"
     * @param Closure $advice Advice to call
     */
    public function before($pointcutExpression, Closure $advice)
    {
        $advice = new BeforeInterceptor($advice, 0, $pointcutExpression);
        $this->registerAdviceInContainer($pointcutExpression, $advice);
    }

    /**
     * Declares the "After" hook for specific pointcut expression
     *
     * @param string $pointcutExpression Pointcut, e.g. "within(**)"
     * @param Closure $advice Advice to call
     */
    public function after($pointcutExpression, Closure $advice)
    {
        $advice = new AfterInterceptor($advice, 0, $pointcutExpression);
        $this->registerAdviceInContainer($pointcutExpression, $advice);
    }

    /**
     * Declares the "AfterThrowing" hook for specific pointcut expression
     *
     * @param string $pointcutExpression Pointcut, e.g. "within(**)"
     * @param Closure $advice Advice to call
     */
    public function afterThrowing($pointcutExpression, Closure $advice)
    {
        $advice = new AfterThrowingInterceptor($advice, 0, $pointcutExpression);
        $this->registerAdviceInContainer($pointcutExpression, $advice);
    }

    /**
     * Declares the "Around" hook for specific pointcut expression
     *
     * @param string $pointcutExpression Pointcut, e.g. "within(**)"
     * @param Closure $advice Advice to call
     */
    public function around($pointcutExpression, Closure $advice)
    {
        $advice = new AroundInterceptor($advice, 0, $pointcutExpression);
        $this->registerAdviceInContainer($pointcutExpression, $advice);
    }

    /**
     * Declares the error message for specific pointcut expression
     *
     * @param string $pointcutExpression Pointcut, e.g. "within(**)"
     * @param string $message Error message to show
     * @param integer $level Error level to trigger
     */
    public function declareError($pointcutExpression, $message, $level = E_USER_ERROR)
    {
        $advice = new DeclareErrorInterceptor($message, $level, $pointcutExpression);
        $this->registerAdviceInContainer($pointcutExpression, $advice);
    }


    /**
     * General method to register advices
     *
     * @param string $pointcutExpression Pointcut expression string
     * @param Advice $advice Instance of advice
     */
    private function registerAdviceInContainer($pointcutExpression, Advice $advice)
    {
        $this->container->registerAdvisor(
            new LazyPointcutAdvisor($this->container, $pointcutExpression, $advice),
            $this->getPointcutId($pointcutExpression)
        );
    }

    /**
     * Returns a unique name for pointcut expression
     *
     * @param string $pointcutExpression
     *
     * @return string
     */
    private function getPointcutId($pointcutExpression)
    {
        static $index = 0;

        return preg_replace('/\W+/', '_', $pointcutExpression) . '.' . $index++;
    }
}