appserver-io / doppelgaenger

src/Entities/PointcutExpression.php

<?php

/**
 * \AppserverIo\Doppelgaenger\Entities\PointcutExpression
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/doppelgaenger
 * @link      http://www.appserver.io/
 */

namespace AppserverIo\Doppelgaenger\Entities;

use AppserverIo\Doppelgaenger\Dictionaries\ReservedKeywords;
use AppserverIo\Doppelgaenger\Entities\Pointcuts\PointcutFactory;
use AppserverIo\Doppelgaenger\Interfaces\CodifyableInterface;
use AppserverIo\Psr\MetaobjectProtocol\Aop\Annotations\Advices\Around;

/**
 * Definition of a pointcut as a combination of a joinpoint and advices
 *
 * @author    Bernhard Wick <bw@appserver.io>
 * @copyright 2015 TechDivision GmbH - <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/doppelgaenger
 * @link      http://www.appserver.io/
 *
 * @see        https://www.eclipse.org/aspectj/doc/next/progguide/quick.html
 * @see        https://www.eclipse.org/aspectj/doc/next/progguide/semantics-pointcuts.html
 */
class PointcutExpression implements CodifyableInterface
{

    /**
     * Joinpoint at which the enclosed advices have to be weaved
     *
     * @var \AppserverIo\Doppelgaenger\Entities\Joinpoint|null $joinpoint
     */
    protected $joinpoint;

    /**
     * Pointcut(tree) representing the logical structure of the given string expression
     *
     * @var \AppserverIo\Doppelgaenger\Interfaces\PointcutInterface $pointcut
     */
    protected $pointcut;

    /**
     * Original string definition of the pointcut
     *
     * @var string $string
     */
    protected $string;

    /**
     * Default constructor
     *
     * @param string $rawString Raw string the pointcuts expressions can be filtered from
     */
    public function __construct($rawString)
    {
        $this->joinpoint = null;
        $this->string = $rawString;

        $pointcutFactory = new PointcutFactory();
        $this->pointcut = $pointcutFactory->getInstance($rawString);
    }

    /**
     * Getter for the $joinpoints property
     *
     * @return \AppserverIo\Doppelgaenger\Entities\Joinpoint|null
     */
    public function getJoinpoint()
    {
        return $this->joinpoint;
    }

    /**
     * Getter for the $pointcut property
     *
     * @return \AppserverIo\Doppelgaenger\Interfaces\PointcutInterface
     */
    public function getPointcut()
    {
        return $this->pointcut;
    }

    /**
     * Getter for the $string property
     *
     * @return string
     */
    public function getString()
    {
        return $this->string;
    }

    /**
     * Setter for the $joinpoints property
     *
     * @param \AppserverIo\Doppelgaenger\Entities\Joinpoint $joinpoint Joinpoint instance to set
     *
     * @return null
     */
    public function setJoinpoint(Joinpoint $joinpoint)
    {
        $this->joinpoint = $joinpoint;
    }

    /**
     * Setter for the $pointcut property
     *
     * @param \AppserverIo\Doppelgaenger\Interfaces\PointcutInterface $pointcut Pointcut of this expression
     *
     * @return null
     */
    public function setPointcut($pointcut)
    {
        $this->pointcut = $pointcut;
    }

    /**
     * Setter for the $string property
     *
     * @param string $string Expression string
     *
     * @return null
     */
    public function setString($string)
    {
        $this->string = $string;
    }

    /**
     * Return a string representation of the logic behind pointcut expression
     *
     * @return string
     */
    public function toCode()
    {
        // around advices need to have their result saved
        $assignTo = null;
        if (!is_null($this->getJoinpoint()) && $this->getJoinpoint()->getCodeHook() === Around::ANNOTATION) {
            $assignTo = ReservedKeywords::RESULT;
        }

        // do we even have an useful condition?
        $condition = $this->getPointcut()->getConditionString();
        if ($condition === 'true' || empty($condition)) {
            return $this->getPointcut()->getExecutionString($assignTo);

Blank line found at end of control structure

        } else {
            return 'if (' . $condition .') {
            ' . $this->getPointcut()->getExecutionString($assignTo) . '
            }';
        }
    }
}